-
-
Notifications
You must be signed in to change notification settings - Fork 357
docs: add release process instruction #577
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
84c0430
docs: add release process instruction
derberg 7cd44ef
better wording
derberg bce2859
more details on release branch
derberg abfdc83
section about release notes and some grammar fixes
derberg 01e5409
Merge branch 'master' into releaseprocess
derberg 21e2797
finalize release process
derberg 6b4e8a8
codeowners
derberg a509e23
Apply suggestions from code review
derberg cccaefa
feat! instead of !feat
derberg 344e831
Merge branch 'master' into releaseprocess
derberg File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # Release Process For AsyncAPI Specification | ||
|
|
||
| This document is ment to explain the release process of the AsyncAPI specification. Goal of this document is to describe all details of the process so that any member of the community can jump in and help coordinating. | ||
|
|
||
| ## Release coordinator | ||
|
|
||
| AsyncAPI specification release involves not only spec release but also the release of AsyncAPI-maintained tools, therefore it requires a single person called `release coordinator` that makes sure the release goes well through out all phases. | ||
|
|
||
| Release coordinator doesn't have to do all the work on her/his own. Release coordinator needs to find the right people to do the work that is needed for a given phase and needs to engage as many people as needed. | ||
|
|
||
| ## Release cadence | ||
|
|
||
| AsyncAPI releases happen on a regular basis in the following months: | ||
| - January | ||
| - April | ||
| - June | ||
| - September | ||
|
|
||
| Regular releases concern only major and minor releases. We do not know if next release is major or minor. This is a decision that depends on the proposals for changes in the specification and how much they affect specification and tooling. | ||
|
|
||
| Path releases are automatically released and published. | ||
derberg marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
derberg marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Release phases | ||
|
|
||
| ### Kick off | ||
|
|
||
| TODO: explain how to create release branches, how to name them and where they should be, in what repositories. Also explain that release notes draft PR must be started. | ||
|
|
||
| ### Review and merge | ||
|
|
||
| TODO: proposal phases, who reviews/accepts/merges, what are prerequisites for the merge, what happens after the merge. Remember about updating release notes on issue by issue case to not have it at the end of the release cycle. What about tooling updates? release candidates? After first merge we should already have draft PR to master opened in all required repos | ||
|
|
||
| ### Ship it! | ||
|
|
||
| TODO: what needs to be done in json schema repo, what in parser repo. How to trigger release, when merge release notes, who to inform, social networks, communication, beer or wine! | ||
|
|
||
|
|
||
|
|
||
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.