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.

Sign up for GitHub

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

Jump to bottom

docs: adapting release process to new definition setup #659

Merged
merged 9 commits into from
Jun 17, 2022
Merged

docs: adapting release process to new definition setup #659

Changes from 3 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
15a2283
Adapting release process
jonaslagoni Nov 25, 2021
a44ed7a
Adapting release process
jonaslagoni Dec 9, 2021
48cdbbf
Merge branch 'master' into feature/change_spec_json_release_process
jonaslagoni Mar 14, 2022
ba51a42
Merge branch 'master' into feature/change_spec_json_release_process
jonaslagoni May 17, 2022
682e3f8
Update RELEASE_PROCESS.md
jonaslagoni May 17, 2022
795c1f5
Update RELEASE_PROCESS.md
jonaslagoni May 17, 2022
4973d4f
Update RELEASE_PROCESS.md
jonaslagoni May 18, 2022
f8622cd
Merge branch 'master' into feature/change_spec_json_release_process
jonaslagoni Jun 8, 2022
c0a5517
Merge branch 'master' into feature/change_spec_json_release_process
fmvilas Jun 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion RELEASE_PROCESS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,15 @@ Once feature branches are created, there must be some initial configuration done

Things to do in release branch as `chore: ` changes:
- `spec` - Make sure all the official examples located in the repository use the new version of the specification,
- `spec-json-schemas` - Create new JSON Schema file with new version name and expose it here [here](https://github.com/asyncapi/spec-json-schemas/blob/master/index.js),
- `spec-json-schemas` - To create a new version, please read further in the repository [Creating a new version](https://github.com/asyncapi/spec-json-schemas#creating-a-new-version),
- `parser-js` - Make sure the list of supported AsyncAPI schema MIME types is extended with the new version [here](https://github.com/asyncapi/parser-js/blob/master/lib/asyncapiSchemaFormatParser.js#L43.)

Things to do in default branch and release branch as `chore: ` changes:
- Set release branch name in prerelease configuration in some repos repositories:
- [package.json in parser-js](https://github.com/asyncapi/parser-js/blob/master/package.json#L90)
- [package.json in spec-json-schemas](https://github.com/asyncapi/spec-json-schemas/blob/master/package.json#L49)
- [.releaserc in spec](https://github.com/asyncapi/spec/blob/master/.releaserc#L4)

#### Release notes

Changes in the specification need to be well described. We need clear information on what has changed, why, and who contributed to the change. A regular changelog is not enough as it is not user-friendly. Every release must have release notes.
Expand Down