/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to doc/developers/releasing.txt

  • Committer: Robert Collins
  • Date: 2009-08-27 21:48:33 UTC
  • mto: This revision was merged to the branch mainline in revision 4663.
  • Revision ID: robertc@robertcollins.net-20090827214833-nlq6gi269u05hnf6
Test split with unversioned files within the test tree.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/releasing.txt
 
1
Releasing Bazaar
 
2
================
 
3
 
 
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 
 
6
`overall development cycle <cycle.html>`_, but it's the most complex part.
 
7
This document gives a checklist you can follow from start to end in one
 
8
go.
 
9
 
 
10
.. contents::
 
11
 
 
12
 
 
13
Preconditions
 
14
-------------
 
15
 
 
16
#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::
 
17
 
 
18
     bzr branch lp:bzr-pqm ~/.bazaar/plugins/pqm
 
19
 
 
20
Starting the release phase
 
21
--------------------------
 
22
 
 
23
When it's time to make the release candidate:
 
24
 
 
25
#. We create a new pqm-controlled branch for this release series, by
 
26
   asking a Canonical sysadmin.  
 
27
   This branch means that from the first release candidate onwards,
 
28
   general development continues on the trunk, and only
 
29
   specifically-targetted fixes go into the release.
 
30
 
 
31
#. Register the branch at <https://launchpad.net/products/bzr/+addbranch>
 
32
 
 
33
#. Make a release candidate.
 
34
 
 
35
 
 
36
Preparing the tree for release
 
37
------------------------------
 
38
 
 
39
#. Make a local branch for preparing this release.  (Only for the first 
 
40
   release in a series, otherwise you should already have a branch.) ::
 
41
 
 
42
     bzr branch trunk prepare-1.14
 
43
 
 
44
#. Configure pqm-submit for this branch, with a section like this in
 
45
   ``~/.bazaar/locations.conf``::
 
46
 
 
47
        [/home/mbp/bzr/prepare-1.14]
 
48
        pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
 
49
        submit_branch = http://bazaar-vcs.org/bzr/bzr.1.14
 
50
        public_branch = http://bazaar.your-domain.com/bzr
 
51
        submit_to = bazaar@lists.canonical.com
 
52
        smtp_server = mail.your-domain.com:25
 
53
 
 
54
    Please see <http://doc.bazaar-vcs.org/latest/developers/HACKING.html#an-overview-of-pqm>
 
55
    for more details on PQM
 
56
 
 
57
#. In the release branch, update  ``version_info`` in ``./bzrlib/__init__.py``.
 
58
   Double check that ./bzr ``_script_version`` matches ``version_info``. Check
 
59
   the output of ``bzr --version``. 
 
60
 
 
61
#. Add the date and release number to ``./NEWS``
 
62
 
 
63
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
 
64
   closed in Launchpad, you can run ``tools/check-newsbugs.py``::
 
65
 
 
66
     ./tools/check-newsbugs.py NEWS
 
67
 
 
68
   (But note there can be some false positives, and this script may be
 
69
   flaky <https://bugs.edge.launchpad.net/bzr/+bug/354985>.  Don't let
 
70
   this slow you down too much.)
 
71
 
 
72
#. Summarize into one or two paragraphs what's new in this release.
 
73
 
 
74
#. Commit these changes to the release branch, using a command like::
 
75
    
 
76
     bzr commit -m "Release 1.14." 
 
77
   
 
78
   The diff before you commit will be something like::
 
79
 
 
80
     === modified file 'NEWS'
 
81
     --- NEWS        2008-09-17 23:09:18 +0000
 
82
     +++ NEWS        2008-09-23 16:14:54 +0000
 
83
     @@ -4,6 +4,23 @@
 
84
     
 
85
      .. contents::
 
86
     
 
87
     +bzr 1.7 2008-09-23
 
88
     +------------------
 
89
     +
 
90
     +This release includes many bug fixes and a few performance and feature
 
