diff --git a/RELEASE-CHECKLIST.md b/RELEASE-CHECKLIST.md index 49235cec..73eba5a8 100644 --- a/RELEASE-CHECKLIST.md +++ b/RELEASE-CHECKLIST.md @@ -1,19 +1,27 @@ ## Registry Release Checklist -10. Compile release notes detailing features and since the last release. Update the `CHANGELOG.md` file. +10. Compile release notes detailing features and since the last release. + + Update the `CHANGELOG.md` file and create a PR to master with the updates. +Once that PR has been approved by maintainers the change may be cherry-picked +to the release branch (new release branches may be forked from this commit). 20. Update the version file: `https://github.com/docker/distribution/blob/master/version/version.go` 30. Update the `MAINTAINERS` (if necessary), `AUTHORS` and `.mailmap` files. - ``` +``` make AUTHORS ``` 40. Create a signed tag. - Distribution uses semantic versioning. Tags are of the format `vx.y.z[-rcn]` -You will need PGP installed and a PGP key which has been added to your Github account. The comment for the tag should include the release notes. + Distribution uses semantic versioning. Tags are of the format +`vx.y.z[-rcn]`. You will need PGP installed and a PGP key which has been added +to your Github account. The comment for the tag should include the release +notes, use previous tags as a guide for formatting consistently. Run +`git tag -s vx.y.z[-rcn]` to create tag and `git -v vx.y.z[-rcn]` to verify tag, +check comment and correct commit hash. 50. Push the signed tag