← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/releasing.txt

  • Committer: Robert Collins
  • Date: 2005-08-23 06:52:09 UTC
  • mto: (974.1.50) (1185.1.10) (1092.3.1)
  • mto: This revision was merged to the branch mainline in revision 1139.
  • Revision ID: robertc@robertcollins.net-20050823065209-81cd5962c401751b
move io redirection into each test case from the global runner

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