Project

General

Profile

Release Process » History » Version 199

Tomer Brisker, 07/16/2018 02:32 PM

1 1 Dominic Cleal
h1. Release Process
2
3 153 Dominic Cleal
{{toc}}
4
5 155 Dominic Cleal
For each major release (i.e. not patch releases), the project selects a release manager who's responsible for taking the develop branch through to release.  Their high level tasks and policies are described on [[Release_Management]], while this document covers specific steps (down to individual commands) that need to be run at each step of the release.
6 1 Dominic Cleal
7
Please amend these lists as you see free, and as you find what works and what doesn't work.
8
9 154 Dominic Cleal
These examples are all based around a 1.2 series release, so any reference to "1.2" should be replaced by the current release, "1.1" by your previous release, and "1.3" by the next release.
10
11 51 Lukas Zapletal
h2. Near-end of development phase
12 1 Dominic Cleal
13 153 Dominic Cleal
# Announce upcoming branching to foreman-dev ("example":https://groups.google.com/d/msg/foreman-dev/tXNWR2QiUdw/gmkdp7pXKAAJ) a month before
14 1 Dominic Cleal
# Change @$latest@ and @$next@ parameters on @web@ class to point to the new version numbers (see @foreman-infra/puppet/modules/web/manifests/init.pp@)
15 154 Dominic Cleal
# File a new release tracker on theforeman.org for "Foreman 1.2 manual" ("example":https://github.com/theforeman/theforeman.org/issues/494)
16 1 Dominic Cleal
# Refresh unattended templates from the community-templates to Foreman core, by running @script/sync_templates.sh@
17
# Create a new branch in community-templates for upcoming Foreman release (e.g. 1.2-stable)
18 154 Dominic Cleal
# Add new languages that are at a "reasonable completion on Transifex":https://www.transifex.com/foreman/foreman/foreman/ to *develop*
19 1 Dominic Cleal
# Generate a release GPG key using [[GPG_Keys]]
20
#* publish to keyserver
21 186 Ondřej Pražák
#* security.md on the website, add public key fingerprint to static/keys
22 112 Dominic Cleal
#* create @releases/1.2/RPM-GPG-KEY-foreman@ on yum.theforeman.org
23 153 Dominic Cleal
# Add release to "Found in release" list in redmine: http://projects.theforeman.org/custom_fields/4/edit
24 196 Lukas Zapletal
# Ask plugin authors to start extracting i18n strings and pushing the changes into develop/master git branches so Transiflex can pick it up
25 153 Dominic Cleal
26
h2. Branching for series
27
28 1 Dominic Cleal
When ready to branch for release candidates.
29 153 Dominic Cleal
30
h3. Package build systems
31 55 Lukas Zapletal
32 194 Ondřej Pražák
# Clone tags and create build targets in "Koji":http://koji.katello.org/koji using koji/copy-tags-commands.sh in foreman-packaging/rpm/develop or use the tool_belt
33 167 Daniel Lobato Garcia
#* Make sure you have a kkoji section in ~/.koji/config , you can find instructions in http://projects.theforeman.org/projects/foreman/wiki/Koji
34
#* This generates commands that create foreman-1.2-rhel7 etc. as clones of nightly tags and foreman-plugins-1.2-rhel7 etc. with inheritance from the new Foreman tags
35 165 Dominic Cleal
#* Untag all git/nightly builds: @for t in foreman-1.2-rhel7 foreman-1.2-nonscl-rhel7 foreman-1.2-fedora24; do kkoji list-tagged $t  | grep git | awk '{print $1}' | xargs kkoji untag-build  $t; done@
36 1 Dominic Cleal
# Create mash scripts and configuration on Koji
37 110 Dominic Cleal
#* copy /usr/local/bin/foreman-mash-split-1.*.py to foreman-mash-split-1.2.py, update the OSes and version numbers at the bottom
38 64 Lukas Zapletal
#* copy /etc/mash/foreman-1.*-*.mash and foreman-plugins-1.*-*.mash, update the version numbers, add/remove files for OS changes, set GPG key ID and ensure strict_keys=True
39
# Add new plugin tags (i.e. 1.2) to Koji plugins mash script (foreman-mash-split-plugins.py), remove old ones (keep three)
40 163 Dominic Cleal
# Add version (1.2) to these jobs in axes and/or combination filters, remove old ones (keep three)
41 174 Ondřej Pražák
## "foremanPluginsRelease":https://github.com/theforeman/foreman-infra/blob/master/puppet/modules/jenkins_job_builder/files/theforeman.org/pipelines/release/foremanPluginsRelease.groovy
42 188 Ondřej Pražák
## "packaging_build_deb_coreproject":https://github.com/theforeman/foreman-infra/blob/master/puppet/modules/jenkins_job_builder/files/theforeman.org/yaml/jobs/packaging_build_deb_coreproject.yaml
43
## "packaging_build_deb_dependency":https://github.com/theforeman/foreman-infra/blob/master/puppet/modules/jenkins_job_builder/files/theforeman.org/yaml/jobs/packaging_build_deb_dependency.yaml
44 163 Dominic Cleal
## "release_test":https://github.com/theforeman/foreman-infra/blob/master/puppet/modules/jenkins_job_builder/files/theforeman.org/yaml/jobs/release_test.yaml
45
## "release_push_deb":http://ci.theforeman.org/job/release_push_deb/
46 1 Dominic Cleal
## "release_push_rpm":http://ci.theforeman.org/job/release_push_rpm/
47 140 Dominic Cleal
# Clone Debian nightly repos to 1.2 using "copy/freight instructions":http://projects.theforeman.org/projects/foreman/wiki/Debian_Packaging#Project-sources
48 164 Dominic Cleal
# Edit "foreman-packaging's PR template":https://github.com/theforeman/foreman-packaging/blob/master/.github/PULL_REQUEST_TEMPLATE.md to add 1.2 and remove the old release
49 8 Dominic Cleal
50 153 Dominic Cleal
h3. Main code repos
51 1 Dominic Cleal
52 40 Dominic Cleal
# Make releases of installer modules, usually new minor or major versions
53 169 Daniel Lobato Garcia
## Currently puppet-puppet, puppet-foreman, puppet-dhcp, puppet-dns, puppet-foreman_proxy, puppet-tftp, puppet-git
54 61 Lukas Zapletal
# In foreman *develop* run @make -C locale tx-update@
55 1 Dominic Cleal
# In foreman, smart-proxy, foreman-installer and foreman-selinux branch *develop* to *1.2-stable* (*from this point* cherry-picks into this branch only from this point using: @git cherry-pick -x SHA@)
56
# In foreman-installer, branch *1.2-stable*,
57 197 Ewoud Kohl van Wijngaarden
## run @bundle exec rake pin_modules@ to change Puppetfile from git references to specific version ranges (e.g. @>= 1.3.1 < 1.4.0@)
58
## run @sed -i '/Puppetfile.lock/d' .gitignore@ to remove Puppetfile.lock from .gitignore
59
## run @librarian-puppet install@
60
## commit Puppetfile, Puppetfile.lock and .gitignore changes
61 70 Dominic Cleal
# In foreman-packaging for RPMs:
62 132 Dominic Cleal
## branch *rpm/develop* to *rpm/1.2*
63
## on *rpm/1.2*
64
### in rel-eng/releasers.conf and rel-eng/tito.props, replace "nightly" with "1.2"
65
### change @foreman/foreman.repo@ URLs from @/nightly@ to @/releases/1.2@, change "nightly" in name to "1.2" and enable gpg checking
66
### change @foreman/foreman-plugins.repo@ URLs from @/plugins/nightly@ to @/plugins/1.2@, change "nightly" in name to "1.2" and DO NOT enable GPG checking
67 127 Dominic Cleal
### update @foreman/foreman.gpg@ with the release public key
68
## on *rpm/develop*
69 142 Dominic Cleal
### change foreman/foreman-proxy/foreman-installer/foreman-selinux version to 1.3.0, add %changelog entry
70 122 Dominic Cleal
### change tag_suffix to @.fm1_3@ in rel-eng/tito.props, and rel-eng/releasers.conf
71
# In foreman-packaging for debs:
72
## on *deb/develop*, update debian/*/*/changelog with entries from 1.1, commit with message "Sync 1.1.x releases into changelogs"
73 144 Dominic Cleal
## branch *deb/develop* to *deb/1.2*
74 100 Dominic Cleal
## on *deb/develop*, run @scripts/changelog.rb -v 1.3.0-1 -m "Bump changelog to 1.3.0 to match VERSION" debian/*/*/changelog@ 
75 106 Dominic Cleal
# In foreman *develop* commit with message "Bump version to 1.3-develop":
76 161 Dominic Cleal
## change VERSION to 1.3.0-develop
77
## change package.json version field to 1.3.0
78 1 Dominic Cleal
## run @extras/changelog@
79
# In smart-proxy *develop* commit with message "Bump version to 1.3-develop":
80
## change VERSION to 1.3.0-develop
81
## run @extra/changelog@
82
# In foreman-selinux *develop* commit with message "Bump version to 1.3-develop":
83
## change VERSION to 1.3.0-develop
84
## run @extras/changelog@
85
# In foreman-installer *develop* commit with message "Bump version to 1.3-develop":
86 161 Dominic Cleal
## change VERSION to 1.3.0-develop
87 162 Dominic Cleal
88
h3. Other systems
89
90
# Create release schedule page for next version (1.3) linked from [[Development_Resources]]
91 198 Tomer Brisker
# Add next version number (1.3.0) to Redmine under "Releases":https://projects.theforeman.org/projects/foreman/settings/versions
92 162 Dominic Cleal
# Add first patch release (1.2.1) to Redmine in the same way
93 195 Lukas Zapletal
# Update foreman-dev with "translations status":https://www.transifex.com/projects/p/foreman/ to encourage 100% translations before release
94
# Announce string freeze date on discourse and send announcement via https://www.transifex.com/foreman/foreman/announcements/
95 191 Ondřej Pražák
# Create test_1_2_stable.yaml and test_proxy_1_2_stable.yaml for JJB in foreman-infra, remove the oldest version to keep last 3
96 154 Dominic Cleal
# Ensure current Foreman deprecations for the next release are removed in *develop*
97 1 Dominic Cleal
98 187 Eric Helms
h3. Rails for RPMs
99
100
The Rails stack is built as a separate SCL in Copr but then mirrored for a given Foreman version on yum.theforeman.org. When branching, a version should be created for the Foreman version being released:
101
102 192 Eric Helms
<pre>
103 187 Eric Helms
# ssh yum.theforeman.org
104
# cd /var/www/vhosts/yum/htdocs/rails/
105
# cp -rf foreman-nightly foreman-<version>
106 192 Eric Helms
</pre>
107 187 Eric Helms
108
The foreman-release-scl RPM then needs updating to point at this new repository in SCL repo file.
109 192 Eric Helms
110
Koji needs to be updated to include a new external repository pointing to this new rails repository for builds.
111
112
113
  * ssh root@koji.katello.org
