Skip to content

Commit

Permalink
Release checklist (#19)
Browse files Browse the repository at this point in the history
Signed-off-by: Andrew Hurt <andrew.hurt1@ibm.com>
  • Loading branch information
awjh-ibm authored Feb 4, 2020
1 parent 6ab41d6 commit aefcd46
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions .github/RELEASE_CHECKLIST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Release Checklist

Before releasing ensure that you have:
- Decided on a release tag. The repo uses a 3 number semantic versioning system and therefore the tag should be of the form v.X.X.X e.g. v2.0.0. This value will be known in the rest of this document as `<RELEASE_TAG>`.
- Run `.release/changelog.sh <PREVIOUS_RELEASE_TAG> <RELEASE_TAG>` to update CHANGELOG.md to contain all commits since the previous tag. Running without the previous release tag will get all commits.
- Commit the updated changelog via PR with commit message "Preparing for release `<RELEASE_TAG>`"

Releasing:
- Go to: https://github.com/hyperledger/fabric-contract-api-go/releases
- Select "Draft a new release"
- Enter the tag as `<RELEASE_TAG>`.
- Give the release a title of "Release `<RELEASE_TAG>`"
- Add to the large textarea the release notes. These should consist of:
- Include section called "Release Notes" containing the high-level view of changes made in the version that are of note.
- (Optional) Include a section called "Migration Notes" detailing "gotchas" for the user of migrating to the new version.
- (Optional) Include a section called "Bug Fixes" detailing important bug fixes in the version. Should be listed as bullet points with a link to the JIRA for that bug.

0 comments on commit aefcd46

Please sign in to comment.