Skip to content

Commit 1c9c64f

Browse files
committed
Update release procedure to mention api replace
Signed-off-by: Derek McGowan <[email protected]>
1 parent e69efd5 commit 1c9c64f

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

releases/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,18 @@ verified:
2727

2828
3. Update the version file at `https://github.com/containerd/containerd/blob/main/version/version.go`
2929

30-
4. (major/minor release only) Update RELEASES.md to refer to the new release and dates.
30+
4. Ensure api replace statement is removed, run `make clean-vendor` and ensure
31+
no api changes in vendor afterwards.
3132

32-
5. Update the `.mailmap` files for commit authors which have multiple email addresses in the commit log.
33+
5. (major/minor release only) Update RELEASES.md to refer to the new release and dates.
34+
35+
6. Update the `.mailmap` files for commit authors which have multiple email addresses in the commit log.
3336
If it is not clear which email or name the contributor might want used in the release notes, reach
3437
out to the contributor for feedback. NOTE: real names should be used whenever possible. The file is
3538
maintained by manually adding entries to the file.
3639
- e.g. `Real Name <[email protected]> Other Name <[email protected]>`
3740

38-
6. Before opening the pull request, run the release tool using the new release notes.
41+
7. Before opening the pull request, run the release tool using the new release notes.
3942
Ensure the output matches what is expected, including contributors, change log,
4043
dependencies, and visual elements such as spacing. If a contributor is duplicated,
4144
use the emails outputted by the release tool to update the mailmap then re-run. The

0 commit comments

Comments
 (0)