[FABCN-422] Add release guide #187
There are no files selected for viewing
This file contains 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
This file contains 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,45 @@ | ||
| # Releasing | ||
|
|
||
| The following artifacts are created as a result of releasing Fabric Chaincode Node: | ||
|
|
||
| - docker images | ||
| - [fabric-nodeenv](https://hub.docker.com/r/hyperledger/fabric-nodeenv) | ||
| - npm modules | ||
| - [fabric-contract-api](https://www.npmjs.com/package/fabric-contract-api) | ||
| - [fabric-shim](https://www.npmjs.com/package/fabric-shim) | ||
| - [fabric-shim-api](https://www.npmjs.com/package/fabric-shim-api) | ||
| - [fabric-shim-crypto](https://www.npmjs.com/package/fabric-shim-crypto) | ||
|
|
||
| **Note:** A docker image with a matching V.R version is required before releasing a new version of Fabric. | ||
|
|
||
| ## Before releasing | ||
|
|
||
| It's useful to create an issue to keep track of each release, for example [FABCN-377 Release v2.0.0 chaincode-node](https://jira.hyperledger.org/browse/FABCN-377). | ||
|
|
||
| The following tasks are required before releasing: | ||
|
|
||
| - Update version numbers in package.json files to the required version | ||
| - Update `tag` in package.json files to the required value, e.g. `beta`, or `latest` | ||
| - Update test, sample, and docs files to match the new version | ||
| - Create a new release notes file | ||
| - Update the `CHANGELOG.md` file | ||
|
|
||
| The `changelog.sh` script in `tools/scripts` will prepopulate the changelog but you must check and edit the file manually afterwards as required | ||
|
|
||
| See the [Prepare 2.1.4 release](https://github.com/hyperledger/fabric-chaincode-node/pull/174) pull request for an example, although be careful to search for all versions in the codebase as they're easy to miss and things change! | ||
|
|
||
| ## Create release | ||
|
|
||
| Creating a GitHub release on the [releases page](https://github.com/hyperledger/fabric-chaincode-node/releases) will trigger the build to publish the new release. | ||
|
There was a problem hiding this comment. Might want to include some comment about the name of the tag and what to put in the text. |
||
|
|
||
| When drafting the release, create a new tag for the new version (with a `v` prefix), e.g. `v2.1.4` | ||
|
|
||
| See previous releases for examples of the title and description. | ||
|
|
||
| ## After releasing | ||
|
|
||
| - Update version numbers in package.json files to the next version appended with a `-unstable` pre-release label. e.g. `1.2.3-unstable` | ||
| - Update `tag` in package.json files to `unstable` | ||
| - Update test, sample, and docs files to match the new version | ||
|
|
||
| See the [Bump version to 2.1.5](https://github.com/hyperledger/fabric-chaincode-node/pull/175) pull request for an example. It should include almost all the files changed to prepare for the release, except for the release notes and changelog which do not need updating. | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
V2 only statement...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Although it's not used for releases, I'm assuming master is the same. Is it V.R.M for when I add the release process to the 1.4 branch, or is the docker image not required? Is there even a docker image?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For 1.4 it uses the
ccenvrather than have it's own dedicated one.