959659c3fa
Add details for release checklist for where to put the update the changelist and which branch to cherry-pick from. Also add more details around creating the tag and verifying the tag is correct. Signed-off-by: Derek McGowan <derek@mcgstyle.net> (github: dmcgowan)
1.9 KiB
Registry Release Checklist
- 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).
-
Update the version file:
https://github.com/docker/distribution/blob/master/version/version.go -
Update the
MAINTAINERS(if necessary),AUTHORSand.mailmapfiles.
make AUTHORS
- 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, 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.
-
Push the signed tag
-
Create a new release. In the case of a release candidate, tick the
pre-releasecheckbox. -
Update the registry binary in distribution library image repo by running the update script and opening a pull request.
-
Update the official image. Add the new version in the official images repo by appending a new version to the
registry/registryfile with the git hash pointed to by the signed tag. Update the major version to point to the latest version and the minor version to point to new patch release if necessary. e.g. to release2.3.1
2.3.1 (new)
2.3.0 -> 2.3.0 can be removed
2 -> 2.3.1
2.3 -> 2.3.1
- Build a new distribution/registry image on Docker hub by adding a new automated build with the new tag and re-building the images.