feat: Automate version in AsyncAPI docs

[Arya-Gupta]

Reason/Context

Presently, AsyncAPI version needs to be updated manually across all documentation. This requires extra work and might lead to human errors. I suggest automating the version displayed across all documentation.

Description

Here is an example of such a version update.

[Arya-Gupta]

Tagging @akshatnema, @derberg, and @alequetzalli for inputs.

[akshatnema]

Regarding this, we can have a Spec Version variable (inside env) in the Netlify builds or a JSON file in the repository that handles these standard variables on all the pages on the website.

[derberg]

I like the idea. We should definitely not hide this info in any environment variables as this must be easy to update by anyone through PR. Maybe we could use fragments for it? 🤔

[derberg]

ok, fragments will not work, this update of version is needed not only in docs like https://github.com/asyncapi/website/blob/master/pages/docs/concepts/protocol.md but also JS files.

non, fragments nor env variables will really work 😞
I think the only option to do it manually

best would be to update release process instruction https://github.com/asyncapi/spec/blob/master/RELEASE_PROCESS.md#step-4---prepare-announcement-blog-post and require release coordinator to update version of asyncapi in website when release notes are created, in the same PR.

just short note, in what folders release coordinator should search for words 2.5.0 (previous release) and then update to latest.

thoughts?

[akshatnema]

@derberg We can use the variables to assign the AsyncAPI version like this - https://www.coderrocketfuel.com/article/add-environment-variables-to-a-next-js-application. Then, if we are going to update the version of the AsyncAPI inside docs, you just need to change the value of this variable inside next.config.js file.

[derberg]

but how does it work in markdown files? JS is not a problem

[akshatnema]

We can do this by initializing a component, which renders the environment variables on demand. So like, if we have to render the AsyncAPI version and the component name is Environment, so we can write as <Environment var="AsyncAPI_version" /> which will return process.env.[var] as the output.

[derberg]

will this work in code snippets? this is where version is usually used. I don't think so

[akshatnema]

What do you mean by it will work in code snippets? I didn't get it. Do you want me to make a sample demo for this?

[derberg]

Example: https://www.asyncapi.com/docs/tutorials/getting-started/hello-world

You have bunch of code snippets with YAML file, and AsyncAPI version mentioned in each. How will this <Environment var="AsyncAPI_version" /> work? or to be more precise, will it work?

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

[AnimeshKumar923]

Still relevant? @derberg @akshatnema

[derberg]

Still relevant

[AayushSaini101]

@derberg @sambhavgupta0705 I am on it

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

[derberg]

no easy solution, still better to do ctrl+f on each release 🤷🏼