TrueCloudLab/distribution
13
0
Fork 3
Code Issues 3 Pull requests Projects Releases 2 Packages Wiki Activity Actions
distribution/releases
History
Sebastiaan van Stijn 1d33874951
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>
2021-02-08 18:30:46 +01:00
..
README.md go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00
v2.5.0-changelog.txt Update release documents 2018-09-26 18:30:44 -07:00
v2.6.0-changelog.txt Update release documents 2018-09-26 18:30:44 -07:00
v2.7.0.toml go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00

README.md

Registry Release Checklist

  1. 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. See https://github.com/containerd/containerd/tree/master/cmd/containerd-release

  1. Update the .mailmap files.

  2. Update the version file: https://github.com/distribution/distribution/blob/master/version/version.go

  3. 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 be the generate release notes, always compare with previous tags to ensure 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.

  1. Push the signed tag

  2. Create a new release. In the case of a release candidate, tick the pre-release checkbox. Use the generate release notes from the release tool

  3. Update the registry binary in the distribution library image repo by running the update script and opening a pull request.

  4. Update the official image. Add the new version in the official images repo 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

  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.