github/containerd
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Update release procedure to mention api replace

Browse Source 
Signed-off-by: Derek McGowan <derek@mcg.dev>
This commit is contained in:
Derek McGowan 2024-05-06 11:11:16 -07:00
parent e69efd56d6
commit 1c9c64f316
No known key found for this signature in database
GPG Key ID: F58C5D0A4405ACDB
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
releases/README.md
View File

@ -27,15 +27,18 @@ verified:
3. Update the version file at `https://github.com/containerd/containerd/blob/main/version/version.go` 3. Update the version file at `https://github.com/containerd/containerd/blob/main/version/version.go`
4. (major/minor release only) Update RELEASES.md to refer to the new release and dates. 4. Ensure api replace statement is removed, run `make clean-vendor` and ensure
no api changes in vendor afterwards.
5. Update the `.mailmap` files for commit authors which have multiple email addresses in the commit log. 5. (major/minor release only) Update RELEASES.md to refer to the new release and dates.
6. Update the `.mailmap` files for commit authors which have multiple email addresses in the commit log.
If it is not clear which email or name the contributor might want used in the release notes, reach If it is not clear which email or name the contributor might want used in the release notes, reach
out to the contributor for feedback. NOTE: real names should be used whenever possible. The file is out to the contributor for feedback. NOTE: real names should be used whenever possible. The file is
maintained by manually adding entries to the file. maintained by manually adding entries to the file.
- e.g. `Real Name <preferred@email.com> Other Name <other@email.com>` - e.g. `Real Name <preferred@email.com> Other Name <other@email.com>`
6. Before opening the pull request, run the release tool using the new release notes. 7. Before opening the pull request, run the release tool using the new release notes.
Ensure the output matches what is expected, including contributors, change log, Ensure the output matches what is expected, including contributors, change log,
dependencies, and visual elements such as spacing. If a contributor is duplicated, dependencies, and visual elements such as spacing. If a contributor is duplicated,
use the emails outputted by the release tool to update the mailmap then re-run. The use the emails outputted by the release tool to update the mailmap then re-run. The