kelvin/warewulf
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

update RELEASE.md for current Warewulf branch and release process

Browse Source 
- Fixes: #1486

Signed-off-by: Jonathon Anderson <janderson@ciq.com>
This commit is contained in:
Jonathon Anderson
2025-01-17 13:59:22 -07:00
parent 48e9de2fc3
commit 275ffd7038
1 changed files with 24 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
RELEASE.md
View File

@@ -5,33 +5,51 @@ branch. Minor versions (e.g., v4.5.3) are tagged on a separate release
branch. branch.
1. Update `CHANGELOG.md`. 1. Update `CHANGELOG.md`.
- Identify the release date by changing "unreleased" to a date with - Identify the release date by changing "unreleased" to a date with
`%Y-%m-%d` format, following existing convention in the log. `%Y-%m-%d` format, following existing convention in the log.
- Do any final clean-up. (e.g., removing redundancy, adding issue
or PR numbers). - Do any final clean-up. (e.g., remove redundancy, add issue
or PR numbers, add missing changes)
git log --graph --oneline --decorate origin/main origin/v4.5.x
2. Update `userdocs` references that imply the latest release to refer 2. Update `userdocs` references that imply the latest release to refer
to the new version. to the new version.
- `contents/installation.rst` - `contents/installation.rst`
- `contributing/development-environment-vagrant.rst` - `contributing/development-environment-vagrant.rst`
- `quickstart/debian12.rst` - `quickstart/debian12.rst`
- `quickstart/el.rst` - `quickstart/el.rst`
3. Cherry-pick updates from 1 and 2 above to a release branch if necessary. 3. Cherry-pick updates from 1 and 2 above to a release branch if necessary.
(i.e., when not doing a new major release) (i.e., when not doing a new major release)
git cherry-pick -x -m1 --signoff
4. Create a signed tag for the release of the format v4.MINOR.PATCH, 4. Create a signed tag for the release of the format v4.MINOR.PATCH,
following the format specified in <MAINTAINING.md>. (e.g., `git tag following the format specified in <MAINTAINING.md>.
--sign v4.5.3; git push origin v4.5.3`)
git tag --sign v4.5.3; git push origin v4.5.3
5. Monitor the release action associated with the pushed tag at 5. Monitor the release action associated with the pushed tag at
https://github.com/warewulf/warewulf/actions, and verify the https://github.com/warewulf/warewulf/actions, and verify the
generated draft release contains the expected artifacts. This generated draft release contains the expected artifacts. This
includes the source tarball and RPMs for Suse and Rocky Linux. includes the source tarball and RPMs for Suse and Rocky Linux.
6. Update the release notes for the release, summarizing and expanding 6. Update the release notes for the release, summarizing and expanding
on the relevant contents from <CHANGELOG.md>. on the relevant contents from <CHANGELOG.md>.
7. Confirm the correct values for the pre-release and latest release 7. Confirm the correct values for the pre-release and latest release
flags. flags.
8. Publish the release. 8. Publish the release.
9. Announce the release as a [post][1] to warewulf.org/news, linking
9. Announce the release as a [post][1] to [warewulf.org/news][2], linking
to the GitHub release. to the GitHub release.
10. Announce the release on the Warewulf Slack, linking to the 10. Announce the release on the Warewulf Slack, linking to the
warewulf.org/news post. [warewulf.org/news][2] post.
[1]: https://github.com/warewulf/warewulf.org/tree/main/src/posts [1]: https://github.com/warewulf/warewulf.org/tree/main/src/posts
[2]: https://warewulf.org/news