5.7 KiB
Release Workflow
Table of Content
- 1. Preparations
- 2. Version
- 3. Changelog
- 4. Git Tag
- 5. Package Builds
- 6. Build Server
- 7. Release Tests
- 8. GitHub Release
- 9. Post Release
Preparations
Specify the release version.
VERSION=2.6.0
Add your signing key to your Git configuration file, if not already there.
vim $HOME/.gitconfig
[user]
email = michael.friedrich@icinga.com
name = Michael Friedrich
signingkey = D14A1F16
Issues
Check issues at https://github.com/Icinga/icingaweb2
Backport Commits
For minor versions not branched off git master you need to manually backports any and all commits from the master branch which should be part of this release.
Authors
Update the .mailmap and AUTHORS files:
git log --use-mailmap | grep '^Author:' | cut -f2- -d' ' | sort | uniq > AUTHORS
Version
Update the version in the following files:
- VERSION
- Application Version: library/Icinga/Application/Version.php
- Module Versions in
modules/*/module.info
Commands:
echo "v$VERSION" > VERSION
sed -i '' "s/const VERSION = '.*'/const VERSION = '$VERSION'/g" library/Icinga/Application/Version.php
find . -type f -name '*.info' -exec sed -i '' "s/Version: .*/Version: $VERSION/g" {} \;
Changelog
Link to the milestone and closed=1 as filter.
Git Tag
git commit -v -a -m "Release version $VERSION"
Create a signed tag (tags/v) on the master branch (for major
releases) or the support branch (for minor releases).
git tag -s -m "Version $VERSION" v$VERSION
Push the tag:
git push --tags
For major releases: Create a new support branch:
git checkout master
git checkout -b support/2.6
git push -u origin support/2.6
Package Builds
RPM Packages
git clone git@github.com:icinga/rpm-icingaweb2.git && cd rpm-icingaweb2
Branch Workflow
Major releases are branched off master.
git checkout master && git pull
Bugfix releases are created in the release branch and later merged to master.
git checkout release && git pull
Release Commit
Set the Version, Revision and changelog inside the spec file.
sed -i "s/Version: .*/Version: $VERSION/g" icingaweb2.spec
vim icingaweb2.spec
%changelog
* Fri Apr 27 2018 Eric.Lippmann <eric.lippmann@icinga.com> 2.5.3-1
- Update to 2.5.3
git commit -av -m "Release 2.5.3-1"
git push
Note for major releases: Update release branch to latest.
git checkout release && git pull && git merge master && git push
Note for minor releases: Cherry-pick the release commit into master.
git checkout master && git pull && git cherry-pick release && git push
DEB Packages
git clone git@github.com:icinga/deb-icingaweb2.git && cd deb-icingaweb2
Branch Workflow
Major releases are branched off master.
git checkout master && git pull
Bugfix releases are created in the release branch and later merged to master.
git checkout release && git pull
Release Commit
Set the Version, Revision and changelog inside the spec file.
./dch 2.5.3-1 "Update to 2.5.3"
git commit -av -m "Release 2.5.3-1"
git push
Note for major releases: Update release branch to latest.
git checkout release && git pull && git merge master && git push
Note for minor releases: Cherry-pick the release commit into master.
git checkout master && git pull && git cherry-pick release && git push
DEB with dch on macOS
docker run -v `pwd`:/mnt/packaging -ti ubuntu:xenial bash
apt-get update
apt-get install git devscripts vim
cd /mnt/packaging
git config --global user.name "Eric Lippmann"
git config --global user.email "eric.lippmann@icinga.com"
./dch 2.5.3-1 "Update to 2.5.3"
Build Server
- Verify package build changes for this version.
- Test the snapshot packages for all distributions beforehand.
- Build the newly created Git tag for Debian/RHEL/SuSE.
Release Tests
- Provision the vagrant boxes and test the release packages.
GitHub Release
Create a new release for the newly created Git tag: https://github.com/Icinga/icingaweb2/releases
Online Documentation
Ask @bobapple to update the documentation at docs.icinga.com.
Announcement
- Create a new blog post on icinga.com/blog
- Social media: Twitter, Facebook, Xing, LinkedIn
- Update IRC channel topic