Skip to content

Commit

Permalink
Merge pull request #2720 from dmcgowan/update-release-process
Browse files Browse the repository at this point in the history
Update release documents
  • Loading branch information
dmcgowan committed Sep 27, 2018
2 parents d37f816 + 97cb7f3 commit e1817db
Show file tree
Hide file tree
Showing 6 changed files with 79 additions and 264 deletions.
182 changes: 0 additions & 182 deletions AUTHORS

This file was deleted.

3 changes: 0 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,6 @@ TESTFLAGS_PARALLEL ?= 8

all: binaries

AUTHORS: .mailmap .git/HEAD
git log --format='%aN <%aE>' | sort -fu > $@

# This only needs to be generated by hand when cutting full releases.
version/version.go:
@echo "$(WHALE) $@"
Expand Down
44 changes: 0 additions & 44 deletions RELEASE-CHECKLIST.md

This file was deleted.

46 changes: 46 additions & 0 deletions releases/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
## 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.
See https://github.com/containerd/containerd/tree/master/cmd/containerd-release

20. Update the `.mailmap` files.

30. Update the version file: `https://github.com/docker/distribution/blob/master/version/version.go`

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
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.

50. Push the signed tag

60. Create a new [release](https://github.com/docker/distribution/releases).
In the case of a release candidate, tick the `pre-release` checkbox. Use
the generate release notes from the release tool

70. Update the registry binary in the [distribution library image repo](https://github.com/docker/distribution-library-image) by running the update script and opening a pull request.

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.
33 changes: 33 additions & 0 deletions releases/v2.5.0-changelog.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Changelog

## 2.5.0 (2016-06-14)

#### Storage
- Ensure uploads directory is cleaned after upload is committed
- Add ability to cap concurrent operations in filesystem driver
- S3: Add 'us-gov-west-1' to the valid region list
- Swift: Handle ceph not returning Last-Modified header for HEAD requests
- Add redirect middleware

#### Registry
- Add support for blobAccessController middleware
- Add support for layers from foreign sources
- Remove signature store
- Add support for Let's Encrypt
- Correct yaml key names in configuration

#### Client
- Add option to get content digest from manifest get

#### Spec
- Update the auth spec scope grammar to reflect the fact that hostnames are optionally supported
- Clarify API documentation around catalog fetch behavior

#### API
- Support returning HTTP 429 (Too Many Requests)

#### Documentation
- Update auth documentation examples to show "expires in" as int

#### Docker Image
- Use Alpine Linux as base image
35 changes: 0 additions & 35 deletions CHANGELOG.md → releases/v2.6.0-changelog.txt
Original file line number Diff line number Diff line change
Expand Up @@ -71,38 +71,3 @@ Documentation has moved to the documentation repository at
`github.com/docker/docker.github.io/tree/master/registry`

The registry is go 1.7 compliant, and passes newer, more restrictive `lint` and `vet` ing.


## 2.5.0 (2016-06-14)

#### Storage
- Ensure uploads directory is cleaned after upload is committed
- Add ability to cap concurrent operations in filesystem driver
- S3: Add 'us-gov-west-1' to the valid region list
- Swift: Handle ceph not returning Last-Modified header for HEAD requests
- Add redirect middleware

#### Registry
- Add support for blobAccessController middleware
- Add support for layers from foreign sources
- Remove signature store
- Add support for Let's Encrypt
- Correct yaml key names in configuration

#### Client
- Add option to get content digest from manifest get

#### Spec
- Update the auth spec scope grammar to reflect the fact that hostnames are optionally supported
- Clarify API documentation around catalog fetch behavior

#### API
- Support returning HTTP 429 (Too Many Requests)

#### Documentation
- Update auth documentation examples to show "expires in" as int

#### Docker Image
- Use Alpine Linux as base image


0 comments on commit e1817db

Please sign in to comment.