1## go-digest release process
2
31. Create release pull request with release notes and updated versions.
4
5 1. Compile release notes detailing features added since the last release and
6 add release template file to `releases/` directory. The template is defined
7 by containerd's release tool but refer to previous release files for style
8 and format help. Name the file using the version, for rc add an `-rc` suffix.
9 When moving from rc to final, the rc file may just be renamed and updated.
10 See [release-tool](https://github.com/containerd/release-tool)
11
12 2. Update the `.mailmap` files for commit authors which have multiple email addresses in the commit log.
13 If it is not clear which email or name the contributor might want used in the release notes, reach
14 out to the contributor for feedback. NOTE: real names should be used whenever possible. The file is
15 maintained by manually adding entries to the file.
16 - e.g. `Real Name <preferred@email.com> Other Name <other@email.com>`
17
18 3. Before opening the pull request, run the release tool using the new release notes.
19 Ensure the output matches what is expected, including contributors, change log,
20 dependencies, and visual elements such as spacing. If a contributor is duplicated,
21 use the emails outputted by the release tool to update the mailmap then re-run. The
22 goal of the release tool is that is generates release notes that need no
23 alterations after it is generated.
24
252. Create tag
26
27 1. Choose tag for the next release, go-digest uses semantic versioning and
28 expects tags to be formatted as `vx.y.z[-rc.n]`.
29
30 2. Generate release notes (using a temp file may be helpful).
31 - e.g. `release-tool -l -d -n -t v1.0.0 ./releases/v1.0.0.toml > /tmp/v1.0.0-notes`
32
33 3. Create tag using the generated release notes.
34 - e.g. `git tag --cleanup=whitespace -s v1.0.0 -F /tmp/v1.0.0-notes`
35
36 4. Verify tag (e.g. `git show v1.0.0`), it may help to compare the new tag against previous.
37
383. Push tag and Github release
39
40 1. Push the tag to `git@github.com:opencontainers/go-digest.git`.
41 NOTE: this will kick off CI building of the release binaries.
42
43 2. Create the Github release using the `Tag version` which was just pushed. Use the first
44 line outputted from the release tool as the `Release title` and the remainder of the
45 output for the description. No alteration of the release output should be needed.
46 Ensure `pre-release` is checked if an `-rc`.
47 NOTE: This should be done immediately after pushing the tag, otherwise CI may create the release
48 when the binaries are pushed.
49
504. Promote on Slack, Twitter, mailing lists, etc
View as plain text