summaryrefslogtreecommitdiffstats
path: root/RELEASE.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-14 13:30:50 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-14 13:30:50 +0000
commitd5f222b7ebf4d2c2d47d20a25adcc9aadf67fbd5 (patch)
treeda9b32212bf99154450a7668f61a75f65617a9fa /RELEASE.md
parentInitial commit. (diff)
downloadicingaweb2-module-toplevelview-d5f222b7ebf4d2c2d47d20a25adcc9aadf67fbd5.tar.xz
icingaweb2-module-toplevelview-d5f222b7ebf4d2c2d47d20a25adcc9aadf67fbd5.zip
Adding upstream version 0.3.3.upstream/0.3.3upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'RELEASE.md')
-rw-r--r--RELEASE.md58
1 files changed, 58 insertions, 0 deletions
diff --git a/RELEASE.md b/RELEASE.md
new file mode 100644
index 0000000..70a593e
--- /dev/null
+++ b/RELEASE.md
@@ -0,0 +1,58 @@
+# Release Workflow
+
+Specify the release version.
+
+```
+VERSION=0.3.3
+```
+
+## Issues
+
+Check issues at https://github.com/Icinga/icingaweb2-module-toplevelview/issues
+
+## Authors
+
+Update the [.mailmap](.mailmap) and [AUTHORS](AUTHORS) files:
+
+```
+git checkout master
+git log --use-mailmap | grep ^Author: | cut -f2- -d' ' | sort | uniq > AUTHORS
+```
+
+## Update metadata
+
+Edit and update [module.info](module.info).
+
+## Changelog
+
+Update the [CHANGELOG.md](CHANGELOG.md) file.
+
+Uses [github_changelog_generator](https://github.com/skywinder/github-changelog-generator)
+
+```
+export CHANGELOG_GITHUB_TOKEN=xxx
+github_changelog_generator --future-release v$VERSION
+```
+
+Check if the file has been updated correctly.
+
+## Git Tag
+
+Commit these changes to the "master" branch:
+
+```
+git commit -v -a -m "Release version $VERSION"
+git push origin master
+```
+
+And tag it with a signed tag:
+
+```
+git tag -s -m "Version $VERSION" v$VERSION
+```
+
+Push the tag.
+
+```
+git push --tags
+```