summaryrefslogtreecommitdiffstats
path: root/RELEASE.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 12:46:04 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 12:46:04 +0000
commitb880345a8a897b3fe600ef94a0fee5bb5f2f8558 (patch)
treefdc7483ceea33373b6cfa4a8c20c11cb02a2676a /RELEASE.md
parentInitial commit. (diff)
downloadicingaweb2-module-pnp-b880345a8a897b3fe600ef94a0fee5bb5f2f8558.tar.xz
icingaweb2-module-pnp-b880345a8a897b3fe600ef94a0fee5bb5f2f8558.zip
Adding upstream version 1.1.0.upstream/1.1.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'RELEASE.md')
-rw-r--r--RELEASE.md59
1 files changed, 59 insertions, 0 deletions
diff --git a/RELEASE.md b/RELEASE.md
new file mode 100644
index 0000000..c2aba0d
--- /dev/null
+++ b/RELEASE.md
@@ -0,0 +1,59 @@
+# Release Workflow
+
+Specify the release version.
+
+```
+VERSION=1.1.0
+```
+
+## Issues
+
+Check issues at https://github.com/Icinga/icingaweb2-module-pnp
+
+## Authors
+
+Update the [.mailmap](.mailmap) and [AUTHORS](AUTHORS) files:
+
+```
+git checkout master
+git log --use-mailmap | grep ^Author: | cut -f2- -d' ' | sort | uniq > AUTHORS
+```
+
+## 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
+```
+
+## GitHub Release
+
+Create a new release for the newly created Git tag.
+https://github.com/Icinga/icingaweb2-module-pnp/releases