91
     +improvements.  ``bzr rm`` will now scan for missing files and remove them,
 
92
     +like how ``bzr add`` scans for unknown files and adds them. A bit more
 
93
     +polish has been applied to the stacking code. The b-tree indexing code has
 
94
     +been brought in, with an eye on using it in a future repository format.
 
95
     +There are only minor installer changes since bzr-1.7rc2.
 
96
     +
 
97
      bzr 1.7rc2 2008-09-17
 
98
      ---------------------
 
99
     
 
100
     
 
101
     === modified file 'bzrlib/__init__.py'
 
102
     --- bzrlib/__init__.py  2008-09-16 21:39:28 +0000
 
103
     +++ bzrlib/__init__.py  2008-09-23 16:14:54 +0000
 
104
     @@ -41,7 +41,7 @@
 
105
      # Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
 
106
      # releaselevel of 'dev' for unreleased under-development code.
 
107
     
 
108
     -version_info = (1, 7, 0, 'candidate', 2)
 
109
     +version_info = (1, 7, 0, 'final', 0)
 
110
     
 
111
     
 
112
      # API compatibility version: bzrlib is currently API compatible with 1.7.
 
113
      
 
114
#. Tag the new release::
 
115
 
 
116
     bzr tag bzr-1.14
 
117
 
 
118
#. Push those changes to a bzr reposistory that is public and accessible on
 
119
   the Internet. PQM will pull from this repository when it attempts to merge
 
120
   your changes. Then submit those changes to PQM for merge into the
 
121
   appropriate release branch::
 
122
 
 
123
     bzr push
 
124
     bzr pqm-submit -m "(mbp) prepare 1.14"
 
125
 
 
126
#. When PQM succeeds, pull down the master release branch.
 
127
 
 
128
 
 
129
Making the source tarball
 
130
-------------------------
 
131
 
 
132
#. Change into the source directory and run ::
 
133
  
 
134
     make dist
 
135
 
 
136
   This also makes a zip file, which is easier to access on Microsoft
 
137
   Windows.
 
138
 
 
139
#. Now we'll try expanding this tarball and running the test suite
 
140
   to check for packaging problems::
 
141
 
 
142
     make check-dist-tarball
 
143
 
 
144
 
 
145
Publishing the release
 
146
----------------------
 
147
 
 
148
Now you have the releasable product.  The next step is making it
 
149
available to the world.
 
150
 
 
151
#. In <https://launchpad.net/bzr/> click the "Release series" for this
 
152
   series, to take you to e.g. <https://launchpad.net/bzr/1.14>.  Then
 
153
   click "Register a release", and add information about this release.
 
154
 
 
155
#. Within that release, upload the source tarball and zipfile and the GPG
 
156
   signature.  Or, if you prefer, use the
 
157
   ``tools/packaging/lp-upload-release`` script to do this.
 
158
 
 
159
#. Link from http://bazaar-vcs.org/Download to the tarball and signature.
 
160
 
 
161
#. Announce on the `Bazaar home page <http://bazaar-vcs.org/>`_.
 
162
 
 
163
#. Check that the documentation for this release is available in 
 
164
   <http://doc.bazaar-vcs.org>.  It should be automatically build when the 
 
165
   branch is created, by a cron script ``update-bzr-docs`` on
 
166
   ``escudero``.
 
167
 
 
168
 
 
169
Announcing the release
 
170
----------------------
 
171
 
 
172
Now that the release is publicly available, tell people about it.
 
173
 
 
174
#. Make an announcement mail.
 
175
 
 
176
   For release candidates, this is sent to the ``bazaar-announce`` and
 
177
   ``bazaar`` lists.  For final releases, it should also be cc'd to 
 
178
   ``info-gnu@gnu.org``, ``python-announce-list@python.org``, 
 
179
   ``bug-directory@gnu.org``.  In both cases, it is good to set
 
180
   ``Reply-To: bazaar@lists.canonical.com``, so that people who reply to
 
