2015-12-07 16:29:19 +01:00
|
|
|
# Release Workflow
|
2015-04-20 16:43:17 +02:00
|
|
|
|
2016-08-30 15:13:06 +02:00
|
|
|
Specify the release version.
|
|
|
|
|
2017-08-03 09:21:20 +02:00
|
|
|
```
|
2017-11-09 12:32:32 +01:00
|
|
|
VERSION=2.7.2
|
2017-08-03 09:21:20 +02:00
|
|
|
```
|
2016-08-30 15:13:06 +02:00
|
|
|
|
2015-12-07 16:29:19 +01:00
|
|
|
## Issues
|
|
|
|
|
2017-01-17 16:50:22 +01:00
|
|
|
Check issues at https://github.com/Icinga/icinga2
|
2015-03-20 13:30:55 +01:00
|
|
|
|
2016-04-20 18:35:19 +02:00
|
|
|
## Backport Commits
|
|
|
|
|
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
|
|
|
|
2015-06-19 09:41:51 +02:00
|
|
|
## Authors
|
|
|
|
|
2015-03-20 13:30:55 +01:00
|
|
|
Update the [.mailmap](.mailmap) and [AUTHORS](AUTHORS) files:
|
|
|
|
|
2017-08-03 09:21:20 +02:00
|
|
|
```
|
|
|
|
git checkout master
|
2017-11-09 12:32:32 +01:00
|
|
|
git log --use-mailmap | grep '^Author:' | cut -f2- -d' ' | sort | uniq > AUTHORS
|
2017-08-03 09:21:20 +02:00
|
|
|
```
|
2015-03-20 13:30:55 +01:00
|
|
|
|
2015-06-19 09:41:51 +02:00
|
|
|
## Version
|
|
|
|
|
2017-11-09 12:32:32 +01:00
|
|
|
Update the version in the spec file:
|
2015-06-19 09:41:51 +02:00
|
|
|
|
2017-08-03 09:21:20 +02:00
|
|
|
```
|
|
|
|
gsed -i "s/Version: .*/Version: $VERSION/g" icinga2.spec
|
|
|
|
```
|
2016-08-30 15:13:06 +02:00
|
|
|
|
2015-06-19 09:41:51 +02:00
|
|
|
## Changelog
|
2015-03-20 13:30:55 +01:00
|
|
|
|
2017-08-02 11:55:05 +02:00
|
|
|
Update the [CHANGELOG.md](CHANGELOG.md) file.
|
2015-06-18 15:53:08 +02:00
|
|
|
|
2017-08-03 09:21:20 +02:00
|
|
|
Export these environment variables:
|
|
|
|
|
|
|
|
```
|
|
|
|
export ICINGA_GITHUB_AUTH_USERNAME='user'
|
|
|
|
export ICINGA_GITHUB_AUTH_TOKEN='token'
|
|
|
|
export ICINGA_GITHUB_PROJECT='icinga/icinga2'
|
|
|
|
```
|
|
|
|
|
|
|
|
Run the script which updates the [CHANGELOG.md](CHANGELOG.md) file.
|
|
|
|
|
|
|
|
```
|
|
|
|
./changelog.py
|
|
|
|
git diff
|
|
|
|
```
|
|
|
|
|
2015-06-19 09:41:51 +02:00
|
|
|
## Git Tag
|
|
|
|
|
2015-03-20 13:30:55 +01:00
|
|
|
Commit these changes to the "master" branch:
|
|
|
|
|
2017-08-03 09:21:20 +02:00
|
|
|
```
|
|
|
|
git commit -v -a -m "Release version $VERSION"
|
|
|
|
```
|
2015-03-20 13:30:55 +01:00
|
|
|
|
2017-11-09 13:30:33 +01:00
|
|
|
For minor releases: Cherry-pick this commit into the "support" branch:
|
|
|
|
|
|
|
|
```
|
|
|
|
git checkout support/2.7
|
|
|
|
git cherry-pick master
|
|
|
|
```
|
2015-03-20 13:30:55 +01:00
|
|
|
|
|
|
|
Create a signed tag (tags/v<VERSION>) on the "master" branch (for major
|
|
|
|
releases) or the "support" branch (for minor releases).
|
|
|
|
|
|
|
|
GB:
|
|
|
|
|
2017-08-03 09:21:20 +02:00
|
|
|
```
|
|
|
|
git tag -u EE8E0720 -m "Version $VERSION" v$VERSION
|
|
|
|
```
|
2015-03-20 13:30:55 +01:00
|
|
|
|
|
|
|
MF:
|
|
|
|
|
2017-08-03 09:21:20 +02:00
|
|
|
```
|
|
|
|
git tag -u D14A1F16 -m "Version $VERSION" v$VERSION
|
|
|
|
```
|
2015-03-20 13:30:55 +01:00
|
|
|
|
2017-11-09 12:32:32 +01:00
|
|
|
NH:
|
|
|
|
|
|
|
|
```
|
|
|
|
git tag -u 630F89D9 -m "Version $VERSION" v$VERSION
|
|
|
|
```
|
2017-11-09 13:30:33 +01:00
|
|
|
|
|
|
|
Push the tag:
|
2015-03-20 13:30:55 +01:00
|
|
|
|
2017-08-03 09:21:20 +02:00
|
|
|
```
|
|
|
|
git push --tags
|
|
|
|
```
|
2015-03-20 13:30:55 +01:00
|
|
|
|
|
|
|
For major releases: Create a new "support" branch:
|
|
|
|
|
2017-08-03 09:21:20 +02:00
|
|
|
```
|
|
|
|
git checkout master
|
|
|
|
git checkout -b support/2.7
|
|
|
|
git push -u origin support/2.7
|
|
|
|
```
|
2015-07-15 12:38:15 +02:00
|
|
|
|
2015-10-22 13:41:31 +02:00
|
|
|
For minor releases: Push the support branch, cherry-pick the release commit
|
|
|
|
into master and merge the support branch:
|
2015-07-15 12:38:15 +02:00
|
|
|
|
2017-08-03 09:21:20 +02:00
|
|
|
```
|
|
|
|
git push -u origin support/2.7
|
|
|
|
git checkout master
|
|
|
|
git cherry-pick support/2.7
|
|
|
|
git merge --strategy=ours support/2.7
|
|
|
|
git push origin master
|
|
|
|
```
|
2015-03-20 13:30:55 +01:00
|
|
|
|
2015-04-20 16:43:17 +02:00
|
|
|
# External Dependencies
|
|
|
|
|
|
|
|
## Build Server
|
|
|
|
|
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.
|
|
|
|
* Build the newly created Git tag for Windows.
|
2015-12-07 16:29:19 +01:00
|
|
|
|
2016-04-20 18:35:19 +02:00
|
|
|
## Release Tests
|
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.
|
2017-04-06 22:20:20 +02:00
|
|
|
* 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
|
|
|
|
|
|
|
Example for CentOS7:
|
|
|
|
|
2017-08-07 10:30:00 +02:00
|
|
|
```
|
|
|
|
docker run -ti centos:latest bash
|
2015-07-08 12:55:50 +02:00
|
|
|
|
2017-08-07 10:30:00 +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
|
|
|
|
2015-11-14 06:10:44 +01:00
|
|
|
## GitHub Release
|
2015-04-20 16:43:17 +02:00
|
|
|
|
2015-11-14 06:10:44 +01:00
|
|
|
Create a new release for the newly created Git tag.
|
2015-04-20 16:43:17 +02:00
|
|
|
https://github.com/Icinga/icinga2/releases
|
|
|
|
|
2016-04-21 14:03:42 +02:00
|
|
|
## Chocolatey
|
|
|
|
|
|
|
|
Navigate to the git repository on your Windows box which
|
|
|
|
already has chocolatey installed. Pull/checkout the release.
|
|
|
|
|
|
|
|
Create the nupkg package:
|
|
|
|
|
2017-08-03 09:21:20 +02:00
|
|
|
```
|
|
|
|
cpack
|
|
|
|
```
|
2016-04-21 14:03:42 +02:00
|
|
|
|
|
|
|
Install the created icinga2 package locally:
|
|
|
|
|
2017-08-03 09:21:20 +02:00
|
|
|
```
|
|
|
|
choco install icinga2 -version 2.7.0 -fdv "%cd%" -source "'%cd%;https://chocolatey.org/api/v2/'"
|
|
|
|
```
|
2016-04-21 14:03:42 +02:00
|
|
|
|
|
|
|
Upload the package to [chocolatey](https://chocolatey.org/packages/upload).
|
|
|
|
|
2015-04-20 16:43:17 +02:00
|
|
|
## Online Documentation
|
|
|
|
|
2017-11-09 13:30:33 +01:00
|
|
|
Ask @bobapple to update the documentation at docs.icinga.com.
|
2015-04-20 16:43:17 +02:00
|
|
|
|
|
|
|
## Announcement
|
|
|
|
|
2016-12-14 15:22:29 +01:00
|
|
|
* Create a new blog post on www.icinga.com/blog
|
2017-04-06 22:20:20 +02:00
|
|
|
* Social media: [Twitter](https://twitter.com/icinga), [Facebook](https://www.facebook.com/icinga), [G+](https://plus.google.com/+icinga), [Xing](https://www.xing.com/communities/groups/icinga-da4b-1060043), [LinkedIn](https://www.linkedin.com/groups/Icinga-1921830/about)
|
2015-12-07 16:29:19 +01:00
|
|
|
* Update IRC channel topic
|
|
|
|
|
|
|
|
# After the release
|
|
|
|
|
2017-08-02 11:55:05 +02:00
|
|
|
* Add new minor version on [GitHub](https://github.com/Icinga/icinga2/milestones).
|
|
|
|
* Close the released version on [GitHub](https://github.com/Icinga/icinga2/milestones).
|