← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/releasing.txt

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-09-19 00:32:14 UTC
  • mfrom: (4685.2.1 bzr.dev)
  • Revision ID: pqm@pqm.ubuntu.com-20090919003214-2dli9jc4y5xhjj3n
(mbp for garyvdm) Revert rename of
        test_merge_uncommitted_otherbasis_ancestor_of_thisbasis.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/releasing.txt
2
2
================
3
3
 
4
4
This document describes the processes for making and announcing a Bazaar
5
 
release, and managing the release process.  This is just one phase of the
 
5
release, and managing the release process.  This is just one phase of the 
6
6
`overall development cycle <http://doc.bazaar-vcs.org/developers/cycle.html>`_,
7
7
but it's the most complex part.
8
8
This document gives a checklist you can follow from start to end in one
9
9
go.
10
10
 
11
 
If you're helping the Release Manager (RM) for one reason or another, you
12
 
may notice that he didn't follow that document scrupulously. He may have
13
 
good reasons to do that but he may also have missed some parts.
14
 
 
15
 
Follow the document yourself and don't hesitate to create the missing
16
 
milestones for example (we tend to forget these ones a lot).
17
 
 
18
11
.. contents::
19
12
 
20
13
 
42
35
   will be available for targeting or nominating bugs.
43
36
 
44
37
#. We create a new pqm-controlled branch for this release series, by
45
 
   asking a Canonical sysadmin.
 
38
   asking a Canonical sysadmin.  
46
39
   This branch means that from the first release beta or candidate onwards,
47
40
   general development continues on the trunk, and only
48
41
   specifically-targeted fixes go into the release branch.
52
45
   and their expected dates.
53
46
 
54
47
#. Update the version number in the ``bzr`` script, and the
55
 
   ``bzrlib/__init__.py`` file. Make sure there is always a corresponding
56
 
   milestone when you change that version number.
 
48
   ``bzrlib/__init__.py`` file.
57
49
 
58
50
#. Send mail to the list with the key dates, who will be the release
59
51
   manager, and the main themes or targeted bugs.  Ask people to nominate
60
52
   objectives, or point out any high-risk things that are best done early,
61
53
   or that interact with other changes. This is called the metronome mail
62
 
   and is described in `Development cycles <cycle.html>`_.
63
 
 
64
 
#. Make a local branch for preparing this release.  (Only for the first
 
54
   and as RM you're supposed to send other metronome mails at your rythm.
 
55
 
 
56
 
 
57
Starting the release phase
 
58
--------------------------
 
59
 
 
60
When it's time to make the first beta release or release candidate:
 
61
 
 
62
#. Make a beta release or release candidate. The milestone for this
 
63
   candidate will already exist (see Starting a cycle above).
 
64
 
 
65
Preparing the tree for release
 
66
------------------------------
 
67
 
 
68
#. Make a local branch for preparing this release.  (Only for the first 
65
69
   release in a series, otherwise you should already have a branch.) ::
66
70
 
67
71
     bzr branch trunk prepare-1.14
73
77
        [/home/mbp/bzr/prepare-x.y]
74
78
        pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
75
79
        submit_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
76
 
        parent_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
77
80
        public_branch = http://bazaar.example.com/prepare-x.y
78
81
        submit_to = bazaar@lists.canonical.com
79
82
        smtp_server = mail.example.com:25
82
85
    for more details on PQM
83
86
 
84
87
#. In the release branch, update  ``version_info`` in ``./bzrlib/__init__.py``.
85
 
   Make sure the corresponding milestone exists.
86
88
   Double check that ./bzr ``_script_version`` matches ``version_info``. Check
87
89
   the output of ``bzr --version``.
88
90
 
96
98
       version_info = (2, 0, 1, 'candidate', 1)
97
99
 
98
100
 
99
 
Starting the release phase
100
 
--------------------------
101
 
 
102
 
#. Create a new milestone at <https://launchpad.net/bzr/x.y/+addmilestone>
103
 
   for the beta release or release candidate if you haven't already.
104
 
 
105
101
#. Add the date and release number to ``./NEWS``
106
102
 
107
 
   Depending on whether you're doing a beta or a bugfix release, you'll
108
 
   have to create a NEWS section for your release in the right
109
 
   place. Most of the time, the new section is at the top of the file
110
 
   (look what have been done for the various 2.0x and 2.1.0bx releases).
111
 
   The rule is to keep the sections sorted by date. You'll need to be
112
 
   cautious when merging back to trunk to respect that.
113
 
 
114
103
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
115
104
   closed in Launchpad, you can run ``tools/check-newsbugs.py``::
116
105
 
123
112
#. Summarize into one or two paragraphs what's new in this release.
124
113
 
125
114
#. Commit these changes to the release branch, using a command like::
126
 
 
127
 
     bzr commit -m "Release 1.14."
128
 
 
 
115
    
 
116
     bzr commit -m "Release 1.14." 
 
117
   
129
118
   The diff before you commit will be something like::
130
119
 
131
120
     === modified file 'NEWS'
132
121
     --- NEWS        2008-09-17 23:09:18 +0000
133
122
     +++ NEWS        2008-09-23 16:14:54 +0000
134
123
     @@ -4,6 +4,23 @@
135
 
 
 
124
     
136
125
      .. contents::
137
 
 
 
126
     
138
127
     +bzr 1.7 2008-09-23
139
128
     +------------------
140
129
     +
147
136
     +
148
137
      bzr 1.7rc2 2008-09-17
149
138
      ---------------------
150
 
 
151
 
 
 
139
     
 
140
     
152
141
     === modified file 'bzrlib/__init__.py'
153
142
     --- bzrlib/__init__.py  2008-09-16 21:39:28 +0000
