| 1 |
--- |
| 2 |
description: Guide through creating a new Rspamd release |
| 3 |
--- |
| 4 |
|
| 5 |
Guide through the Rspamd release process: |
| 6 |
|
| 7 |
1. Ask for the new version number (X.Y.Z) |
| 8 |
2. Show recent commits since last release to help write ChangeLog |
| 9 |
3. Help update ChangeLog with proper format: |
| 10 |
``` |
| 11 |
X.Y.Z: DD MMM YYYY |
| 12 |
* [Feature] Feature description |
| 13 |
* [Fix] Fix description |
| 14 |
``` |
| 15 |
4. Update version in CMakeLists.txt |
| 16 |
5. Create release commit with full changelog: |
| 17 |
``` |
| 18 |
git commit --no-verify -S -m "Release X.Y.Z |
| 19 |
|
| 20 |
* [Feature] ... |
| 21 |
* [Fix] ..." |
| 22 |
``` |
| 23 |
6. Create signed release tag: |
| 24 |
``` |
| 25 |
git tag -s X.Y.Z -m "Rspamd X.Y.Z |
| 26 |
|
| 27 |
Main features: |
| 28 |
* ... |
| 29 |
|
| 30 |
Critical fixes: |
| 31 |
* ..." |
| 32 |
``` |
| 33 |
7. Create follow-up commit updating version for next dev cycle |
| 34 |
8. Remind to push commits and tags |
| 35 |
|
| 36 |
Walk through each step interactively. |