From 041835369fd7be22750ae401fc7445aa8ae97eca Mon Sep 17 00:00:00 2001 From: Andrew Hurt Date: Thu, 30 Jan 2020 10:41:02 +0000 Subject: [PATCH] Release checklist Signed-off-by: Andrew Hurt --- .github/RELEASE_CHECKLIST.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 .github/RELEASE_CHECKLIST.md diff --git a/.github/RELEASE_CHECKLIST.md b/.github/RELEASE_CHECKLIST.md new file mode 100644 index 0000000..aeb47b8 --- /dev/null +++ b/.github/RELEASE_CHECKLIST.md @@ -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 ``. +- Run `.release/changelog.sh ` 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 ``" + +Releasing: +- Go to: https://github.com/hyperledger/fabric-contract-api-go/releases +- Select "Draft a new release" +- Enter the tag as ``. +- Give the release a title of "Release ``" +- 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. \ No newline at end of file