The following artifacts are created as a result of releasing the Hyperledger Fabric Gateway client API:
- npm package
- Java artifact
The following tasks are required before releasing:
- Update version numbers if required (see below for details)
- Update test, sample, and docs files to match the new version if it was updated
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. vX.Y.Z
See previous releases for examples of the title and description.
The following tasks are required after releasing:
- Update version numbers to the next point release (see below for details)
- Update test, sample, and docs files to match the new version
The Hyperledger Fabric Gateway client APIs follow the Go module version numbering system
The following files need to be modified when updating the version number, and these are checked by the build process to ensure they match a tagged release:
- The
GATEWAY_VERSIONvariable in .github/workflows/verify-versions.yml - The
versionelement in java/pom.xml - The
versionproperty in node/package.json
Note: there is no file to update for the Go SDK, which is versioned by the release tag.
The scripts/update-versions.sh script can be used to update the version number in the files listed above. With no arguments, the script will update to the next patch version. An argument supplied to the script specifies the new version number, which should not include a leading v.
When updating the major version beyond version 1, Go modules require a new module path, e.g. version 2 would require a new v2 directory containing the new Go module code. This is a very disruptive change therefore any incompatible changes which would require a major version change should be avoided if at all possible.
See Publishing breaking API changes for more details.