Skip to content

Commit

Permalink
docs: specify some missing details in the release process
Browse files Browse the repository at this point in the history
  • Loading branch information
FrostyX authored and praiskup committed Apr 8, 2024
1 parent 0629858 commit b45aaea
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/Releasing-Mock.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,17 @@ helps you to setup a correct configuration layout.

Fix the test-suite errors first, before moving to the next step.

6. Prepare release notes.
6. Prepare release notes. Use the going-to-be-released version, not
the current version. If you want to release only configs, use
`--config-only`.

$ sudo dnf install towncrier
$ ./releng/generate-release-notes --use-version 5.1
$ vim docs/Release-Notes-5.1.md # modify manually!

Rename release notes for configs from e.g. `Release-Notes-40.3.md`
to `Release-Notes-Configs-40.3.md`.

Don't forget to manually modify ./docs/index.md and mention the new release.

Add list of contributing authors:
Expand Down

0 comments on commit b45aaea

Please sign in to comment.