Release playbook

Rough notes for releasing programming model related Hyperledger Fabric projects

Need to think about/open Jira issues for:

• document release process in each repo
  • chaincode go/java/node
  • client sdk go(?)/java/node
  • others?
• decide when to release, e.g. should the trigger be
  • a regular release schedule (assuming there is something to release)
  • only to stay in sync with core Fabric
  • based on the number/severity of commits since the last release
• vulnerability scans for each repo, i.e.
  • required before each release
  • could trigger a release
• do we prefer to checkpoint at the end of each sprint to see if we do or don’t want to push out a release? (Mark)
• Making improvements to release process
  • automating post-release version bumps
  • removing other manual steps?

Create a RELEASING.md file in each repo? i.e. similar to CONTRIBUTORS.md and CONTRIBUTING.md convention. Update CONTRIBUTING.md to explain branching model and link to the releasing guide.

Existing documentation

• Fabric-Chaincode-Java Release Playbook
• Fabric-Chaincode-Node Release Process
• Java SDK Release Process Document

Previous releases

Jiras for previous releases for some background

• Chaincode/Contract go?
• Chaincode node
  • Release v2.0.0 chaincode-node
  • Release v2.1.0
  • Version 2.1 Chaincode Node Patch Release
• Chaincode java
  • Release v2.0.0 chaincode-java
  • Release 2.1 Chaincode Java Patch
• Client SDK go?
• Client SDK node?
• Client SDK java?

Example release documentation

• Leaflet

Links

Other resources which might be useful:

• keep a changelog
  • Don’t let your friends dump git logs into changelogs