Remove annoying end-of-line whitespace from doc/* files.
[openocd.git] / doc / manual / release.txt
1 /** @page releases Release Processes
3 This page provides an introduction to the OpenOCD Release Processes:
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 script.
15 @section releasewhy Why Produce Releases?
17 The OpenOCD maintainers should produce <i>releases</i> periodically. This
18 section gives several reasons to explain the reasons for making releases
19 on a regular basis. These reasons lead to motivation for developing and
20 following a set of <i>release processes</i>. The actual processes are
21 described in the remainder of the @ref releases sections.
23 At any time, a "source archives" can be produced by running 'make dist'
24 in the OpenOCD project tree. With the 0.2.0 release, this command will
25 produce openocd-\<version\>.{tar.gz,tar.bz2,zip} archives. These files
26 will be suitable for being released when produced properly.
28 When released for users, these archives present several important
29 advantages when contrasted to using the Subversion repository:
31 -# They allow others to package and distribute the code to users.
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 HEAD revision of the trunk.
35 -# They free developers from answering questions about trunk breakage.
37 Hopefully, this shows several good reasons to produce regular releases,
38 but these release processes were developed with some additional design
39 goals in mind. Specifically, the releases processes should have the
40 following properties:
42 -# Produce successive sets of release archives cleanly and consistently.
43 -# Implementable as a script that automates the critical release steps.
44 -# Prevent human operators from producing bad releases, when possible.
45 -# Allow scheduling and automation of release process milestones.
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.
51 @section releaseversions Release Versions
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.
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>).
62 The trunk and all branches should have the tag '-in-development' in
63 their version number. This tag helps developers identify reports
64 created from the Subversion repository, and it can be detected and
65 manipulated by the release script. Specifically, this tag will be
66 removed and re-added during the release process; it should never be
67 manipulated by developers in submitted patches.
69 @subsection releaseversionsdist Patched Versions
71 Distributors of patched versions of OpenOCD are encouraged to extend
72 the version string when producing external releases, as this helps to
73 identify your particular distribution series.
75 @subsection releaseversionsdist Version Processes
77 The release process includes version number manipulations to the tree
78 being released, ensuring that all numbers are incremented at the right
79 time and in the proper locations of the repository.
81 The version numbers for any branch should monotonically
82 increase to the next successive integer, except when reset to zero
83 during major or minor releases. The community should decide when
84 major and minor milestones will be released.
86 @section releasewho Release Manager
88 OpenOCD archive releases will be produced by an individual filling the
89 role of <i>Release Manager</i>, hereafter abbreviated as <i>RM</i>. This
90 individual determines the schedule and executes the release processes
91 for the community.
93 @subsection releasewhohow RM Authority
95 Each release requires one individual to fulfill the RM role; however,
96 graceful transitions of this authority may take place at any time. The
97 current RM may transfer their authority to another contributor in a post
98 to the OpenOCD development mailing list. Such delegation of authority
99 must be approved by the individual that will receive it and the
100 community of maintainers. Initial arrangements with the new RM should
101 be made off-list, as not every contributor wants these responsibilities.
103 @subsection releasewhowhat RM Responsibilities
105 In addition to the actual process of producing the releases, the RM is
106 responsible for keeping the community informed of all progress through
107 the release cycle(s) being managed. The RM is responsible for managing
108 the changes to the package version, though the release tools should
109 manage the tasks of adding or removing any required development branch
110 tags and incrementing the version.
112 @section releasewhen Release Schedule
114 The OpenOCD release process must be carried out on a periodic basis, so
115 the project can realize the benefits presented in answer to the question,
116 @ref releasewhy.
118 Starting with the 0.2.0 release, the OpenOCD project should produce a
119 new minor release every month or two, with a major release once a year.
120 Bug fix releases could be provided more frequently. These release
121 schedule goals may be adjusted in the future, after the project
122 maintainers and distributors receive feedback and experience.
124 More importantly, the statements made in this section do not create an
125 obligation by any member of the OpenOCD community to produce new
126 releases on regular schedule, now or in the future.
128 @subsection releasewhenexample Sample Schedule
130 The RM must pro-actively communicate with the community from the
131 beginning of the development cycle through the delivery of the new
132 release. This section presents guidelines for scheduling key points
133 where the community must be informed of changing conditions.
135 If T is the time of the next release, then the following schedule
136 might describe some of the key milestones of the new release cycle:
138 - T minus one month: start of new development cycle
139 - T minus two weeks: announce pending trunk closure to new work
140 - T minus one week: close trunk to new work, begin testing phase
141 - T minus two days: call for final bug fixes
142 - T minus one day: produce -rc packages and distribute to testers
143 - T minus one hour: produce final packages and post on-line
144 - T minus zero: Announce the release to our mailing list and the world.
146 Some additional supplemental communication will be desirable. The above
147 list omits the step-by-step instructions to daily release management.
148 Individuals performing release management need to have the ability to
149 interact proactively with the community as a whole, anticipating when
150 such interaction will be required and giving ample notification.
152 The next section explains why the OpenOCD project allows significant
153 flexibility in the part of the development that precedes the release
154 process.
156 @note The OpenOCD project does not presently produce -rc packages. As
157 such, the step suggested in the list above should be read as trying to
158 stimulate others to test the project build and packaging on as many
159 platforms as possible. This proposition will be palatable once release
160 management tools have been committed to the tree.
162 @subsection releasewhenflex Schedule Flexibility
164 The Release Manager should attempt to follow the guidelines in this
165 document, but the process of scheduling each release milestone should be
166 community driven at the start. By the end, missing features that were
167 scheduled for a release must be dropped by the Release Manager, rather
168 than allowing the release cycle to be delayed while waiting for them.
170 Despite any assurances this schedule may appear to give, the Release
171 Manager cannot schedule the work that will be done on the project,
172 when it will be submitted, review, and deemed suitable to be committed.
173 In this way, the RM cannot act as a priest in a cathedral; OpenOCD uses
174 the bazaar development model. The release schedule must adapt
175 continuously in response to changes in the rate of churn.
177 In particular, the suggested period of "one or two month" reflects some
178 expectation of a fairly high rate of development. Fewer releases may be
179 required if developers contribute less patches, and more releases may be
180 desirable if the project continues to grow and experience high rates of
181 community contribution. During each cycle, the RM should be tracking
182 the situation and gathering feedback from the community .
184 @section releasehow Release Process: Step-by-Step
186 The release process may require a few iterations to work out any bugs.
187 Even with the release script, some steps require clear user intervention
188 -- and not only by the Release Manager.
190 The following steps should be followed to produce each release:
192 -# Produce final patches to the trunk (or release branch):
193 -# Finalize @c NEWS file to describe the changes in the release
194 - This file is Used to automatically post "blurbs" about the project.
195 - This material should be produced during the development cycle.
196 - Add a new item for each @c NEWS-worthy contribution, when committed.
197 -# bump library version if our API changed (not yet required)
198 -# Remove -in-development tag from package version:
199 - For major/minor releases, remove version tag from trunk, @a or
200 - For bug-fix releases, remove version tag from release branch.
201 -# Branch or tag the required tree in the Subversion repository:
202 - Tags and branches for releases must be named consistently: @par
204 - For a major/minor release from the main trunk, the code should be
205 branched and tagged in the repository:
206 @verbatim
207 svn cp .../trunk .../branches/${RELEASE_BRANCH}
208 svn cp .../branches/${RELEASE_BRANCH} .../tags/${RELEASE_TAG}
209 @endverbatim
210 - For bug-fix releases produced in their respective branch, a tag
211 should be created in the repository:
212 @verbatim
213 svn cp .../branches/${RELEASE_BRANCH} .../tags/${RELEASE_TAG}
214 @endverbatim
215 -# Prepare to resume normal development activities:
216 - Archive @c NEWS file as <code>doc/news/NEWS-${PACKAGE_VERSION}</code>.
217 - Create a new @c NEWS file for the next release
218 - For major/minor release from the trunk:
219 -# Bump major or minor package version in trunk.
220 -# Restore version tag to trunk and release branch.
221 - For bug-fix releases from a release branch:
222 -# Bump bug-fix version in release branch.
223 -# Restore version tag to release branch.
224 -# Produce the package source archives:
225 -# Start with a clean working copy, used for producing releases only.
226 -# Switch to release tag branch: svn switch .../${RELEASE_TAG}
227 -# produce a ChangeLog for the release (using svn2cl).
228 -# @c bootstrap, @c configure, and @c make the package.
229 -# Run <code>make distcheck</code> to produce the distribution archives.
230 -# Run <code>make maintainer-clean</code> verify the repository is empty.
231 -# Publish documentation for the release:
232 - Allow users to access the documentation for each of our releases.
233 - Place static copies of the following files on the project website:
234 - @c NEWS: to provide a blurb for each release
235 - @c ChangeLog: to show exactly what has been changed
236 - User Guide, Developer Manual: to allow easy on-line viewing
237 -# Upload packages and post announcements of their availability:
238 -# Release packages into files section of berliOS project site:
239 -# Create the new release for the new version.
240 -# Provide @c NEWS and ChangeLog files, as requested.
241 -# Upload files via FTP to
242 -# Edit descriptions for each file.
243 -# Send E-mail Release Notice
244 -# Post announcement e-mail to the openocd-development list.
245 -# Announce updates on and other trackers.
246 -# Submit big updates to news feeds (e.g. Digg, Reddit, etc.).
248 @section releasescript The Release Script
250 Many of the processes described in the last section are no longer
251 entrusted to humans. Instead, the @c script provides
252 automation of the mechanical steps.
254 Presently, the @c script automates steps 1(c) through 4,
255 allowing the Release Manager from perform these tasks in easy steps.
257 The following task still need to be automated:
259 - Step 5: produce documentation for website using released source archive.
260 - Step 6(a): package archive upload process.
261 - Step 6(b): package announcement e-mail process.
262 - Step 6(c): post files and announce them using releaseforge.
264 In addition, support for '-rc' releases needs to be added.
266 @subsection releasescriptcmds Release Script Commands
268 The following output was taken from the release script:
269 @verbatim
270 usage: tools/ [options] <command>
272 Main Commands:
273 info Show a summary of the next pending release.
274 release Release the current tree as an archive.
275 upload Upload archives to berliOS project site
277 Build Commands:
278 bootstrap Prepare the working copy for configuration and building.
279 configure Configures the package; runs bootstrap, if needed.
280 build Compiles the project; runs configure, if needed.
282 Packaging Commands:
283 changelog Generate a new ChangeLog using svn2cl.
284 package Produce new distributable source archives.
285 stage Move archives to staging area for upload.
287 Repository Commands:
288 commit Perform branch and tag, as appropriate for the version.
289 branch Create a release branch from the project trunk.
290 tag Create a tag for the current release branch.
292 Other Commands:
293 version ... Perform version number and tag manipulations.
294 clean Forces regeneration of results.
295 clean_all Removes all traces of the release process.
296 help Provides this list of commands.
298 For more information about this script, see the Release Processes page
299 in the OpenOCD Developer's Manual (doc/manual/release.txt).
301 WARNING: This script should be used by the Release Manager ONLY.
302 @endverbatim
304 Run <code>tools/ help</code> for current command support.
306 @subsection releasescriptenv Release Script Options
308 The @c script recognizes some command-line options that
309 affect its behavior:
311 - @c --live : Use this option to perform a live release.
312 When this option has been given, the release commands will affect
313 the repository; otherwise, the script reports the actions to take,
314 and it produces archives that are unsuitable for public release.
316 @note Only the Release Manager should use the @c --live option, as
317 it will make permanent changes to the Subversion repository that
318 cannot be undone.
320 @subsection releasescriptenv Release Script Environment
322 The @c script recognizes some environment variables which
323 affect its behavior:
325 - @c CONFIG_OPTS : Passed as options to the configure script.
326 - @c MAKE_OPTS : Passed as options to the 'make' processes.
328 @section releasetutorial Release Tutorials
330 This section provides tutorials for using the Release Script to perform
331 common release tasks.
333 @subsection releasetutorialsetup Release Tutorial Setup
335 The tutorials in this section assume the following environment
336 variables have been set properly:
337 @verbatim
338 SVN_USER="maintainer"
339 SVN_URL="https://${SVN_USER}"
340 @endverbatim
342 @subsection releasetutorialminor Minor Release Tutorial
344 This section provides a step-by-step tutorial for a Release Manager to
345 use to run the @c script to produce a minor release.
347 If the proper environment has been set, the following steps will produce
348 a new minor release:
350 -# Check out (or update) the project trunk from the berliOS repository:
351 @code
352 svn checkout "${SVN_URL}/trunk" openocd-trunk
353 @endcode
354 -# Change to the new working copy directory:
355 @code
356 cd openocd-trunk
357 @endcode
358 -# Run @c to produce the minor release:
359 @code
360 tools/ all
361 @endcode
363 @subsection releasetutorialmicro Bug-Fix Release Tutorial
365 This section provides a step-by-step tutorial for a Release Manager to
366 use to run the @c script to produce a bug-fix release.
368 In addition to the environment variables described in the introduction
369 to these tutorials, the following variables are also used in the
370 instructions for this section:
371 @verbatim
374 @endverbatim
376 If the proper environment has been set, the following steps will produce
377 a new bug-fix release:
379 -# Check out (or update) the release branch from the project repository:
380 @code
381 svn checkout "${SVN_URL}/branches/${PACKAGE_BRANCH}" "${PACKAGE_BRANCH}"
382 @endcode
383 @code
384 cd "${PACKAGE_BRANCH}"
385 @endcode
386 -# Run @c to produce the bug-fix release:
387 @code
388 tools/ all
389 @endcode
391 @section releasetodo Release Script Shortcomings
393 Improved automated packaging and distribution of OpenOCD requires more
394 patching of the configure script. The final release script should be
395 able to manage most steps of the processes. The steps requiring user
396 input could be guided by an "assistant" that walks the Release Manager
397 through the process from beginning to end, performing basic sanity
398 checks on their various inputs (e.g. the @c NEWS blurb).
400 */
401 /** @file
402 This file contains the @ref releases page.
403 */

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 (RSA)