Skip to content

Commit

Permalink
Update RELEASE docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Friedrich committed Sep 19, 2019
1 parent e9b8fc2 commit 60f8af7
Showing 1 changed file with 89 additions and 92 deletions.
181 changes: 89 additions & 92 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
- [5. Package Builds](#package-builds)
- [5.1. RPM Packages](#rpm-packages)
- [5.2. DEB Packages](#deb-packages)
- [6. Build Server](#build-server)
- [6. Build Server](#build-infrastructure)
- [7. Release Tests](#release-tests)
- [8. GitHub Release](#github-release)
- [9. Chocolatey](#chocolatey)
Expand All @@ -26,7 +26,7 @@
Specify the release version.

```
VERSION=2.11.0-rc1
VERSION=2.11.0
```

Add your signing key to your Git configuration file, if not already there.
Expand Down Expand Up @@ -68,17 +68,12 @@ sed -i "s/Version: .*/Version: $VERSION/g" VERSION

## Changelog <a id="changelog"></a>

Link to the milestone and closed=1 as filter.
Choose the most important issues and summarize them in multiple groups/paragraphs. Provide links to the mentioned
issues/PRs. At the start include a link to the milestone's closed issues.

Manually update the best of collected from the
milestone description.

## Git Tag <a id="git-tag"></a>

> **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"
```
Expand Down Expand Up @@ -106,145 +101,141 @@ git checkout -b support/2.12
git push -u origin support/2.12
```

**For minor releases:** Push the support branch, cherry-pick the release commit
into master and merge the support branch:

## Package Builds <a id="package-builds"></a>

```
git push -u origin support/2.11
git checkout master
git cherry-pick support/2.11
git merge --strategy=ours support/2.11
git push origin master
mkdir $HOME/dev/icinga/packaging
cd $HOME/dev/icinga/packaging
```

## Package Builds <a id="package-builds"></a>

### RPM Packages <a id="rpm-packages"></a>

```
git clone git@github.com:icinga/rpm-icinga2.git && cd rpm-icinga2
git clone git@git.icinga.com:icinga/rpm-icinga2.git && cd rpm-icinga2
```

#### Branch Workflow

**Major releases** are branched off `master`.
### DEB Packages <a id="deb-packages"></a>

```
git checkout master && git pull
git clone [email protected]:packaging/deb-icinga2.git && cd deb-icinga2
```

**Bugfix releases** are created in the `release` branch and later merged to master.
#### Raspbian Packages

```
git checkout release && git pull
git clone [email protected]:icinga/raspbian-icinga2.git && cd raspbian-icinga2
```

#### Release Commit

Set the `Version`, `Revision` and `changelog` inside the spec file.
### Windows Packages

```
VERSION=2.11.0-rc1
git clone [email protected]:icinga/windows-icinga2.git && cd windows-icinga2
```

sed -i "s/Version: .*/Version: $VERSION/g" icinga2.spec

vim icinga2.spec
### Branch Workflow

%changelog
* Tue Mar 19 2019 Michael Friedrich <[email protected]> 2.10.4-1
- Update to 2.10.4
```
Checkout `master` and create a new branch.

```
git commit -av -m "Release $VERSION-1"
git push
```
* For releases use x.x[.x] as branch name (e.g. 2.11 or 2.11.1)
* For releases with revision use x.x.x-n (e.g. 2.11.0-2)

**Note for major releases**: Update release branch to latest.

```
git checkout release && git pull && git merge master && git push
```
### Switch Build Type

**Note for minor releases**: Cherry-pick the release commit into master.
Edit file `.gitlab-ci.yml` and comment variable `ICINGA_BUILD_TYPE` out.

```yaml
variables:
...
#ICINGA_BUILD_TYPE: snapshot
...
```
git checkout master && git pull && git cherry-pick release && git push
```


### DEB Packages <a id="deb-packages"></a>
Commit the change.

```
git clone [email protected]:icinga/deb-icinga2.git && cd deb-icinga2
```
git commit -av -m "Switch build type for $VERSION-1"
#### Branch Workflow
#### RPM Release Preparations
**Major releases** are branched off `master`.
Set the `Version`, `revision` and `%changelog` inside the spec file:
```
git checkout master && git pull
```
sed -i "s/Version:.*/Version: $VERSION/g" icinga2.spec

**Bugfix releases** are created in the `release` branch and later merged to master.
vim icinga2.spec

```
git checkout release && git pull
%changelog
* Thu Sep 19 2019 Michael Friedrich <[email protected]> 2.11.0-1
- Update to 2.11.0
```
#### Release Commit
#### DEB and Raspbian Release Preparations
Set the `Version`, `Revision` and `changelog` by using the `dch` helper.
Update file `debian/changelog` and add at the beginning:
```
VERSION=2.10.4
icinga2 (2.11.0-1) icinga; urgency=medium

./dch $VERSION-1 "Update to $VERSION"
```
* Release 2.11.0

-- Michael Friedrich <[email protected]> Thu, 19 Sep 2019 10:50:31 +0200
```
git commit -av -m "Release $VERSION-1"
git push
```
**Note for major releases**: Update release branch to latest.
### Release Commit
Commit the changes and push the branch.
```
git checkout release && git pull && git merge master && git push
git commit -av -m "Release $VERSION-1"
git push origin 2.11
```
**Note for minor releases**: Cherry-pick the release commit into master.
GitLab will now build snapshot packages based on the tag `v2.11.0` of Icinga 2.
```
git checkout master && git pull && git cherry-pick release && git push
```
### Package Tests
#### DEB with dch on macOS
In order to test the created packages you can download a job's artifacts:
```
docker run -v `pwd`:/mnt/packaging -ti ubuntu:bionic bash
Visit [git.icinga.com](https://git.icinga.com/packaging/rpm-icinga2)
and navigate to the respective pipeline under `CI / CD -> Pipelines`.
apt-get update && apt-get install git ubuntu-dev-tools vim -y
cd /mnt/packaging
There click on the job you want to download packages from.
git config --global user.name "Michael Friedrich"
git config --global user.email "[email protected]"
The job's output appears. On the right-hand sidebar you can browse its artifacts.
VERSION=2.11.0-rc1
Once there, navigate to `build/RPMS/noarch` where you'll find the packages.
./dch $VERSION-1 "Update to $VERSION"
### Release Packages
To build release packages and upload them to [packages.icinga.com](https://packages.icinga.com)
tag the release commit and push it.
```
git tag -s 2.11.0-1
git push origin 2.11.0-1
```
Now cherry pick the release commit to `master` so that the changes are transferred back to it.
**Attention**: Only the release commit. *NOT* the one switching the build type!
## Build Infrastructure <a id="build-infrastructure"></a>
## Build Server <a id="build-server"></a>
https://git.icinga.com/packaging/rpm-icinga2/pipelines
https://git.icinga.com/packaging/deb-icinga2/pipelines
https://git.icinga.com/packaging/windows-icinga2/pipelines
https://git.icinga.com/packaging/raspbian-icinga2/pipelines
* 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.
* 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.
Once the release repository tags are pushed, release builds
are triggered and automatically published to packages.icinga.com
## Release Tests <a id="release-tests"></a>
Expand All @@ -259,28 +250,34 @@ VERSION=2.11.0-rc1
docker run -ti centos:latest bash

yum -y install https://packages.icinga.com/epel/icinga-rpm-release-7-latest.noarch.rpm
yum -y install epel-release
yum -y install icinga2
icinga2 daemon -C
```
### Debian
### Ubuntu
```
docker run -ti debian:stretch bash
docker run -ti ubuntu:bionic bash

apt-get update
apt-get -y install apt-transport-https wget gnupg

apt-get update && apt-get install -y wget curl gnupg apt-transport-https
wget -O - https://packages.icinga.com/icinga.key | apt-key add -

DIST=$(awk -F"[)(]+" '/VERSION=/ {print $2}' /etc/os-release); \
echo "deb https://packages.icinga.com/debian icinga-${DIST} main" > \
. /etc/os-release; if [ ! -z ${UBUNTU_CODENAME+x} ]; then DIST="${UBUNTU_CODENAME}"; else DIST="$(lsb_release -c| awk '{print $2}')"; fi; \
echo "deb https://packages.icinga.com/ubuntu icinga-${DIST} main" > \
/etc/apt/sources.list.d/${DIST}-icinga.list
echo "deb-src https://packages.icinga.com/debian icinga-${DIST} main" >> \
echo "deb-src https://packages.icinga.com/ubuntu icinga-${DIST} main" >> \
/etc/apt/sources.list.d/${DIST}-icinga.list

curl https://packages.icinga.com/icinga.key | apt-key add -
apt-get update

apt-get -y install icinga2
icinga2 daemon
icinga2 daemon -C
```
## GitHub Release <a id="github-release"></a>
Create a new release for the newly created Git tag: https://github.com/Icinga/icinga2/releases
Expand Down

0 comments on commit 60f8af7

Please sign in to comment.