Work on 2.5.0 release

[char0n]

Release 2.5.0 is scheduled for September 2022

Detailed info:

• https://github.com/asyncapi/spec/blob/master/RELEASE_PROCESS.md

Assigned release coordinator and person responsible for the 2.5.0 release: @char0n

Kick-off:

• TODO: incorporate release plan described by this issue in one of the September community meetings

Release branches:

• https://github.com/asyncapi/spec/tree/next-spec
• https://github.com/asyncapi/spec-json-schemas/tree/next-spec
• https://github.com/asyncapi/parser-js/tree/next-spec
• https://github.com/asyncapi/bindings/tree/master

Release notes:

• draft PR - https://github.com/asyncapi/website/pull/PULLREQUEST

Potential work to be included in this version

Accepted

• Extending Server.variables field type #775
  • feat: allow re-usability of Server Variable Objects #776
• Allow grouping servers #654
  • feat: add tags field to Server Object #809
  • feat: add tags field to Server Object spec-json-schemas#232
  • feat: add support for tags field on Server model parser-js#565
• Missing IBMMQ Operation Binding
  • fix: add missed IBM MQ Operation Binding #840
  • docs: add ibmmq operation binding object bindings#149
• Google Pub/Sub bindings
  • feat: add googlepubsub bindings bindings#141
  • feat: add googlepubsub bindings #836
  • feat: add googlepubsub bindings spec-json-schemas#253
• Channel Item Object $ref field resolution rules #612 (editorial change)
  • docs: clarify the resolution rules of Channel Item $ref field #779
• Clarification on URL and it's resolution rules #674 (editorial change)
  • docs: clarify how URL form is resolved #782
• docs: align wording with RFC 2119 #818 (editorial change)
• docs: change invalid RFC3339 link for valid one #832 (editorial change)
• feat: add schema registry infos to Kafka binding bindings#115

Pending

Discarded

• docs: make usage of Schema Object consistent bindings#143
• docs: channel object / $ref note.  #826
• docs: update spec/asyncapi.md #595
• docs: add bullets in keywords #790

Progress:

• Update release branches from forks
  • spec - chore: update next-spec branch with master changes #831
  • spec-json-schemas - chore: update next-spec branch with master changes spec-json-schemas#249
  • parser-js - chore: update next-spec branch with master changes parser-js#606
• Update release branches with new versions
  • spec - chore: set 2.5.0 as the latest version of the spec #808
  • spec-json-schemas - chore: create definitions for 2.5.0 version of the Spec spec-json-schemas#230, feat: allow reusability of Server Variable Object spec-json-schemas#250
  • parser-js - chore: update release branch with 2.5.0 version parser-js#617
• Create draft release notes
• Notify community about release branches
• Notify code owners of critical repositories about the pre-releases
• Check for potential release contributions
• Draft announcement blog post for new features and changes - chore(blog): add release notes for 2.5.0 release website#959
• Write release notes for new features and changes
• Notify tsc_members about upcoming release
• Prepare pull requests to merge release branches into master
  • spec - feat: release for version 2.5.0 of the spec #842
  • spec-json-schemas - feat: release for version 2.5.0 of the spec spec-json-schemas#265
  • parser-js - feat: release for version 2.5.0 of the spec parser-js#627
• Merge release branches into master
  • spec
  • spec-json-schemas
  • parser-js
• Write release notes for the releases on Github
• Create releases on Github
  • spec
  • spec-json-schemas
  • parser-js
• Update RELEASE_PROCESS doc with any changes

Draft release notes

Release notes article -> https://www.asyncapi.com/blog/release-notes-2.5.0

