/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-06-15 09:07:02 UTC
  • mto: This revision was merged to the branch mainline in revision 4441.
  • Revision ID: robertc@robertcollins.net-20090615090702-okjak2a1t826no8n
Unbreak blackbox tests.

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