154
143
     +++ bzrlib/__init__.py  2008-09-23 16:14:54 +0000
155
144
     @@ -41,7 +41,7 @@
156
145
      # Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
157
146
      # releaselevel of 'dev' for unreleased under-development code.
158
 
 
 
147
     
159
148
     -version_info = (1, 7, 0, 'candidate', 2)
160
149
     +version_info = (1, 7, 0, 'final', 0)
161
 
 
162
 
 
 
150
     
 
151
     
163
152
      # API compatibility version: bzrlib is currently API compatible with 1.7.
164
 
 
 
153
      
165
154
#. Tag the new release::
166
155
 
167
156
     bzr tag bzr-1.14
170
159
   the Internet. PQM will pull from this repository when it attempts to merge
171
160
   your changes. Then submit those changes to PQM for merge into the
172
161
   appropriate release branch::
173
 
 
 
162
 
174
163
     bzr push
175
164
     bzr pqm-submit -m "(mbp) prepare 1.14"
176
165
 
181
170
-------------------------
182
171
 
183
172
#. Change into the source directory and run ::
184
 
 
 
173
  
185
174
     make dist
186
175
 
187
176
#. Now we'll try expanding this tarball and running the test suite
188
177
   to check for packaging problems::
189
 
 
 
178
 
190
179
     make check-dist-tarball
191
180
 
192
181
   You may encounter failures while running the test suite caused
223
212
we have a releasable product.  The next step is to make it generally
224
213
available to the world.
225
214
 
226
 
go to the release
227
 
 
228
 
#. Within that release, upload the source tarball and zipfile and the GPG
229
 
   signature.  Or, if you prefer, use the
230
 
   ``tools/packaging/lp-upload-release`` script to do this.
231
 
 
232
 
#. Link from http://bazaar-vcs.org/SourceDownloads to the tarball and
233
 
   signature.
234
 
 
235
 
#. Announce on the `Bazaar website <http://bazaar-vcs.org/>`_.
236
 
   This page is edited via the lp:bzr-website branch. (Changes
237
 
   pushed to this branch are refreshed by a cron job on escudero.)
238
 
 
239
 
#. Announce on the `Bazaar wiki <http://bazaar-vcs.org/Welcome>`_.
 
215
#. Link from http://bazaar-vcs.org/Download to the tarball and signature.
 
216
 
 
217
#. Announce on the `Bazaar home page <http://bazaar-vcs.org/>`_.
240
218
 
241
219
#. Check that the documentation for this release is available in
242
220
   <http://doc.bazaar-vcs.org>.  It should be automatically build when the
259
237
   ``bazaar-announce`` list too.
260
238
 
261
239
   For final releases, it should also be cc'd to ``info-gnu@gnu.org``,
262
 
   ``python-announce-list@python.org``, ``bug-directory@gnu.org``.
 
240
   ``python-announce-list@python.org``, ``bug-directory@gnu.org``.  
263
241
 
264
242
   In all cases, it is good to set ``Reply-To: bazaar@lists.canonical.com``,
265
243
   so that people who reply to the announcement don't spam other lists.
266
244
 
267
245
   The announce mail will look something like this::
268
 
 
 
246
   
269
247
      Subject: bzr x.yy released!
270
 
 
 
248
      
271
249
      <<Summary paragraph from news>>
272
 
 
273
 
      The Bazaar team is happy to announce availability of a new
 
250
     
 
251
      The Bazaar team is happy to announce availability of a new 
274
252
      release of the bzr adaptive version control system.
275
253
      Bazaar is part of the GNU system <http://gnu.org/>.
276
 
 
 
254
     
277
255
      Thanks to everyone who contributed patches, suggestions, and
278
256
      feedback.
279
 
 
280
 
      Bazaar is now available for download from
281
 
      http://bazaar-vcs.org/Download as a source tarball; packages
 
257
      
 
258
      Bazaar is now available for download from 
 
259
      http://bazaar-vcs.org/Download as a source tarball; packages 
282
260
      for various systems will be available soon.
283
 
 
 
261
      
284
262
      <<NEWS section from this release back to the last major release>>
285
263
 
286
264
   Feel free to tweak this to your taste.
291
269
   ensuring the new topic text keeps the project name, web site link, etc.
292
270
 
293
271
#. Announce on http://freshmeat.net/projects/bzr/
294
 
 
 
272
   
295
273
   This should be done for beta releases, release candidates and final
296
274
   releases. If you do not have a Freshmeat account yet, ask one of the
297
275
   existing admins.
319
297
the version number in ``bzr`` and ``bzrlib/__init__.py``.  Submit this
320
298
back into pqm for bzr.dev.
321
299
 
322
 
As soon as you change the version number in trunk, make sure you have
323
 
created the corresponding milestone to ensure the continuity in bug
324
 
targeting or nominating. Depending on the change, you may even have to
325
 
create a new series (if your change the major or minor release number), in
326
 
that case go to `Starting a cycle` and follow the instructions from there.
327
 
 
328
300
You should also merge (not pull) the release branch into
329
301
``lp:~bzr/bzr/current``, so that branch contains the current released code
330
302
at any time.
331
303
 
332
 
Releases until the final one
333
 
----------------------------
334
 
 
335
 
Congratulations - you have made your first release.  Have a beer
336
 
or fruit juice - it's on the house! If it was a beta, or
337
 
candidate, you're not finished yet. Another beta or candidate or
338
 
hopefully a final release is still to come.
339
 
 
340
 
The process is the same as for the first release. Goto `Starting the
341
 
release phase`_ and follow the instructions again. Some details change
342
 
between beta, candidate and final releases, but they should be
343
 
documented. If the instructions aren't clear enough, please fix them.
344
 
 
345
304
 
346
305
See also
347
306
--------