Features
---
- Server Variables can be now referenced from inside the Server Object (#776) ([5deef1e](https://github.com/asyncapi/spec/commit/5deef1e9148947689d53db3a1d013d49cd9df7d0)), resolves #775 by @char0n 
- Decorating Server Object with tags (#809) ([b0c2f9c](https://github.com/asyncapi/spec/commit/b0c2f9c086d940e8016ec1fa60107fe74cc070db)), resolves #654, resolves #465 by @smoya
- Added new Google Cloud Pub/Sub Bindings (#836) ([babc3be](https://github.com/asyncapi/spec/commit/babc3bedb5d85375a305c7268e96257113c1933e)) ([binding definition](https://github.com/asyncapi/bindings/tree/master/googlepubsub)) by @whitlockjc 
- Added schema registry infos to Kafka binding ([#115](https://github.com/asyncapi/bindings/pull/115)) ([binding definition](https://github.com/asyncapi/bindings/tree/master/kafka)) by @lbroudoux
- Other enhancements
  - Clarified ChannelItem.$ref resolution rules (#779) ([9a293c7](https://github.com/asyncapi/spec/commit/9a293c77f6bf74a056a8845dabfbe20e73a6f320)), resolves #612 by @char0n
  - Clarification around URL resolution rules (#782) ([fc324ef](https://github.com/asyncapi/spec/commit/fc324ef3aa92d313918a00ea9a5eb6c85720a36d)), resolves #674 by @char0n
  - Align wording with [RFC 2119](https://www.rfc-editor.org/rfc/rfc2119) (#818) ([5580a9c](https://github.com/asyncapi/spec/commit/5580a9c5fbef55e925e7514b986c95a0e4c85821)) by @char0n

Fixes
---
- Added missing IBM MQ Operation Binding (#840) ([68d85d1](https://github.com/asyncapi/spec/commit/68d85d19e5be12fa6e13d0fc5851993934dbdcde)) ([binding definition](https://github.com/asyncapi/bindings/tree/master/ibmmq#operation-binding-object)), refs [#605](https://github.com/asyncapi/spec/issues/605) by @magicmatatjahu

Full Changelog: https://github.com/asyncapi/spec/compare/v2.4.0...v2.5.0

Cleanup tasks after the release

Guildeline how to write release notes

Referencing PRs, issues and commits respectively.

Close pre-release notifications issues on critical repos

• AsyncAPI 2.5.0 pre-release notice html-template#375
• AsyncAPI 2.5.0 pre-release notice converter-js#143
• AsyncAPI 2.5.0 pre-release notice asyncapi-react#646
• AsyncAPI 2.5.0 pre-release notice studio#431

Clarification about updating parser-js with pre-releases

Important: When release candidates are created for the spec repository, the parser-js repository will need to be updated to use that release candidate.

Notify code owners of critical repositories about the pre-releases

This item needs to be added to the check list.

Notify community about release branches

The branches are not created at ad-hoc basis anymore. To this step might not be necessary anymore.

Bindings

I've added https://github.com/asyncapi/bindings/tree/next-major into a Release branches. We should probably think about using latest JSON Schemas after a new release inside the bindings JSON Schemas as suggested in https://github.com/asyncapi/bindings/pull/143/files. This is a candidate for a cleanup task.

Creating release branches

In a light of #734, creating a release branches is no longer necessary. Following TODO items can be removed from the release issue template. I've also took liberty of removing following items from this issue progress tracker:

• Create release branches
  • spec
  • spec-json-schemas
  • parser-js

This is a candidate for a cleanup task.

Updating default branches with release branch name

In a light of #734, updating default branches with release branch name is no longer necessary. Following TODO items can be removed from the release issue template. I've also took liberty of removing following items from this issue progress tracker:

• Update default branches with release branch name
  • spec
  • spec-json-schemas
  • parser-js

This is a candidate for a cleanup task.

Auto-update next-spec branches automatically

Ref asyncapi/spec-json-schemas#249 (review)

This is a candidate for a cleanup task.

Bad link in release process document

There are two things wrong with this. The PRs shouldn't be created in Draft mode and the link is invalid. Along with that, other links doesn't work as well as numbering has been probably changed in past which invalidated the link anchors.

Step 5 - create pull requests

This step was not clear. I understood it in a way to create a PR from a fork - in order to resolve the conflics.

[char0n]

Pre-releases of spec are currently not auto-generated due to #834.

[char0n]

Pre-releases of schemas are currently not auto-generated due to asyncapi/spec-json-schemas#255 and asyncapi/spec-json-schemas#259

[char0n]

Pre-release global workflow modification in asyncapi/.github#180

[derberg]

as improvement from this release I suggest the template issue as 👇🏼 as a 3rd bullet point, so these are created at the very beginning, so we get automated updates of release branches

[magicmatatjahu]

Can we add that PR to the list? #840 Thanks!

[derberg]

ok, another improvement after release that we need is to set branch protection on the release branches since these are not "stable" in the way that name doesn't change. This way, we make sure @fmvilas is not able to do a force push on these next time 😆

[fmvilas]

You do realize that I can enable force-push back and then do it again, right? Now seriously, sorry for all the noise 😅

[char0n]

AsyncAPI 2.5.0 release - https://github.com/asyncapi/spec/releases/tag/v2.5.0

[char0n]

JSON Schemas release - https://github.com/asyncapi/spec-json-schemas/releases/tag/v3.2.0

[char0n]

Parser-js - https://github.com/asyncapi/parser-js/releases/tag/v1.17.0

[char0n]

AsyncAPI 2.5.0 has been successfully released.

[derberg]

Another improvement in the process. The pull request with release notes blog in website repo should not only introduce the article itself but also changes in docs. We keep forgetting that, and as a result, we have 2.2.0 promoted in the docs.

[char0n]

Resuming processing improvements now and incorporating them into https://github.com/asyncapi/spec/blob/master/RELEASE_PROCESS.md

[char0n]

Social media examples https://github.com/asyncapi/spec/pull/876/files

[jonaslagoni]

Any reason this is still open 🤔 ?

[derberg]

@char0n can you have a look?