icinga2/RELEASE.md

374 lines
8.4 KiB
Markdown
Raw Normal View History

2018-04-24 14:51:26 +02:00
# Release Workflow <a id="release-workflow"></a>
#### Table of Content
- [1. Preparations](#preparations)
- [1.1. Issues](#issues)
- [1.2. Backport Commits](#backport-commits)
- [1.3. Authors](#authors)
- [2. Version](#version)
- [3. Changelog](#changelog)
- [4. Git Tag](#git-tag)
- [5. Package Builds](#package-builds)
- [5.1. RPM Packages](#rpm-packages)
- [5.2. DEB Packages](#deb-packages)
- [6. Build Server](#build-server)
- [7. Release Tests](#release-tests)
- [8. GitHub Release](#github-release)
- [9. Chocolatey](#chocolatey)
- [10. Post Release](#post-release)
- [10.1. Online Documentation](#online-documentation)
- [10.2. Announcement](#announcement)
- [10.3. Project Management](#project-management)
## Preparations <a id="preparations"></a>
2015-04-20 16:43:17 +02:00
2016-08-30 15:13:06 +02:00
Specify the release version.
```
VERSION=2.10.4
```
2016-08-30 15:13:06 +02:00
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
```
2018-04-24 14:51:26 +02:00
### Issues <a id="issues"></a>
2015-12-07 16:29:19 +01:00
Check issues at https://github.com/Icinga/icinga2
2018-04-24 14:51:26 +02:00
### Backport Commits <a id="backport-commits"></a>
2016-04-20 18:35:19 +02:00
2017-02-13 10:51:27 +01:00
For minor versions you need to manually backports any and all commits from the
master branch which should be part of this release.
2016-04-20 18:35:19 +02:00
2018-04-24 14:51:26 +02:00
### Authors <a id="authors"></a>
Update the [.mailmap](.mailmap) and [AUTHORS](AUTHORS) files:
```
git checkout master
2017-11-09 12:32:32 +01:00
git log --use-mailmap | grep '^Author:' | cut -f2- -d' ' | sort | uniq > AUTHORS
```
2018-04-24 14:51:26 +02:00
## Version <a id="version"></a>
2018-09-25 17:29:23 +02:00
Update the version:
```
2018-04-24 14:51:26 +02:00
sed -i "s/Version: .*/Version: $VERSION/g" VERSION
```
2016-08-30 15:13:06 +02:00
2018-04-24 14:51:26 +02:00
## Changelog <a id="changelog"></a>
Link to the milestone and closed=1 as filter.
2015-06-18 15:53:08 +02:00
Manually update the best of collected from the
milestone description.
2018-04-24 14:51:26 +02:00
## Git Tag <a id="git-tag"></a>
2018-04-24 14:51:26 +02:00
> **Major Releases**: Commit these changes to the `master` branch.
>
> **Minor Releases**: Commit changes to the `support` branch.
```
git commit -v -a -m "Release version $VERSION"
```
2018-04-24 14:51:26 +02:00
Create a signed tag (tags/v<VERSION>) on the `master` branch (for major
releases) or the `support` branch (for minor releases).
```
git tag -s -m "Version $VERSION" v$VERSION
```
2018-04-24 14:51:26 +02:00
Push the tag:
2017-11-09 13:30:33 +01:00
```
2018-04-24 14:51:26 +02:00
git push --tags
2017-11-09 13:30:33 +01:00
```
2018-04-24 14:51:26 +02:00
**For major releases:** Create a new `support` branch:
```
git checkout master
git push
git checkout -b support/2.11
git push -u origin support/2.11
2018-04-24 14:51:26 +02:00
```
2018-04-24 14:51:26 +02:00
**For minor releases:** Push the support branch, cherry-pick the release commit
into master and merge the support branch:
```
git push -u origin support/2.10
2018-04-24 14:51:26 +02:00
git checkout master
git cherry-pick support/2.10
git merge --strategy=ours support/2.10
2018-04-24 14:51:26 +02:00
git push origin master
```
2018-04-24 14:51:26 +02:00
## Package Builds <a id="package-builds"></a>
### RPM Packages <a id="rpm-packages"></a>
```
2018-04-24 14:51:26 +02:00
git clone git@github.com:icinga/rpm-icinga2.git && cd rpm-icinga2
```
2018-04-24 14:51:26 +02:00
#### Branch Workflow
**Major releases** are branched off `master`.
2017-11-09 12:32:32 +01:00
```
2018-04-24 14:51:26 +02:00
git checkout master && git pull
2017-11-09 12:32:32 +01:00
```
2017-11-09 13:30:33 +01:00
2018-04-24 14:51:26 +02:00
**Bugfix releases** are created in the `release` branch and later merged to master.
2018-04-23 11:28:12 +02:00
```
2018-04-24 14:51:26 +02:00
git checkout release && git pull
2018-04-23 11:28:12 +02:00
```
2018-04-24 14:51:26 +02:00
#### Release Commit
Set the `Version`, `Revision` and `changelog` inside the spec file.
```
VERSION=2.10.4
2018-04-24 14:51:26 +02:00
sed -i "s/Version: .*/Version: $VERSION/g" icinga2.spec
vim icinga2.spec
%changelog
* Tue Mar 19 2019 Michael Friedrich <michael.friedrich@icinga.com> 2.10.4-1
- Update to 2.10.4
2018-04-24 14:51:26 +02:00
```
```
git commit -av -m "Release $VERSION-1"
2018-04-24 14:51:26 +02:00
git push
```
2018-04-24 14:51:26 +02:00
**Note for major releases**: Update release branch to latest.
```
git checkout release && git pull && git merge master && git push
```
2018-04-24 14:51:26 +02:00
**Note for minor releases**: Cherry-pick the release commit into master.
```
git checkout master && git pull && git cherry-pick release && git push
```
2018-04-24 14:51:26 +02:00
### DEB Packages <a id="deb-packages"></a>
```
2018-04-24 14:51:26 +02:00
git clone git@github.com:icinga/deb-icinga2.git && cd deb-icinga2
```
2015-07-15 12:38:15 +02:00
2018-04-24 14:51:26 +02:00
#### Branch Workflow
**Major releases** are branched off `master`.
2015-07-15 12:38:15 +02:00
```
2018-04-24 14:51:26 +02:00
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` by using the `dch` helper.
2018-04-24 14:51:26 +02:00
```
VERSION=2.10.4
./dch $VERSION-1 "Update to $VERSION"
2018-04-24 14:51:26 +02:00
```
```
git commit -av -m "Release $VERSION-1"
2018-04-24 14:51:26 +02:00
git push
```
**Note for major releases**: Update release branch to latest.
```
git checkout release && git pull && git merge master && git push
```
2018-04-24 14:51:26 +02:00
**Note for minor releases**: Cherry-pick the release commit into master.
```
git checkout master && git pull && git cherry-pick release && git push
```
2018-04-24 14:51:26 +02:00
#### DEB with dch on macOS
```
docker run -v `pwd`:/mnt/packaging -ti ubuntu:bionic bash
2018-04-24 14:51:26 +02:00
apt-get update && apt-get install git ubuntu-dev-tools vim -y
2018-04-24 14:51:26 +02:00
cd /mnt/packaging
2018-04-24 14:51:26 +02:00
git config --global user.name "Michael Friedrich"
git config --global user.email "michael.friedrich@icinga.com"
VERSION=2.10.4
./dch $VERSION-1 "Update to $VERSION"
2018-04-24 14:51:26 +02:00
```
2015-04-20 16:43:17 +02:00
2018-04-24 14:51:26 +02:00
## Build Server <a id="build-server"></a>
2015-04-20 16:43:17 +02:00
2016-12-14 15:22:29 +01:00
* Verify package build changes for this version.
* Test the snapshot packages for all distributions beforehand.
2016-04-20 18:35:19 +02:00
* Build the newly created Git tag for Debian/RHEL/SuSE.
* Wait until all jobs have passed and then publish them one by one with `allow_release`
* Build the newly created Git tag for Windows: `refs/tags/v2.10.0` as source and `v2.10.0` as package name.
2015-12-07 16:29:19 +01:00
2018-04-24 14:51:26 +02:00
## Release Tests <a id="release-tests"></a>
2015-06-17 14:22:59 +02:00
2016-04-20 18:35:19 +02:00
* Test DB IDO with MySQL and PostgreSQL.
2015-04-20 16:43:17 +02:00
* Provision the vagrant boxes and test the release packages.
* Test the [setup wizard](https://packages.icinga.com/windows/) inside a Windows VM.
2016-04-20 18:35:19 +02:00
* Start a new docker container and install/run icinga2.
2015-06-17 14:22:59 +02:00
### CentOS
2015-06-17 14:22:59 +02:00
```
docker run -ti centos:latest bash
2015-07-08 12:55:50 +02:00
yum -y install https://packages.icinga.com/epel/icinga-rpm-release-7-latest.noarch.rpm
yum -y install icinga2
icinga2 daemon -C
```
2015-06-17 14:22:59 +02:00
### Debian
```
docker run -ti debian:stretch bash
apt-get update && apt-get install -y wget curl gnupg apt-transport-https
DIST=$(awk -F"[)(]+" '/VERSION=/ {print $2}' /etc/os-release); \
echo "deb https://packages.icinga.com/debian icinga-${DIST} main" > \
/etc/apt/sources.list.d/${DIST}-icinga.list
echo "deb-src https://packages.icinga.com/debian icinga-${DIST} main" >> \
/etc/apt/sources.list.d/${DIST}-icinga.list
curl https://packages.icinga.com/icinga.key | apt-key add -
apt-get -y install icinga2
icinga2 daemon
```
2018-04-24 14:51:26 +02:00
## GitHub Release <a id="github-release"></a>
2015-04-20 16:43:17 +02:00
2018-04-24 14:51:26 +02:00
Create a new release for the newly created Git tag: https://github.com/Icinga/icinga2/releases
2015-04-20 16:43:17 +02:00
> Hint: Choose [tags](https://github.com/Icinga/icinga2/tags), pick one to edit and
> make this a release. You can also create a draft release.
The release body should contain a short changelog, with links
into the roadmap, changelog and blogpost.
2018-04-24 14:51:26 +02:00
## Chocolatey <a id="chocolatey"></a>
Navigate to the git repository on your Windows box which
already has chocolatey installed. Pull/checkout the release.
Create the nupkg package (or use the one generated on https://packages.icinga.com/windows):
```
cpack
```
Fetch the API key from https://chocolatey.org/account and use the `choco push`
command line.
```
choco apikey --key xxx --source https://push.chocolatey.org/
choco push Icinga2-v2.10.0.nupkg --source https://push.chocolatey.org/
```
2018-04-24 14:51:26 +02:00
## Post Release <a id="post-release"></a>
### Online Documentation <a id="online-documentation"></a>
2015-04-20 16:43:17 +02:00
> Only required for major releases.
Navigate to `puppet-customer/icinga.git` and do the following steps:
#### Testing
```
git checkout testing && git pull
vim files/var/www/docs/config/icinga2-latest.yml
git commit -av -m "icinga-web: Update docs for Icinga 2"
git push
```
SSH into the webserver and do a manual Puppet dry run with the testing environment.
```
puppet agent -t --environment testing --noop
```
Once succeeded, continue with production deployment.
#### Production
```
git checkout master && git pull
git merge testing
git push
```
SSH into the webserver and do a manual Puppet run from the production environment (default).
```
puppet agent -t
```
2015-04-20 16:43:17 +02:00
#### Manual Generation
SSH into the webserver or ask @bobapple.
```
cd /usr/local/icinga-docs-tools && ./build-docs.rb -c /var/www/docs/config/icinga2-latest.yml
```
2018-04-24 14:51:26 +02:00
### Announcement <a id="announcement"></a>
2015-04-20 16:43:17 +02:00
* Create a new blog post on [icinga.com/blog](https://icinga.com/blog) including a featured image
* Create a release topic on [community.icinga.com](https://community.icinga.com)
* Release email to net-tech & team
2015-12-07 16:29:19 +01:00
2018-04-24 14:51:26 +02:00
### Project Management <a id="project-management"></a>
2015-12-07 16:29:19 +01:00
2017-08-02 11:55:05 +02:00
* Add new minor version on [GitHub](https://github.com/Icinga/icinga2/milestones).