Improve readability of spec changes

[jonaslagoni]

The problem

In the last two releases, we have simply linked to a blog post stating the changes, however, with release notes available, I think we should utilize them. I should not have to access a blog to view them, as what if the website is down, blog post got mixed up by some internal problem, and in general, I just think it is a bad user experience.

What needs to change

We will need to change the release process document to describe how you can merge the release branch to master with detailed information about the changes and links to PR's.

For the 2.2.0 release, I would have expected the release notes to be:

2.2.0 (2021-09-28)

Features

• release 2.2.0 spec version

Release notes

These are the changes that happened in 2.2.0.

Useful links:
Website changelog: https://www.asyncapi.com/release-notes-2.2.0
Blog post: https://www.asyncapi.com/blog/release-notes-2.2.0

Features

• Assign channels to servers (#531) (8f5ac24)
• Updated all examples to version 2.2.0 (#629) (5ea666b)
• Add Anypoint MQ protocol to list of supported bindings (#545) (88e2b08)

Fixes

• Unified Message and MessageTrait examples description (#608) (6887699)

[derberg]

@jonaslagoni why did you add it needs champion? it is not related to RFC process right? you just want to improve the details we put in the Release Notes when releasing the spec, right?

[jonaslagoni]

Yes, in my mind that change needs a champion too 😆 We need to adapt the release process document, right?

But yea, might not be worthy of the needs champion label 😄

[derberg]

well, it needs someone to open up a PR with slight modifications in the instruction. You can also ask @dalelane if he could take it on as I see he liked the idea, and as current release coordinator, I'm sure he will have some improvements to the process for future release coordinators 😄

I'm removing the label as it is strictly related to RFC process 😉

[dalelane]

sounds like a good idea - I can't assign myself to the issue, but happy to pick it up - I'll include it in the updates I make to the release process doc

[derberg]

awesome, we do not assign issues really but I can do it if you want
done

[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]

afaik it is done already, latest release looks pretty neat and Sergio also update release process doc