114
  * edit /etc/mrepo.conf and add foreman-<version> entry for new version
115 199 Tomer Brisker
  * Now run: <pre>mrepo -ug -f -v foreman-rails-<version></pre>
116 192 Eric Helms
  * Go back to developer machine
117
  * Add the new external repo: `koji add-external-repo foreman-rails-<version>-rhel-7 file:///mnt/koji/external-repos/www/foreman-rails-<version>-$arch/RPMS.ror51/`
118 187 Eric Helms
119 1 Dominic Cleal
h2. Preparing a release
120
121 100 Dominic Cleal
Version numbers for release candidates start with "1.2.0-RC1" (always hyphenated).  The first release after RC would be "1.2.0".  Change examples below as appropriate.
122
123 1 Dominic Cleal
h3. Writing release notes
124
125 179 Ondřej Pražák
# Copy website manual content ("theforeman.org repo":http://github.com/theforeman/theforeman.org) from previous version to this version ("example":https://github.com/theforeman/theforeman.org/pull/43)
126
#* add version number to documentation.md dropdown menu
127 153 Dominic Cleal
# Update manual if applicable for any additional installation steps
128
# Draft release notes in markdown ("example":https://gist.github.com/domcleal/5567450), with these sections (and do not use personal pronouns):
129
## Headline features: half a dozen important features with a few sentences description each
130
## Upgrade notes: all important notices that users must be aware of before upgrading
131 176 Ondřej Pražák
## Release notes: bullet point list by category of most changes, excluding bug fixes for issues introduced during the release cycle, include link to bug numbers. You can auto-generate changes using a script from "theforeman.org":https://github.com/theforeman/theforeman.org/blob/gh-pages/scripts/release_notes.rb or use the 'changelog' command in "tool_belt":https://github.com/theforeman/tool_belt
132 1 Dominic Cleal
## CLI release notes are taken from the hammer-cli and hammer-cli-foreman changelogs
133
## Link to installer changelogs and note versions being used
134 179 Ondřej Pražák
# Get the apipie doc and place it in api/$release_num
135
# Change links in _includes/version.html for 'latest' and 'latest stable'
136 153 Dominic Cleal
137
138
h3. Preparing code
139
140
# Request Hammer CLI releases from maintainers if desired
141 132 Dominic Cleal
# Make patch releases of installer modules that have important changes
142 1 Dominic Cleal
#* Branch to MAJ.MIN-stable if recent changes to the module aren't suitable for patch (x.y.z) release
143 152 Dominic Cleal
# Compare tagged packages in nightly vs. release koji tag and re-tag any updated dependencies that are required
144
# Add a new "Redmine release":http://projects.theforeman.org/rb/releases/foreman for the next minor, unless the series is EOL
145
# Remove/change release field for any open Redmine tickets assigned to the release still (next minor, unset it or reject)
146 139 Dominic Cleal
# Change Redmine release state to _Closed_
147
# List all issues targeted at the release, order by Closed date ascending and use @git cherry-pick -x@ to cherry pick from develop to *1.2-stable* branch
148 1 Dominic Cleal
# Clone "tool_belt":https://github.com/theforeman/tool_belt (foreman branch) and run:
149
## @./tools.rb setup-environment configs/foreman_12.yaml@
150
## @./tools.rb cherry-picks --version 1.2.0 configs/foreman_12.yaml@
151 140 Dominic Cleal
## Verify tickets in the @cherry_picks_1.2.0@ file are accounted for or additional cherry pick them
152
153
h2. Tagging a release
154 1 Dominic Cleal
155 180 Ondřej Pražák
# In foreman *1.2-stable*:
156
## run @make -C locale tx-update@ (if Transifex has not switched to the next major release yet, usually after .2)
157
## run @script/sync_templates.sh@
158 1 Dominic Cleal
## change VERSION to 1.2.0
159
## change package.json version field to 1.2.0
160 161 Dominic Cleal
## run @extras/changelog@
161 180 Ondřej Pražák
## commit with message "Release 1.2.0"
162 104 Dominic Cleal
# In smart-proxy *1.2-stable* commit with message "Release 1.2.0":
163 1 Dominic Cleal
## change VERSION to 1.2.0
164 115 Dominic Cleal
## run @extra/changelog@
165 109 Dominic Cleal
# In foreman-selinux *1.2-stable* commit with message "Release 1.2.0":
166 1 Dominic Cleal
## change VERSION to 1.2.0
167
## run extras/changelog
168 115 Dominic Cleal
# In foreman-installer *1.2-stable* commit with message "Release 1.2.0":
169
## change VERSION to 1.2.0
170 168 Daniel Lobato Garcia
# Before tagging, make sure the test_xxxx_stable versions of each of the projects are green in http://ci.theforeman.org/
171 52 Dominic Cleal
# Tag commits in foreman, smart-proxy, foreman-installer and foreman-selinux: @git tag -m "Release 1.2.0" 1.2.0@
172 1 Dominic Cleal
# Push to the project repos: @git push project && git push project 1.2.0@
173
# Run the Jenkins "Release Pipeline":http://ci.theforeman.org/view/Release%20pipeline/ to create tarballs
174 115 Dominic Cleal
# Verify tarballs are present on downloads.theforeman.org, download, sign and upload detached signatures
175 132 Dominic Cleal
## @gpg --homedir gnupg/1.2 -b -u packages@theforeman.org foreman-1.2.0.tar.bz2@ (requires 1.2 release GPG key generated above)
176 185 Tomer Brisker
# If for some reason there was an issue with the tarballs that required uploading new tarballs, CDN cache should be invalidated so that the builders use the updated tarballs.
177 132 Dominic Cleal
178
h2. Packaging a release
179 1 Dominic Cleal
180 132 Dominic Cleal
# In foreman-packaging rpm/1.2 branch, change foreman.spec, foreman-proxy.spec, foreman-selinux.spec, foreman-installer.spec:
181
## set version to "1.2.0"
182
## For RCs: set release to "0.1%{?dotalpha....", uncomment alphatag* (replace # with %), change to RC1
183 52 Dominic Cleal
## For non-RCs: set release to "1%{?dotalpha....", comment alphatag* (replace % with #)
184 184 Ondřej Pražák
## in each package dir, remove the old tarball, run @spectool -g *.spec@ and @git annex add *.tar.bz2@
185 115 Dominic Cleal
## commit with message "Release 1.2.0"
186 132 Dominic Cleal
## perform RPM scratch build of each project (see [[RPM_Packaging]])
187 159 Dominic Cleal
## tag each project with @tito tag --keep-version --changelog "Release 1.2.0"@
188 178 Ondřej Pražák
# Create new branches as described in [[Debian_Packaging#foreman]]
189
# Update changelog files for debs:
190 132 Dominic Cleal
## @scripts/changelog.rb -v 1.2.0-1 -m "1.2.0 released" debian/*/*/changelog@
191 115 Dominic Cleal
# Trigger next step of release pipeline: @release_packages@
192 138 Dominic Cleal
# Use [[RPM_Packaging]] to sign RPMs
193 132 Dominic Cleal
# Trigger next step of release pipeline: @release_mash@
194 149 Dominic Cleal
# Trigger next step of release pipeline: @release_test@
195 115 Dominic Cleal
# Trigger next step of release pipeline: @release_push_deb@ and @release_push_rpm@
196 132 Dominic Cleal
197 41 Dominic Cleal
h2. Completion tasks
198 132 Dominic Cleal
199
If releasing the first non-RC release (i.e. 1.2.0), start with:
200 137 Dominic Cleal
# update @$stable@ class parameter on @web@ class to point to the new version number (see @foreman-infra/puppet/modules/web/manifests/init.pp@)
201
# deb.theforeman.org, changing stable:
202
## change web's /var/www/freight/apt/*/stable symlinks to the new version number
203
## @rm -rf /var/www/vhosts/deb/htdocs/pool/*/stable/@
204 132 Dominic Cleal
## re-run freight cache
205
# Update theforeman.org:
206
## @documentation.md@ change default version
207 166 Dominic Cleal
## @_config.yml@ foreman_version and quickstart link
208 1 Dominic Cleal
## @_layouts/manual.html@ latestversion
209
## @plugins/index.md@ version
210 158 Dominic Cleal
## add a blog post describing release highlights etc.
211 1 Dominic Cleal
212 132 Dominic Cleal
213
For all releases:
214 1 Dominic Cleal
215 156 Dominic Cleal
# Add release to "Found in release" list in redmine: http://projects.theforeman.org/custom_fields/4/edit
216 154 Dominic Cleal
# Update theforeman.org:
217 173 Ewoud Kohl van Wijngaarden
## release notes from earlier steps (use scripts/release_notes.rb in theforeman.org repository)
218 154 Dominic Cleal
## @_includes/version.html@
219
## @_includes/latest_news.html@ entry
220
## @security.md@ for any released CVE fixes
221 182 Daniel Lobato Garcia
# Publish announcement notice in Release Announcements: (https://community.theforeman.org/c/release-announcements)
222
# Link to announcement post on IRC, Twitter, Google+ and update IRC /topic
223 1 Dominic Cleal
# Update the release schedule on [[Development_Resources]] to enter the date and for the following release(s)
224 160 Dominic Cleal
# Complete [[Security Process]] for any released CVE fixes (oss-security list)
225 1 Dominic Cleal
# Final only: Update Wikipedia Foreman entry at: https://en.wikipedia.org/wiki/Foreman_(software)