-
Notifications
You must be signed in to change notification settings - Fork 2.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update release documents #2720
Update release documents #2720
Conversation
4f90218
to
6bbdbd2
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with a couple of nits
releases/README.md
Outdated
@@ -0,0 +1,46 @@ | |||
## Registry Release Checklist | |||
|
|||
10. Compile release notes detailing features and since the last release. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/and/added
?
releases/README.md
Outdated
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 [distribution library image repo](https://github.com/docker/distribution-library-image) by running the update script and opening a pull request. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: s/in/in the
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. I've some non-blocking questions though :)
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"generated"?
|
||
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"generated"?
releases/README.md
Outdated
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 [distribution library image repo](https://github.com/docker/distribution-library-image) by running the update script and opening a pull request. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is me not understanding the historical context but this step of building image manually and pushing to another repo seems convoluted. Is it possible to have https://github.com/docker-library/official-images take binary from https://hub.docker.com/r/distribution/registry/tags/ or just retag with same manifest? Again, this is just for my understanding. Not asking to make any changes.
|
||
`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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wouldn't this get built automatically when the tag is pushed in step 50?
an `-rc` suffix. | ||
See https://github.com/containerd/containerd/tree/master/cmd/containerd-release | ||
|
||
20. Update the `.mailmap` files. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this file generated by the release tool mentioned above? If not then is it created manually? In any case could you mention that explicitly? Something like "Update the .mailmap
file manually by looking at authors of commits since last release". I see that you removed AUTHORS
target from Makefile. Wasn't that helpful in generating this file?
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 <[email protected]>
6bbdbd2
to
97cb7f3
Compare
Codecov Report
@@ Coverage Diff @@
## master #2720 +/- ##
=======================================
Coverage 60.28% 60.28%
=======================================
Files 103 103
Lines 8003 8003
=======================================
Hits 4825 4825
Misses 2536 2536
Partials 642 642
Continue to review full report at Codecov.
|
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.