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>
This commit is contained in:
Derek McGowan
parent
b089e91688
commit
97cb7f35b0
6 changed files with 79 additions and 264 deletions
182
AUTHORS
182
AUTHORS
|
|
@ -1,182 +0,0 @@
|
||||||
a-palchikov <deemok@gmail.com>
|
|
||||||
Aaron Lehmann <aaron.lehmann@docker.com>
|
|
||||||
Aaron Schlesinger <aschlesinger@deis.com>
|
|
||||||
Aaron Vinson <avinson.public@gmail.com>
|
|
||||||
Adam Duke <adam.v.duke@gmail.com>
|
|
||||||
Adam Enger <adamenger@gmail.com>
|
|
||||||
Adrian Mouat <adrian.mouat@gmail.com>
|
|
||||||
Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
|
|
||||||
Alex Chan <alex.chan@metaswitch.com>
|
|
||||||
Alex Elman <aelman@indeed.com>
|
|
||||||
Alexey Gladkov <gladkov.alexey@gmail.com>
|
|
||||||
allencloud <allen.sun@daocloud.io>
|
|
||||||
amitshukla <ashukla73@hotmail.com>
|
|
||||||
Amy Lindburg <amy.lindburg@docker.com>
|
|
||||||
Andrew Hsu <andrewhsu@acm.org>
|
|
||||||
Andrew Meredith <andymeredith@gmail.com>
|
|
||||||
Andrew T Nguyen <andrew.nguyen@docker.com>
|
|
||||||
Andrey Kostov <kostov.andrey@gmail.com>
|
|
||||||
Andy Goldstein <agoldste@redhat.com>
|
|
||||||
Anis Elleuch <vadmeste@gmail.com>
|
|
||||||
Anton Tiurin <noxiouz@yandex.ru>
|
|
||||||
Antonio Mercado <amercado@thinknode.com>
|
|
||||||
Antonio Murdaca <runcom@redhat.com>
|
|
||||||
Anusha Ragunathan <anusha@docker.com>
|
|
||||||
Arien Holthuizen <aholthuizen@schubergphilis.com>
|
|
||||||
Arnaud Porterie <arnaud.porterie@docker.com>
|
|
||||||
Arthur Baars <arthur@semmle.com>
|
|
||||||
Asuka Suzuki <hello@tanksuzuki.com>
|
|
||||||
Avi Miller <avi.miller@oracle.com>
|
|
||||||
Ayose Cazorla <ayosec@gmail.com>
|
|
||||||
BadZen <dave.trombley@gmail.com>
|
|
||||||
Ben Bodenmiller <bbodenmiller@hotmail.com>
|
|
||||||
Ben Firshman <ben@firshman.co.uk>
|
|
||||||
bin liu <liubin0329@gmail.com>
|
|
||||||
Brian Bland <brian.bland@docker.com>
|
|
||||||
burnettk <burnettk@gmail.com>
|
|
||||||
Carson A <ca@carsonoid.net>
|
|
||||||
Cezar Sa Espinola <cezarsa@gmail.com>
|
|
||||||
Charles Smith <charles.smith@docker.com>
|
|
||||||
Chris Dillon <squarism@gmail.com>
|
|
||||||
cuiwei13 <cuiwei13@pku.edu.cn>
|
|
||||||
cyli <cyli@twistedmatrix.com>
|
|
||||||
Daisuke Fujita <dtanshi45@gmail.com>
|
|
||||||
Daniel Huhn <daniel@danielhuhn.de>
|
|
||||||
Darren Shepherd <darren@rancher.com>
|
|
||||||
Dave Trombley <dave.trombley@gmail.com>
|
|
||||||
Dave Tucker <dt@docker.com>
|
|
||||||
David Lawrence <david.lawrence@docker.com>
|
|
||||||
David Verhasselt <david@crowdway.com>
|
|
||||||
David Xia <dxia@spotify.com>
|
|
||||||
davidli <wenquan.li@hp.com>
|
|
||||||
Dejan Golja <dejan@golja.org>
|
|
||||||
Derek McGowan <derek@mcgstyle.net>
|
|
||||||
Diogo Mónica <diogo.monica@gmail.com>
|
|
||||||
DJ Enriquez <dj.enriquez@infospace.com>
|
|
||||||
Donald Huang <don.hcd@gmail.com>
|
|
||||||
Doug Davis <dug@us.ibm.com>
|
|
||||||
Edgar Lee <edgar.lee@docker.com>
|
|
||||||
Eric Yang <windfarer@gmail.com>
|
|
||||||
Fabio Berchtold <jamesclonk@jamesclonk.ch>
|
|
||||||
Fabio Huser <fabio@fh1.ch>
|
|
||||||
farmerworking <farmerworking@gmail.com>
|
|
||||||
Felix Yan <felixonmars@archlinux.org>
|
|
||||||
Florentin Raud <florentin.raud@gmail.com>
|
|
||||||
Frank Chen <frankchn@gmail.com>
|
|
||||||
Frederick F. Kautz IV <fkautz@alumni.cmu.edu>
|
|
||||||
gabriell nascimento <gabriell@bluesoft.com.br>
|
|
||||||
Gleb Schukin <gschukin@ptsecurity.com>
|
|
||||||
harche <p.harshal@gmail.com>
|
|
||||||
Henri Gomez <henri.gomez@gmail.com>
|
|
||||||
Hu Keping <hukeping@huawei.com>
|
|
||||||
Hua Wang <wanghua.humble@gmail.com>
|
|
||||||
HuKeping <hukeping@huawei.com>
|
|
||||||
Ian Babrou <ibobrik@gmail.com>
|
|
||||||
igayoso <igayoso@gmail.com>
|
|
||||||
Jack Griffin <jackpg14@gmail.com>
|
|
||||||
James Findley <jfindley@fastmail.com>
|
|
||||||
Jason Freidman <jason.freidman@gmail.com>
|
|
||||||
Jason Heiss <jheiss@aput.net>
|
|
||||||
Jeff Nickoloff <jeff@allingeek.com>
|
|
||||||
Jess Frazelle <acidburn@google.com>
|
|
||||||
Jessie Frazelle <jessie@docker.com>
|
|
||||||
jhaohai <jhaohai@foxmail.com>
|
|
||||||
Jianqing Wang <tsing@jianqing.org>
|
|
||||||
Jihoon Chung <jihoon@gmail.com>
|
|
||||||
Joao Fernandes <joao.fernandes@docker.com>
|
|
||||||
John Mulhausen <john@docker.com>
|
|
||||||
John Starks <jostarks@microsoft.com>
|
|
||||||
Jon Johnson <jonjohnson@google.com>
|
|
||||||
Jon Poler <jonathan.poler@apcera.com>
|
|
||||||
Jonathan Boulle <jonathanboulle@gmail.com>
|
|
||||||
Jordan Liggitt <jliggitt@redhat.com>
|
|
||||||
Josh Chorlton <josh.chorlton@docker.com>
|
|
||||||
Josh Hawn <josh.hawn@docker.com>
|
|
||||||
Julien Fernandez <julien.fernandez@gmail.com>
|
|
||||||
Ke Xu <leonhartx.k@gmail.com>
|
|
||||||
Keerthan Mala <kmala@engineyard.com>
|
|
||||||
Kelsey Hightower <kelsey.hightower@gmail.com>
|
|
||||||
Kenneth Lim <kennethlimcp@gmail.com>
|
|
||||||
Kenny Leung <kleung@google.com>
|
|
||||||
Li Yi <denverdino@gmail.com>
|
|
||||||
Liu Hua <sdu.liu@huawei.com>
|
|
||||||
liuchang0812 <liuchang0812@gmail.com>
|
|
||||||
Lloyd Ramey <lnr0626@gmail.com>
|
|
||||||
Louis Kottmann <louis.kottmann@gmail.com>
|
|
||||||
Luke Carpenter <x@rubynerd.net>
|
|
||||||
Marcus Martins <marcus@docker.com>
|
|
||||||
Mary Anthony <mary@docker.com>
|
|
||||||
Matt Bentley <mbentley@mbentley.net>
|
|
||||||
Matt Duch <matt@learnmetrics.com>
|
|
||||||
Matt Moore <mattmoor@google.com>
|
|
||||||
Matt Robenolt <matt@ydekproductions.com>
|
|
||||||
Matthew Green <greenmr@live.co.uk>
|
|
||||||
Michael Prokop <mika@grml.org>
|
|
||||||
Michal Minar <miminar@redhat.com>
|
|
||||||
Michal Minář <miminar@redhat.com>
|
|
||||||
Mike Brown <brownwm@us.ibm.com>
|
|
||||||
Miquel Sabaté <msabate@suse.com>
|
|
||||||
Misty Stanley-Jones <misty@apache.org>
|
|
||||||
Misty Stanley-Jones <misty@docker.com>
|
|
||||||
Morgan Bauer <mbauer@us.ibm.com>
|
|
||||||
moxiegirl <mary@docker.com>
|
|
||||||
Nathan Sullivan <nathan@nightsys.net>
|
|
||||||
nevermosby <robolwq@qq.com>
|
|
||||||
Nghia Tran <tcnghia@gmail.com>
|
|
||||||
Nikita Tarasov <nikita@mygento.ru>
|
|
||||||
Noah Treuhaft <noah.treuhaft@docker.com>
|
|
||||||
Nuutti Kotivuori <nuutti.kotivuori@poplatek.fi>
|
|
||||||
Oilbeater <liumengxinfly@gmail.com>
|
|
||||||
Olivier Gambier <olivier@docker.com>
|
|
||||||
Olivier Jacques <olivier.jacques@hp.com>
|
|
||||||
Omer Cohen <git@omer.io>
|
|
||||||
Patrick Devine <patrick.devine@docker.com>
|
|
||||||
Phil Estes <estesp@linux.vnet.ibm.com>
|
|
||||||
Philip Misiowiec <philip@atlashealth.com>
|
|
||||||
Pierre-Yves Ritschard <pyr@spootnik.org>
|
|
||||||
Qiao Anran <qiaoanran@gmail.com>
|
|
||||||
Randy Barlow <randy@electronsweatshop.com>
|
|
||||||
Richard Scothern <richard.scothern@docker.com>
|
|
||||||
Rodolfo Carvalho <rhcarvalho@gmail.com>
|
|
||||||
Rusty Conover <rusty@luckydinosaur.com>
|
|
||||||
Sean Boran <Boran@users.noreply.github.com>
|
|
||||||
Sebastiaan van Stijn <github@gone.nl>
|
|
||||||
Sebastien Coavoux <s.coavoux@free.fr>
|
|
||||||
Serge Dubrouski <sergeyfd@gmail.com>
|
|
||||||
Sharif Nassar <sharif@mrwacky.com>
|
|
||||||
Shawn Falkner-Horine <dreadpirateshawn@gmail.com>
|
|
||||||
Shreyas Karnik <karnik.shreyas@gmail.com>
|
|
||||||
Simon Thulbourn <simon+github@thulbourn.com>
|
|
||||||
spacexnice <yaoyao.xyy@alibaba-inc.com>
|
|
||||||
Spencer Rinehart <anubis@overthemonkey.com>
|
|
||||||
Stan Hu <stanhu@gmail.com>
|
|
||||||
Stefan Majewsky <stefan.majewsky@sap.com>
|
|
||||||
Stefan Weil <sw@weilnetz.de>
|
|
||||||
Stephen J Day <stephen.day@docker.com>
|
|
||||||
Sungho Moon <sungho.moon@navercorp.com>
|
|
||||||
Sven Dowideit <SvenDowideit@home.org.au>
|
|
||||||
Sylvain Baubeau <sbaubeau@redhat.com>
|
|
||||||
Ted Reed <ted.reed@gmail.com>
|
|
||||||
tgic <farmer1992@gmail.com>
|
|
||||||
Thomas Sjögren <konstruktoid@users.noreply.github.com>
|
|
||||||
Tianon Gravi <admwiggin@gmail.com>
|
|
||||||
Tibor Vass <teabee89@gmail.com>
|
|
||||||
Tonis Tiigi <tonistiigi@gmail.com>
|
|
||||||
Tony Holdstock-Brown <tony@docker.com>
|
|
||||||
Trevor Pounds <trevor.pounds@gmail.com>
|
|
||||||
Troels Thomsen <troels@thomsen.io>
|
|
||||||
Victor Vieux <vieux@docker.com>
|
|
||||||
Victoria Bialas <victoria.bialas@docker.com>
|
|
||||||
Vincent Batts <vbatts@redhat.com>
|
|
||||||
Vincent Demeester <vincent@sbr.pm>
|
|
||||||
Vincent Giersch <vincent.giersch@ovh.net>
|
|
||||||
W. Trevor King <wking@tremily.us>
|
|
||||||
weiyuan.yl <weiyuan.yl@alibaba-inc.com>
|
|
||||||
xg.song <xg.song@venusource.com>
|
|
||||||
xiekeyang <xiekeyang@huawei.com>
|
|
||||||
Yann ROBERT <yann.robert@anantaplex.fr>
|
|
||||||
yaoyao.xyy <yaoyao.xyy@alibaba-inc.com>
|
|
||||||
yuexiao-wang <wang.yuexiao@zte.com.cn>
|
|
||||||
yuzou <zouyu7@huawei.com>
|
|
||||||
zhouhaibing089 <zhouhaibing089@gmail.com>
|
|
||||||
姜继忠 <jizhong.jiangjz@alibaba-inc.com>
|
|
||||||
3
Makefile
3
Makefile
|
|
@ -43,9 +43,6 @@ TESTFLAGS_PARALLEL ?= 8
|
||||||
|
|
||||||
all: binaries
|
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.
|
# This only needs to be generated by hand when cutting full releases.
|
||||||
version/version.go:
|
version/version.go:
|
||||||
@echo "$(WHALE) $@"
|
@echo "$(WHALE) $@"
|
||||||
|
|
|
||||||
|
|
@ -1,44 +0,0 @@
|
||||||
## Registry Release Checklist
|
|
||||||
|
|
||||||
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, 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
|
|
||||||
|
|
||||||
60. Create a new [release](https://github.com/docker/distribution/releases). In the case of a release candidate, tick the `pre-release` checkbox.
|
|
||||||
|
|
||||||
70. Update the registry binary in [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.
|
|
||||||
|
|
||||||
46
releases/README.md
Normal file
46
releases/README.md
Normal file
|
|
@ -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
releases/v2.5.0-changelog.txt
Normal file
33
releases/v2.5.0-changelog.txt
Normal file
|
|
@ -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
|
||||||
|
|
@ -71,38 +71,3 @@ Documentation has moved to the documentation repository at
|
||||||
`github.com/docker/docker.github.io/tree/master/registry`
|
`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.
|
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
|
|
||||||
|
|
||||||
|
|
||||||
Loading…
Reference in a new issue