181
   the announcement don't spam other lists.
 
182
 
 
183
   The announce mail will look something like this::
 
184
   
 
185
      Subject: bzr x.yy released!
 
186
      
 
187
      <<Summary paragraph from news>>
 
188
     
 
189
      The Bazaar team is happy to announce availability of a new 
 
190
      release of the bzr adaptive version control system.
 
191
      Bazaar is part of the GNU system <http://gnu.org/>.
 
192
     
 
193
      Thanks to everyone who contributed patches, suggestions, and
 
194
      feedback.
 
195
      
 
196
      Bazaar is now available for download from 
 
197
      http://bazaar-vcs.org/Download as a source tarball; packages 
 
198
      for various systems will be available soon.
 
199
      
 
200
      <<NEWS section from this release back to the last major release>>
 
201
 
 
202
   Feel free to tweak this to your taste.
 
203
 
 
204
#. Make an announcement through <https://launchpad.net/bzr/+announce>
 
205
 
 
206
#. Update the IRC channel topic. Use the ``/topic`` command to do this,
 
207
   ensuring the new topic text keeps the project name, web site link, etc.
 
208
 
 
209
#. Announce on http://freshmeat.net/projects/bzr/
 
210
   
 
211
   This should be done for both release candidates and final releases. If
 
212
   you do not have a Freshmeat account yet, ask one of the existing
 
213
   admins.
 
214
 
 
215
#. Update `<http://en.wikipedia.org/wiki/Bazaar_(software)>`_ -- this should be done
 
216
for final releases but not for Release Candidates.
 
217
 
 
218
#. Update the python package index: <http://pypi.python.org/pypi/bzr> - best
 
219
   done by running ::
 
220
 
 
221
       python setup.py register
 
222
 
 
223
   Remember to check the results afterwards.
 
224
 
 
225
   To be able to register the release you must create an account on
 
226
   <http://pypi.python.org/pypi> and have one of the existing owners of
 
227
   the project add you to the group.
 
228
 
 
229
 
 
230
Merging the released code back to trunk
 
231
---------------------------------------
 
232
 
 
233
Merge the release branch back into the trunk.  Check that changes in NEWS
 
234
were merged into the right sections.  If it's not already done, advance
 
235
the version number in ``bzr`` and ``bzrlib/__init__.py``.  Submit this
 
236
back into pqm for bzr.dev.
 
237
 
 
238
You should also merge (not pull) the release branch into
 
239
``lp:~bzr/bzr/current``, so that branch contains the current released code
 
240
at any time.
 
241
 
 
242
 
 
243
Starting a cycle
 
244
----------------
 
245
 
 
246
To start a new release cycle:
 
247
 
 
248
#. Send mail to the list with the key dates, who will be the release
 
249
   manager, and the main themes or targeted bugs.  Ask people to nominate
 
250
   objectives, or point out any high-risk things that are best done early,
 
251
   or that interact with other changes.
 
252
 
 
253
#. Add a new "series" in Launchpad at <https://launchpad.net/bzr/+addseries>.  
 
254
   There is one series for every *x.y* release.
 
255
 
 
256
#. Add milestones to that series for the release candidate and the final
 
257
   release, and their expected dates.
 
258
 
 
259
#. Deactivate old releases and their milestones.
 
260
 
 
261
#. Update the version number in the ``bzr`` script, and the
 
262
   ``bzrlib/__init__.py`` file.
 
263
 
 
264
 
 
265
See also
 
266
--------
 
267
 
 
268
* `Packaging into the bzr PPA <ppa.html>`_ to make and publish Ubuntu
 
269
  packages.
 
270
* `Bazaar Developer Document Catalog <index.html>`_
 
271
* `Development cycles <cycle.html>`_: things that happen during the cycle
 
272
  before the actual release.
 
273
 
 
274
..
 
275
   vim: filetype=rst textwidth=74 ai shiftwidth=4