spec
spec copied to clipboard
Work on 2.5.0 release
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
- [x] https://github.com/asyncapi/spec/issues/775
- [x] https://github.com/asyncapi/spec/pull/776
- [x] https://github.com/asyncapi/spec/issues/612 (editorial change)
- [x] https://github.com/asyncapi/spec/pull/779
- [x] https://github.com/asyncapi/spec/issues/674 (editorial change)
- [x] https://github.com/asyncapi/spec/pull/782
- [x] https://github.com/asyncapi/spec/pull/818 (editorial change)
- [x] https://github.com/asyncapi/spec/pull/832 (editorial change)
Pending
- [ ] Google Pub/Sub bindings
- [ ] https://github.com/asyncapi/bindings/pull/141
- [ ] https://github.com/asyncapi/spec/pull/836
- [ ] https://github.com/asyncapi/spec-json-schemas/pull/253
- [ ] https://github.com/asyncapi/bindings/pull/143
- [ ] https://github.com/asyncapi/spec/pull/826
- [ ] https://github.com/asyncapi/spec/issues/654
- [ ] https://github.com/asyncapi/spec/pull/809
- [ ] https://github.com/asyncapi/spec-json-schemas/pull/232
- [ ] https://github.com/asyncapi/parser-js/pull/565
- [ ] https://github.com/asyncapi/spec/pull/595
- [ ] https://github.com/asyncapi/bindings/pull/115
Discarded
- [x] https://github.com/asyncapi/spec/pull/790
Progress:
- [x] Update release branches from forks
- [x] spec - https://github.com/asyncapi/spec/pull/831
- [x] spec-json-schemas - https://github.com/asyncapi/spec-json-schemas/pull/249
- [x] parser-js - https://github.com/asyncapi/parser-js/pull/606
- [x] Update release branches with new versions
- [x] spec - https://github.com/asyncapi/spec/pull/808
- [x] spec-json-schemas - https://github.com/asyncapi/spec-json-schemas/pull/230, https://github.com/asyncapi/spec-json-schemas/pull/250
- [x] parser-js - https://github.com/asyncapi/parser-js/pull/617
- [ ] Create draft release notes
- [x] Notify community about release branches
- [ ] Notify code owners of critical repositories about the pre-releases
- [x] Check for potential release contributions
- [x] Draft announcement blog post for new features and changes - https://github.com/asyncapi/website/pull/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
- [ ] spec-json-schemas
- [ ] parser-js
- [ ] 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
Cleanup tasks after the release
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 https://github.com/asyncapi/spec/issues/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 https://github.com/asyncapi/spec/issues/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 https://github.com/asyncapi/spec-json-schemas/pull/249#pullrequestreview-1106369882
This is a candidate for a cleanup task.
Pre-releases of spec are currently not auto-generated due to https://github.com/asyncapi/spec/pull/834.
Pre-releases of schemas are currently not auto-generated due to https://github.com/asyncapi/spec-json-schemas/pull/255 and https://github.com/asyncapi/spec-json-schemas/pull/259
Pre-release global workflow modification in https://github.com/asyncapi/.github/pull/180
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

Can we add that PR to the list? https://github.com/asyncapi/spec/pull/840 Thanks!
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 😆
You do realize that I can enable force-push back and then do it again, right? :trollface: Now seriously, sorry for all the noise 😅
AsyncAPI 2.5.0 release - https://github.com/asyncapi/spec/releases/tag/v2.5.0
JSON Schemas release - https://github.com/asyncapi/spec-json-schemas/releases/tag/v3.2.0
Parser-js - https://github.com/asyncapi/parser-js/releases/tag/v1.17.0
AsyncAPI 2.5.0 has been successfully released.
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.
Resuming processing improvements now and incorporating them into https://github.com/asyncapi/spec/blob/master/RELEASE_PROCESS.md
Social media examples https://github.com/asyncapi/spec/pull/876/files
Any reason this is still open 🤔 ?
@char0n can you have a look?