Project

General

Profile

Release Process » History » Version 87

Dominic Cleal, 04/09/2014 06:56 PM

1 1 Dominic Cleal
h1. Release Process
2
3
For each major release (i.e. not patch releases), the project selects a "release nanny" who's responsible for taking the develop branch through to release.
4
5
Please amend these lists as you see free, and as you find what works and what doesn't work.
6
7 51 Lukas Zapletal
h2. First steps
8 1 Dominic Cleal
9
# Select the release nanny
10 2 Dominic Cleal
# Ensure RPM and Debian nightly packages are in good shape and all RPM dependencies are up to date
11 7 Dominic Cleal
# Ensure "Transifex project":https://www.transifex.com/projects/p/foreman/ is up to date
12 1 Dominic Cleal
# Decide on the version number
13 2 Dominic Cleal
# If number has changed, update version number in redmine
14
# Add _next+1_ anticipated version number to redmine under "Settings":http://projects.theforeman.org/projects/foreman/settings, sharing "With subprojects"
15
# Check "roadmap":http://projects.theforeman.org/projects/foreman/roadmap and issue search ("example":http://projects.theforeman.org/projects/foreman/issues?fixed_version_id=24&set_filter=1&status_id=o)
16
#* reassign major features to next+1 version or remove version
17 1 Dominic Cleal
#* assign relevant bugs to this upcoming release
18
#* multiple bugs can be managed using checkboxes and then right clicking on the boxes for a menu
19
#* create public custom query with target version set, sorted by status ascending, then priority descending
20 51 Lukas Zapletal
# Go through targeted features in redmine and align features with our "backlog":https://trello.com/board/foreman-backlog/5162af6bb868365e0c007135
21
22
h2. Before creating branch in git
23
24 1 Dominic Cleal
# Announce beginning of bug-squashing to foreman-dev ("example":http://groups.google.com/group/foreman-dev/browse_thread/thread/769d9060774da864)
25 8 Dominic Cleal
# 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)
26
# Update manual if applicable for any additional installation steps
27 58 Lukas Zapletal
# Draft release notes in markdown ("example":https://gist.github.com/domcleal/5567450) using roadmap, with these sections (and do not use personal pronouns):
28 6 Dominic Cleal
## Headline features: half a dozen important features with a few sentences description each
29
## Upgrade notes: all important notices that users must be aware of before upgrading
30 64 Lukas Zapletal
## 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 (helper vim search and replace command bellow)
31 60 Lukas Zapletal
# Check @git log@ for any changes without associated bug number and add to release notes if applicable (https://gist.github.com/lzap/6520535)
32 27 Dominic Cleal
# Refresh kickstart, snippet and partition table templates from the community-templates repo to Foreman core
33 52 Dominic Cleal
# Request creation of tags and build targets in "Koji":http://koji.katello.org/koji from rel-eng:
34
#* foreman-1.2-rhel6 etc. as clones of nightly tags
35
#* foreman-plugins-1.2-rhel6 etc. with inheritance from the new Foreman tags
36 55 Lukas Zapletal
#* example set of actions: http://pastebin.test.redhat.com/162144 and http://pastebin.test.redhat.com/162145
37 57 Dominic Cleal
# Add new plugin tags (i.e. 1.3) to:
38 1 Dominic Cleal
#* SFK configuration in "foreman-packaging":https://github.com/theforeman/foreman-packaging/blob/master/rpms/pull_from_koji.sh
39
#* Koji nightly mash script
40
# Add release to "Found in release" list in redmine: http://projects.theforeman.org/custom_fields/4/edit
41 87 Dominic Cleal
# Add new lookaside repos to foreman-packaging:repoclosure/yum_*.conf
42 64 Lukas Zapletal
43
Helper vim command to replace all @(#1234)@ bugs with links:
44
45
    %s/(\(#\)\([0-9]\+\))/(\[\1\2]\(http:\/\/projects.theforeman.org\/issues\/\2))/g
46 1 Dominic Cleal
47
h2. Pre-release candidates
48
49 8 Dominic Cleal
When ready to branch for release candidates.
50
51 40 Dominic Cleal
# Add new languages that are at a reasonable completion on Transifex to *develop*
52 61 Lukas Zapletal
# In foreman *develop* run @make -C locale tx-update@
53 70 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@)
54 85 Dominic Cleal
# In foreman-packaging, branch *master* to *1.2-stable* (this is only used for comps)
55 71 Dominic Cleal
# In foreman *develop* commit with message "Bump version to 1.3-develop":
56
## change to VERSION to 1.3-develop
57 70 Dominic Cleal
## change packagename.spec to 1.3.0, add %changelog entry
58 1 Dominic Cleal
## run @extras/changelog@
59 71 Dominic Cleal
# In smart-proxy *develop* commit with message "Bump version to 1.3-develop":
60
## change to lib/proxy.rb VERSION to 1.3-develop
61 70 Dominic Cleal
## change foreman-proxy.spec version to 1.3.0, add %changelog entry
62 15 Dominic Cleal
## run @extra/changelog@
63 71 Dominic Cleal
# In foreman-selinux *develop* commit with message "Bump version to 1.3-develop":
64 73 Dominic Cleal
## change foreman-selinux.spec version to 1.3.0, add %changelog entry
65 74 Dominic Cleal
## run @extras/changelog@
66 75 Dominic Cleal
# In foreman-installer *develop* commit with message "Bump version to 1.3-develop":
67
## change foreman-installer.spec version to 1.3.0, add %changelog entry
68 52 Dominic Cleal
# Update foreman-dev with "translations status":https://www.transifex.com/projects/p/foreman/ to encourage 100% translations before release, announce string freeze date
69 38 Dominic Cleal
# Change Transifex resource URL to point to the 1.2-stable branch
70 10 Dominic Cleal
# Update $repo in both foreman-installer/foreman and foreman_proxy modules to "rc" ("example":https://github.com/theforeman/puppet-foreman/commit/4098163a8)
71 16 Dominic Cleal
# Set up test_1_2_stable job on Jenkins, copy from existing stable or test_develop (don't use dots in the name, it breaks)
72 25 Dominic Cleal
# Update release notes in new website manual version
73 2 Dominic Cleal
74 1 Dominic Cleal
h2. For each release candidate
75
76 65 Lukas Zapletal
# Update version and dependency versions in all foreman-installer submodules (using script ./bump_modules previous_version next_version)
77 1 Dominic Cleal
# Update submodules on foreman-installer's *develop* branch via PR, cherry-pick down to *1.2-stable*
78 40 Dominic Cleal
# Compare tagged packages in nightly vs. release koji tag and re-tag any updated dependencies that are required
79 69 Dominic Cleal
# In foreman *1.2-stable* run @make -C locale tx-update@
80 19 Dominic Cleal
# In foreman *1.2-stable* commit with message "Release 1.2.0-RC1":
81 20 Dominic Cleal
## change to VERSION to 1.2.0-RC1
82 36 Dominic Cleal
## change foreman.spec version to "1.2.0", release to "0.1.RC1", add %changelog entry
83 1 Dominic Cleal
## run @extras/changelog@
84 76 Dominic Cleal
## change @extras/packaging/rpm/sources/foreman.repo@ URLs from @/nightly@ to @/rc@, change "nightly" in name to "RC" and enable gpg checking
85 77 Dominic Cleal
## change @extras/packaging/rpm/sources/foreman-plugins.repo@ URLs from @/plugins/nightly@ to @/plugins/1.2@, change "nightly" in name to "1.2" and DO NOT enable GPG checking
86 19 Dominic Cleal
# In smart-proxy *1.2-stable* commit with message "Release 1.2.0-RC1":
87
## change to lib/proxy.rb VERSION to 1.2.0-RC1
88 52 Dominic Cleal
## change foreman-proxy.spec version to "1.2.0", release to "0.1.RC1", add %changelog entry
89 1 Dominic Cleal
## run @extra/changelog@
90 37 Dominic Cleal
# In foreman-selinux *1.2-stable* commit with message "Release 1.2.0-RC1":
91 52 Dominic Cleal
## change foreman-selinux.spec version to "1.2.0", release to "0.1", uncomment alphatag* (replace # with %) and change to RC1, add %changelog entry
92 78 Dominic Cleal
## run extras/changelog
93 1 Dominic Cleal
# In foreman-installer *1.2-stable* commit with message "Release 1.2.0-RC1":
94 52 Dominic Cleal
## change foreman-installer.spec version to "1.2.0", release to "0.1", uncomment alphatag* (replace # with %) and change to RC1, add %changelog entry
95 1 Dominic Cleal
# Tag commits in foreman, smart-proxy, foreman-installer and foreman-selinux: @git tag -m "Release 1.2.0-RC1" 1.2.0-RC1@
96 41 Dominic Cleal
# Push to *your* GitHub repo to enable testing first
97
# Perform RPM scratch build of foreman, foreman-installer, foreman-proxy and foreman-selinux (see [[RPM_Packaging]])
98
## if they fail, revert your branch to current @project/1.2-stable@ branch, fix the issue in your repo and retry until it works
99 43 Dominic Cleal
# Push to the project repo: @git push project && git push project 1.2.0-RC1@
100 45 Dominic Cleal
# [[RPM_Packaging]]: follow release procedure for foreman, foreman-proxy, foreman-installer and foreman-selinux using Jenkins
101 23 Greg Sutcliffe
# [[Debian_Packaging#foreman]]: Update build.sh and changelog files with appropriate data
102 24 Dominic Cleal
# Build foreman-installer modules from 1.2-stable (see [[Installer_Packaging]] workflow)
103 37 Dominic Cleal
# Build foreman-installer Debian package from 1.2-stable (see [[Debian_Packaging#foreman-installer]])
104 26 Dominic Cleal
# Update theforeman.org sections:
105 79 Dominic Cleal
## @_includes/social.html@ version number
106 41 Dominic Cleal
## @_includes/header.html@ manual links
107 1 Dominic Cleal
# Generate and sign tarball of foreman and smart-proxy:
108
## @git archive --prefix=foreman-1.2.0-RC1/ 1.2.0-RC1 | bzip2 -9 > foreman-1.2.0-RC1.tar.bz2@
109
## @gpg -b -u packages@theforeman.org foreman-1.2.0-RC1.tar.bz2@ (requires packages key)
110
# Follow "Publishing releases" below
111
112
h2. For final release
113
114 41 Dominic Cleal
# Update version and dependency versions in all foreman-installer submodules (TODO: script this)
115
# Update submodules on foreman-installer's *develop* branch via PR, cherry-pick down to *1.2-stable*
116 1 Dominic Cleal
# Compare tagged packages in nightly vs. release koji tag and re-tag any updated dependencies that are required
117 69 Dominic Cleal
# In foreman *1.2-stable* run @make -C locale tx-update@
118 1 Dominic Cleal
# In foreman *1.2-stable* commit with message "Release 1.2.0":
119 52 Dominic Cleal
## change to VERSION to 1.2.0
120 41 Dominic Cleal
## change foreman.spec version to "1.2.0", release to "1", add %changelog entry
121 1 Dominic Cleal
## run @extras/changelog@
122 81 Dominic Cleal
## change @extras/packaging/rpm/sources/foreman.repo@ URL from @/rc@ to @/releases/1.2@, change "RC" in name to "1.4" and make sure gpgcheck is on
123 41 Dominic Cleal
# In smart-proxy *1.2-stable* commit with message "Release 1.2.0":
124
## change to lib/proxy.rb VERSION to 1.2.0
125 52 Dominic Cleal
## change foreman-proxy.spec version to "1.2.0", release to "1", add %changelog entry
126 41 Dominic Cleal
## run @extra/changelog@
127
# In foreman-selinux *1.2-stable* commit with message "Release 1.2.0":
128 52 Dominic Cleal
## change foreman-selinux.spec version to "1.2.0", release to "1", comment alphatag* (replace % with #), add %changelog entry
129 80 Dominic Cleal
## run extras/changelog
130 41 Dominic Cleal
# In foreman-installer *1.2-stable* commit with message "Release 1.2.0":
131 52 Dominic Cleal
## change foreman-installer.spec version to "1.2.0", release to "1", comment alphatag* (replace % with #), add %changelog entry
132 41 Dominic Cleal
# Tag commits in foreman, smart-proxy, foreman-installer and foreman-selinux: @git tag -m "Release 1.2.0" 1.2.0@
133
# Push to *your* GitHub repo to enable testing first
134
# Perform RPM scratch build of foreman, foreman-installer, foreman-proxy and foreman-selinux (see [[RPM_Packaging]])
135
## if they fail, revert your branch to current @project/1.2-stable@ branch, fix the issue in your repo and retry until it works
136 43 Dominic Cleal
# Push to the project repo: @git push project && git push project 1.2.0@
137 45 Dominic Cleal
# [[RPM_Packaging]]: follow release procedure for foreman, foreman-proxy, foreman-installer and foreman-selinux using Jenkins
138 41 Dominic Cleal
# [[Debian_Packaging#foreman]]: Update build.sh and changelog files with appropriate data
139
# Build foreman-installer modules from 1.2-stable (see [[Installer_Packaging]] workflow)
140
# Build foreman-installer Debian package from 1.2-stable (see [[Debian_Packaging#foreman-installer]])
141
# Update theforeman.org sections:
142 82 Dominic Cleal
## @_includes/social.html@ version number
143 41 Dominic Cleal
## @_includes/header.html@ manual links
144
## @_layouts/homepage.html@ quickstart link
145 83 Dominic Cleal
## @_layouts/manual.html@ latestversion
146 82 Dominic Cleal
## @_config.yml@ quickstart link
147 41 Dominic Cleal
# Generate and sign tarball of foreman and smart-proxy:
148
## @git archive --prefix=foreman-1.2.0/ 1.2.0 | bzip2 -9 > foreman-1.2.0.tar.bz2@
149
## @gpg -b -u packages@theforeman.org foreman-1.2.0.tar.bz2@ (requires packages key)
150 59 Dominic Cleal
# Merge develop branches into master (@git merge -Xtheirs --no-ff@) for: foreman, smart-proxy, foreman-installer, foreman-selinux
151 1 Dominic Cleal
# Follow "Publishing releases" below
152 28 Dominic Cleal
153
h2. Publishing releases (RCs and final)
154 1 Dominic Cleal
155 87 Dominic Cleal
# First RC: Add the new release to the Jenkins "packaging_publish_plugins_rpm":http://ci.theforeman.org/job/packaging_publish_plugins_rpm/ job matrix
156 46 Dominic Cleal
# Sign all RPMs (see [[RPM_Packaging]])
157 41 Dominic Cleal
# Run or request (from rel-eng) RPM repo mash/compose for Koji release tags
158 47 Dominic Cleal
# Do a dry run of the RPM push process to check repoclosure etc. (see [[RPM_Packaging]])
159 41 Dominic Cleal
# Push RPMs to repo on the web host, under @/rc@ or @/releases/1.2@ etc using Jenkins (see [[RPM_Packaging]])
160 32 Dominic Cleal
# Push foreman-installer to Freight (see [[Debian_Packaging#foreman-installer]])
161 28 Dominic Cleal
# Upload tarballs and detached signatures to http://projects.theforeman.org/projects/foreman/files
162 49 Dominic Cleal
## Final only: delete all existing RC files to free up space
163 28 Dominic Cleal
# Upload all installer module .tar.gz files to Puppet Forge
164 41 Dominic Cleal
# Final only: update @$latest@ class parameter on @web@ class to point to the new version number (see @foreman-infra/puppet/modules/web/manifests/init.pp@)
165 50 Dominic Cleal
# Send announcement e-mail to foreman-announce, CC foreman-users, set reply-to to foreman-users
166 1 Dominic Cleal
# Link to announcement e-mail on IRC, Google+ and update IRC /topic
167 72 Lukas Zapletal
# Update Wikipedia Foreman entry at: https://en.wikipedia.org/wiki/Foreman_(software)
168 84 Dominic Cleal
# Add release to "Found in release" list in redmine: http://projects.theforeman.org/custom_fields/4/edit
169 40 Dominic Cleal
170
h2. After final release
171
172 41 Dominic Cleal
# Sync translations from Transifex into *develop* and run @rake locale:find@
173 49 Dominic Cleal
# Remove target version from all issues assigned to the current release, unless they will be fixed in a future point release