RELEASING.md

Releasing

The following artifacts are created as a result of releasing Fabric Chaincode Node:

• docker images
  • fabric-nodeenv
• npm modules
  • fabric-contract-api
  • fabric-shim
  • fabric-shim-api

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.

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

The tools/scripts/updateversions.sh script will update the version in all the package.json files. Pass the new version as the first argument.

./tools/scripts/updateversions.sh 2.4.1

See the Prepare 2.1.4 release 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 will trigger the build to publish the new release.

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