Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Work on 2.5.0 release #830

Closed
52 of 61 tasks
char0n opened this issue Sep 5, 2022 · 16 comments
Closed
52 of 61 tasks

Work on 2.5.0 release #830

char0n opened this issue Sep 5, 2022 · 16 comments
Assignees
Labels
:shipit: Release An issue/PR containing details about a release of the specification

Comments

@char0n
Copy link
Collaborator

char0n commented Sep 5, 2022

Release 2.5.0 is scheduled for September 2022

Detailed info:

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:

Release notes:

Potential work to be included in this version

Accepted

Pending

Discarded

Progress:

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

image

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
Copy link
Collaborator Author

char0n commented Sep 20, 2022

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

@char0n
Copy link
Collaborator Author

char0n commented Sep 20, 2022

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

@char0n
Copy link
Collaborator Author

char0n commented Sep 20, 2022

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

@derberg
Copy link
Member

derberg commented Sep 22, 2022

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

Screenshot 2022-09-22 at 11 01 59

@magicmatatjahu
Copy link
Member

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

@derberg
Copy link
Member

derberg commented Sep 22, 2022

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
Copy link
Member

fmvilas commented Sep 22, 2022

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

@char0n
Copy link
Collaborator Author

char0n commented Sep 29, 2022

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

@char0n
Copy link
Collaborator Author

char0n commented Sep 29, 2022

@char0n
Copy link
Collaborator Author

char0n commented Sep 29, 2022

@char0n
Copy link
Collaborator Author

char0n commented Sep 29, 2022

AsyncAPI 2.5.0 has been successfully released.

@derberg
Copy link
Member

derberg commented Oct 3, 2022

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
Copy link
Collaborator Author

char0n commented Nov 1, 2022

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

@char0n
Copy link
Collaborator Author

char0n commented Dec 19, 2022

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

@jonaslagoni
Copy link
Member

Any reason this is still open 🤔 ?

Copy link
Member

derberg commented Apr 3, 2023

@char0n can you have a look?

@fmvilas fmvilas closed this as completed May 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:shipit: Release An issue/PR containing details about a release of the specification
Projects
None yet
Development

No branches or pull requests

5 participants