From 128b22145c779c55531c52d47e986eb47e5f881a Mon Sep 17 00:00:00 2001 From: derberg Date: Thu, 16 Sep 2021 12:20:38 +0200 Subject: [PATCH 1/2] chore: update release process with missing steps --- .releaserc | 2 +- RELEASE_PROCESS.md | 18 ++++++++++++------ 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/.releaserc b/.releaserc index 236df2f13..36b45bfc2 100644 --- a/.releaserc +++ b/.releaserc @@ -1,7 +1,7 @@ --- branches: - master -- name: 2021-06-release +- name: 2021-09-release prerelease: true plugins: - - "@semantic-release/commit-analyzer" diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md index 54173757a..c50b93153 100644 --- a/RELEASE_PROCESS.md +++ b/RELEASE_PROCESS.md @@ -37,6 +37,18 @@ Release branch must have a year and a month of the release as prefix: {YEAR_OF_R This image shows part of the GitHub UI that shows how you can create a new branch using default branch as a base. +Once feature branches are created, there must be some initial configuration done in each repository. + +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), +- `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 branche 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. @@ -62,12 +74,6 @@ There are no step-by-step instructions to follow but a set of rules. - created in all repositories specified in contribution guide, - At least one user listed in [CODEOWNERS](CODEOWNERS) must approve the pull request in all related repositories. -#### Prerequisites for first feature merge - -- `spec` - Make sure all the official examples located in the repository use the new version of the specification, -- `spec-json-schemas` - Make sure changes are introduced in the new JSON Schema file, and they are exposed [here](https://github.com/asyncapi/spec-json-schemas/blob/master/index.js), -- `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.) - #### Merge - Merge can be done only by repository [CODEOWNERS](CODEOWNERS), From 830575a5bcd35f9e5fdb989a92ee0accf3fe0c12 Mon Sep 17 00:00:00 2001 From: Lukasz Gornicki Date: Thu, 16 Sep 2021 12:36:03 +0200 Subject: [PATCH 2/2] Update RELEASE_PROCESS.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fran Méndez --- RELEASE_PROCESS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md index c50b93153..12625861b 100644 --- a/RELEASE_PROCESS.md +++ b/RELEASE_PROCESS.md @@ -44,7 +44,7 @@ Things to do in release branch as `chore: ` changes: - `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), - `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 branche and release branch as `chore: ` changes: +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)