dkirillov/distribution
1
0
Fork 0
forked from TrueCloudLab/distribution
Code Pull requests Activity
distribution/releases/README.md

47 lines
2.2 KiB
Markdown
Raw Permalink Normal View History

Update release documents Remove redundant AUTHORS file in favor of relying on .mailmap for keeping track of author names. Move older changelogs to release directory. Move release checklist to releases README. Signed-off-by: Derek McGowan <derek@mcgstyle.net>
2018-09-20 22:22:32 +00:00
## Registry Release Checklist
10. Compile release notes detailing features added since the last release.
Add release template file to `releases/` directory. The template is defined
by containerd's release tool. Name the file using the version, for rc add
an `-rc` suffix.
docs: update release-tool link Signed-off-by: Aviral Takkar <aviral26@users.noreply.github.com>
2021-08-23 07:01:41 +00:00
See https://github.com/containerd/release-tool
Update release documents Remove redundant AUTHORS file in favor of relying on .mailmap for keeping track of author names. Move older changelogs to release directory. Move release checklist to releases README. Signed-off-by: Derek McGowan <derek@mcgstyle.net>
2018-09-20 22:22:32 +00:00
20. Update the `.mailmap` files.
go.mod: change imports to github.com/distribution/distribution/v3 Go 1.13 and up enforce import paths to be versioned if a project contains a go.mod and has released v2 or up. The current v2.x branches (and releases) do not yet have a go.mod, and therefore are still allowed to be imported with a non-versioned import path (go modules add a `+incompatible` annotation in that case). However, now that this project has a `go.mod` file, incompatible import paths will not be accepted by go modules, and attempting to use code from this repository will fail. This patch uses `v3` for the import-paths (not `v2`), because changing import paths itself is a breaking change, which means that the next release should increment the "major" version to comply with SemVer (as go modules dictate). Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-08-24 11:18:39 +00:00
30. Update the version file: `https://github.com/distribution/distribution/blob/master/version/version.go`
Update release documents Remove redundant AUTHORS file in favor of relying on .mailmap for keeping track of author names. Move older changelogs to release directory. Move release checklist to releases README. Signed-off-by: Derek McGowan <derek@mcgstyle.net>
2018-09-20 22:22:32 +00:00
40. Create a signed tag.
Choose a tag for the next release, distribution uses semantic versioning
and expects tags to be formatted as `vx.y.z[-rc.n]`. Run the release tool using
the release template file and tag to generate the release notes for the tag
and Github release. To create the tag, you will need PGP installed and a PGP
key which has been added to your Github account. The comment for the tag will
docs: update release-tool link Signed-off-by: Aviral Takkar <aviral26@users.noreply.github.com>
2021-08-23 07:01:41 +00:00
be the generated release notes, always compare with previous tags to ensure
Update release documents Remove redundant AUTHORS file in favor of relying on .mailmap for keeping track of author names. Move older changelogs to release directory. Move release checklist to releases README. Signed-off-by: Derek McGowan <derek@mcgstyle.net>
2018-09-20 22:22:32 +00:00
the output is expected and consistent.
Run `git tag --cleanup=whitespace -s vx.y.z[-rc.n] -F release-notes` to create
tag and `git -v vx.y.z[-rc.n]` to verify tag, check comment and correct commit
hash.
50. Push the signed tag
go.mod: change imports to github.com/distribution/distribution/v3 Go 1.13 and up enforce import paths to be versioned if a project contains a go.mod and has released v2 or up. The current v2.x branches (and releases) do not yet have a go.mod, and therefore are still allowed to be imported with a non-versioned import path (go modules add a `+incompatible` annotation in that case). However, now that this project has a `go.mod` file, incompatible import paths will not be accepted by go modules, and attempting to use code from this repository will fail. This patch uses `v3` for the import-paths (not `v2`), because changing import paths itself is a breaking change, which means that the next release should increment the "major" version to comply with SemVer (as go modules dictate). Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-08-24 11:18:39 +00:00
60. Create a new [release](https://github.com/distribution/distribution/releases).
Update release documents Remove redundant AUTHORS file in favor of relying on .mailmap for keeping track of author names. Move older changelogs to release directory. Move release checklist to releases README. Signed-off-by: Derek McGowan <derek@mcgstyle.net>
2018-09-20 22:22:32 +00:00
In the case of a release candidate, tick the `pre-release` checkbox. Use
the generate release notes from the release tool
go.mod: change imports to github.com/distribution/distribution/v3 Go 1.13 and up enforce import paths to be versioned if a project contains a go.mod and has released v2 or up. The current v2.x branches (and releases) do not yet have a go.mod, and therefore are still allowed to be imported with a non-versioned import path (go modules add a `+incompatible` annotation in that case). However, now that this project has a `go.mod` file, incompatible import paths will not be accepted by go modules, and attempting to use code from this repository will fail. This patch uses `v3` for the import-paths (not `v2`), because changing import paths itself is a breaking change, which means that the next release should increment the "major" version to comply with SemVer (as go modules dictate). Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-08-24 11:18:39 +00:00
70. Update the registry binary in the [distribution library image repo](https://github.com/distribution/distribution-library-image) by running the update script and opening a pull request.
Update release documents Remove redundant AUTHORS file in favor of relying on .mailmap for keeping track of author names. Move older changelogs to release directory. Move release checklist to releases README. Signed-off-by: Derek McGowan <derek@mcgstyle.net>
2018-09-20 22:22:32 +00:00
80. Update the official image. Add the new version in the [official images repo](https://github.com/docker-library/official-images) by appending a new version to the `registry/registry` file 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 release `2.3.1`
`2.3.1 (new)`
`2.3.0 -> 2.3.0` can be removed
`2 -> 2.3.1`
`2.3 -> 2.3.1`
90. Build a new distribution/registry image on [Docker hub](https://hub.docker.com/u/distribution/dashboard) by adding a new automated build with the new tag and re-building the images.
Copy permalink