00e987e41b2e968082cab87c740148ae16a69582
[openocd.git] / doc / manual / release.txt
1 /** @page releases Release Processes
2
3 This page provides an introduction to the OpenOCD Release Processes:
4
5 - @ref releasewhy - Explain the motivations for producing
6   releases on a regular basis.
7 - @ref releasewho - Describes the responsibilities and
8   authority required to produce official OpenOCD releases.
9 - @ref releasewhen - Provides guidelines for scheduling
10   activities for each release cycle.
11 - @ref releasehow - Outlines all of the steps for the
12   processes used to produce and release the package source archives.
13 - @ref releasescript - Introduces the automated @c release.sh script.
14
15 @section releasewhy Why Produce Releases?
16
17 The OpenOCD maintainers produce <i>releases</i> periodically for many
18 reasons.  This section provides the key reasons for making releases on a
19 regular basis and why a set of <i>release processes</i> should be used
20 to produce them.
21
22 At any time, <i>source archives</i> can be produced by running
23 <code>make dist</code> in the OpenOCD project tree.  With the 0.2.0
24 release, this command will package the tree into several popular archive
25 formats: <code>openocd-\<version\>.{tar.gz,tar.bz2,zip}</code>.  If
26 produced properly, these files are suitable for release to the public.
27
28 When released for users, these archives present several important
29 advantages when contrasted to using the git repository:
30
31 -# They allow others to package and distribute the code.
32 -# They build easier for developers, because they contain
33    a working configure script that was produced by the Release Manager.
34 -# They prevent users from trying a random work-in-process revision.
35 -# They free developers from answering questions about mainline breakage.
36
37 Hopefully, this shows several good reasons to produce regular releases,
38 but the release processes were developed with some additional design
39 goals in mind.  Specifically, the releases processes should have the
40 following properties:
41
42 -# Produce successive sets of archives cleanly and consistently.
43 -# Implementable as a script that automates the critical steps.
44 -# Prevent human operators from producing broken packages, when possible.
45 -# Allow scheduling and automation of building and publishing milestones.
46
47 The current release processes are documented in the following sections.
48 They attempt to meet these design goals, but there may improvements
49 remaining to be made toward automating the process.
50
51 @section releaseversions Release Versions
52
53 The OpenOCD version string is composed of three numeric components
54 separated by two decimal points: @c x.y.z, where @c x is the @a major
55 version number, @c y is the @a minor number, and @c z is the @a micro.
56
57 For a <i>bug-fix</i> release, the micro version number will be non-zero
58 (<code>z > 0</code>).  For a <i>minor release</i>, the micro version
59 number will be zero (<code>z = 0</code>).  For a <i>major releases</i>,
60 the minor version will @a also be zero (<code>y = 0, z = 0</code>).
61
62 @subsection releaseversiontags Version Tags
63
64 After these required numeric components, the version string may contain
65 one or more <i>version tags</i>, such as '-rc1' or '-dev'.
66
67 Mainline and all branches should have the tag '-dev' in
68 their version number.  This tag helps developers identify reports
69 created from the git repository, and it can be detected and
70 manipulated by the release script.  Specifically, this tag will be
71 removed and re-added during the release process; it should never be
72 manipulated by developers in submitted patches.
73
74 The 'rc' tags indicate a "release candidate" version of the package.
75 This tag will also be manipulated by the automated release process.
76
77 Additional tags may be used as necessary.
78
79 @subsection releaseversionsdist Packager Versions
80
81 Distributors of patched versions of OpenOCD are encouraged to extend the
82 version string with a unique version tag when producing external
83 releases, as this helps to identify your particular distribution series.
84
85 For example, the following command will add a 'foo1' tag to the
86 configure.in script of a local copy of the source tree:
87
88 @code
89 tools/release.sh version bump tag foo
90 @endcode
91
92 This command will modify the configure.in script in your working copy
93 only.  After running the @c bootstrap sequence, the tree can be patched
94 and used to produce your own derived versions.  The same command can be
95 used each time the derived package is released, incrementing the tag's
96 version to facilitate tracking the changes you have distributed.
97
98 @subsection releaseversionhow Version Processes
99
100 The release process includes version number manipulations to the tree
101 being released, ensuring that all numbers are incremented at the right
102 time and in the proper locations of the repository.
103
104 The version numbers for any branch should increase monotonically
105 to the next successive integer, except when reset to zero
106 during major or minor releases.  The community should decide when
107 major and minor milestones will be released.
108
109 @section releasewho Release Manager
110
111 OpenOCD archive releases will be produced by an individual filling the
112 role of <i>Release Manager</i>, hereafter abbreviated as <i>RM</i>.  This
113 individual determines the schedule and executes the release processes
114 for the community.
115
116 @subsection releasewhohow RM Authority
117
118 Each release requires one individual to fulfill the RM role; however,
119 graceful transitions of this authority may take place at any time.  The
120 current RM may transfer their authority to another contributor in a post
121 to the OpenOCD development mailing list.  Such delegation of authority
122 must be approved by the individual that will receive it and the
123 community of maintainers.  Initial arrangements with the new RM should
124 be made off-list, as not every contributor wants these responsibilities.
125
126 @subsection releasewhowhat RM Responsibilities
127
128 In addition to the actual process of producing the releases, the RM is
129 responsible for keeping the community informed of all progress through
130 the release cycle(s) being managed.  The RM is responsible for managing
131 the changes to the package version, though the release tools should
132 manage the tasks of adding or removing any required development branch
133 tags and incrementing the version.
134
135 @section releasewhen Release Schedule
136
137 The OpenOCD release process must be carried out on a periodic basis, so
138 the project can realize the benefits presented in answer to the question,
139 @ref releasewhy.
140
141 Starting with the 0.2.0 release, the OpenOCD project should produce a
142 new minor release every month or two, with a major release once a year.
143 Bug fix releases could be provided more frequently.  These release
144 schedule goals may be adjusted in the future, after the project
145 maintainers and distributors receive feedback and experience.
146
147 More importantly, the statements made in this section do not create an
148 obligation by any member of the OpenOCD community to produce new
149 releases on regular schedule, now or in the future.
150
151 @subsection releasewhenexample Sample Schedule
152
153 The RM must pro-actively communicate with the community from the
154 beginning of the development cycle through the delivery of the new
155 release.  This section presents guidelines for scheduling key points
156 where the community must be informed of changing conditions.
157
158 If T is the time of the next release, then the following schedule
159 might describe some of the key milestones of the new release cycle:
160
161 - T minus one month: start of new development cycle
162 - T minus two weeks: announce pending mainline closure to new work
163 - T minus one week: close mainline to new work, begin testing phase
164 - T minus two days: call for final bug fixes
165 - T minus one day: produce -rc packages and distribute to testers
166 - T minus one hour: produce final packages and post on-line
167 - T minus zero: Announce the release to our mailing list and the world.
168
169 Some additional supplemental communication will be desirable.  The above
170 list omits the step-by-step instructions to daily release management.
171 Individuals performing release management need to have the ability to
172 interact proactively with the community as a whole, anticipating when
173 such interaction will be required and giving ample notification.
174
175 The next section explains why the OpenOCD project allows significant
176 flexibility in the part of the development that precedes the release
177 process.
178
179 @note The OpenOCD project does not presently produce -rc packages.  As
180 such, the step suggested in the list above should be read as trying to
181 stimulate others to test the project build and packaging on as many
182 platforms as possible.  This proposition will be palatable once release
183 management tools have been committed to the tree.
184
185 @subsection releasewhenflex Schedule Flexibility
186
187 The Release Manager should attempt to follow the guidelines in this
188 document, but the process of scheduling each release milestone should be
189 community driven at the start.  By the end, missing features that were
190 scheduled for a release must be dropped by the Release Manager, rather
191 than allowing the release cycle to be delayed while waiting for them.
192
193 Despite any assurances this schedule may appear to give, the Release
194 Manager cannot schedule the work that will be done on the project,
195 when it will be submitted, reviewed, and deemed suitable to be committed.
196 In this way, the RM cannot act as a priest in a cathedral; OpenOCD uses
197 the bazaar development model.  The release schedule must adapt
198 continuously in response to changes in the rate of churn.
199
200 In particular, the suggested period of "one or two month" reflects some
201 expectation of a fairly high rate of development.  Fewer releases may be
202 required if developers contribute less patches, and more releases may be
203 desirable if the project continues to grow and experience high rates of
204 community contribution.  During each cycle, the RM should be tracking
205 the situation and gathering feedback from the community.
206
207 @section releasehow Release Process: Step-by-Step
208
209 The release process may require a few iterations to work out any bugs.
210 Even with the release script, some steps require clear user intervention
211 -- and not only by the Release Manager.
212
213 The following steps should be followed to produce each release:
214
215 -# Produce final manual patches to mainline (or release branch):
216   -# Finalize @c NEWS file to describe the changes in the release
217     - This file is Used to automatically post "blurbs" about the project.
218     - This material should be produced during the development cycle.
219     - Add a new item for each @c NEWS-worthy contribution, when committed.
220   -# Bump library version if our API changed (not yet required)
221 -# Produce and tag the final revision in the git repository:
222   - Update and commit the final package version in @c configure.in :
223   -# Remove @c -dev tag.
224   -# Remove @c -rc tag, if producing the final release from an -rc series.
225   - Tags must be named consistently:
226 @verbatim
227 @endverbatim
228   - Tag the final commit with a consistent GIT tag name and message:
229 @verbatim
230 PACKAGE_VERSION="x.y.z"
231 PACKAGE_TAG="v${PACKAGE_VERSION}"
232 git tag -m "The openocd-${PACKAGE_VERSION} release." "${PACKAGE_TAG}"
233 @endverbatim
234 -# Prepare to resume normal development on the branch:
235   - Restore @c -dev and -@c -rc0 version tags.
236   - To start a new major (or minor) release cycle on the @c master branch:
237     - Bump major (or minor) package version, zeroing sub-components.
238     - Add -rc0 version tag:
239       - This insures casual releases from GIT always increase monotonically.
240       - For example, a major increment after releasing 1.2.3 starts 2.0.0-rc0-dev.
241     - Archive @c NEWS file as "<code>doc/news/NEWS-${PACKAGE_VERSION}</code>".
242     - Create a new @c NEWS file for the next release
243   - To start a bug-fix release on a non-master branch:
244     -# Bump bug-fix version.
245   - To start another release candidate on a major or minor branch:
246     -# Bump rc tag.
247 -# Produce the package source archives:
248   -# Start with a clean working copy, used for producing releases only.
249   -# Checkout the appropriate tag:
250 <code>git checkout $(git tag ) "${PACKAGE_VERSION}"</code>
251   -# Produce a ChangeLog for the release (using @c git2cl).
252   -# @c bootstrap, @c configure, and @c make the package.
253   -# Run <code>make distcheck</code> to produce the distribution archives.
254   -# Run <code>make maintainer-clean</code> verify the repository is empty.
255   -# Create signature files using @c md5sum, @c sha1sum, etc.
256 -# Publish documentation for the release:
257   - Allow users to access the documentation for each of our releases.
258   - Place static copies of the following files on the project website:
259     - @c NEWS: to provide a blurb for each release
260     - @c ChangeLog: to show exactly what has been changed
261     - User Guide, Developer Manual: to allow easy on-line viewing
262 -# Upload packages and post announcements of their availability:
263   -# Release packages into files section of project sites:
264     - SF.net:
265      -# Create a new folder named "${PACKAGE_VERSION}"
266      -# Select new folder as the target for uploads.
267      -# Upload files via Web interface into new
268      -# Set platform types for each archive:
269        - .tar.bz2: Linux, Mac
270        - .tar.gz: BSD, Solaris, Others
271        - .zip: Windows
272     - Berlios:
273      -# Create the new release for the new version.
274      -# Provide @c NEWS and ChangeLog files, as requested.
275      -# Upload files via FTP to ftp://ftp.berlios.de/incoming/
276      -# Edit descriptions for each file.
277      -# Click button to send E-mail Release Notice.
278   -# Post announcement e-mail to the openocd-development list.
279   -# Announce updates on freshmeat.net and other trackers.
280   -# Submit big updates to news feeds (e.g. Digg, Reddit, etc.).
281
282 @section releasescript The Release Script
283
284 Many of the processes described in the last section are no longer
285 entrusted to humans.  Instead, the @c release.sh script provides
286 automation of the mechanical steps.
287
288 Presently, the @c release.sh script automates steps 2 through 4,
289 allowing the Release Manager from perform these tasks in easy steps.
290
291 The following task still need to be automated:
292
293 - Step 5: produce documentation for website using released source archive.
294 - Step 6(a): package archive upload process.
295 - Step 6(b): package announcement e-mail process.
296 - Step 6(c): post files and announce them using releaseforge.
297
298 @subsection releasescriptcmds Release Script Commands
299
300 The release script can be used for two tasks:
301 - Creating releases and starting a new release cycle:
302 @code
303 git checkout master
304 tools/release.sh --type=minor --final --start-rc release
305 @endcode
306 - Creating a development branch from a tagged release:
307 @code
308 git checkout 'v0.2.0'
309 tools/release.sh --type=micro branch
310 @endcode
311
312 Both of these variations make automatic commits and tags in your
313 repository, so you should be sure to run it on a cloned copy before
314 proceding with a live release.
315
316 @subsection releasescriptopts Release Script Options
317
318 The @c release.sh script recognizes some command-line options that
319 affect its behavior:
320
321 - The @c --start-rc indicates that the new development release cycle
322   should start with @c -rc0.  Without this, the @c -rc tag will be omitted,
323   leading to non-monotonic versioning of the in-tree version numbers.
324 - The @c --final indicates that the release should drop the @c -rc tag,
325   to going from @c x.y.z-rcN-dev to x.y.z.
326
327 @subsection releasescriptenv Release Script Environment
328
329 The @c release.sh script recognizes some environment variables which
330 affect its behavior:
331
332 - @c CONFIG_OPTS : Passed as options to the configure script.
333 - @c MAKE_OPTS : Passed as options to the 'make' processes.
334
335 @section releasetutorial Release Tutorials
336
337 This section should contain a brief tutorial for using the Release 
338 Script to perform release tasks, but the new script needs to be
339 used for 0.3.0.
340
341 @section releasetodo Release Script Shortcomings
342
343 Improved automated packaging and distribution of OpenOCD requires more
344 patching of the configure script.  The final release script should be
345 able to manage most steps of the processes.  The steps requiring user
346 input could be guided by an "assistant" that walks the Release Manager
347 through the process from beginning to end, performing basic sanity
348 checks on their various inputs (e.g. the @c NEWS blurb).
349
350  */
351 /** @file
352 This file contains the @ref releases page.
353  */