~bzr-pqm/bzr/bzr.dev : revision 5264.2.1

1

Releasing Bazaar

2

================

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

19

20

21

Preconditions

22

-------------

22

=============

23

24

#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::

25

26

bzr branch lp:bzr-pqm ~/.bazaar/plugins/pqm

27

28

29

Starting a cycle

30

----------------

29

At the start of a release cycle

30

===============================

31

32

To start a new release cycle:

33

34

#. Create a new series at <https://launchpad.net/bzr/+addseries>. There is one

35

series for every *x.y* release.

36

37

#. Go to the series web page at <https://launchpad.net/bzr/x.y>

38

39

#. Create a new release at

40

<https://launchpad.net/bzr/x.y/+addrelease> and add

41

information about this release. We will not use it yet, but it

34

#. If this is the first release for a given *x.y* then create a new

35

series at <https://launchpad.net/bzr/+addseries>. There is one series

36

for every *x.y* release.

37

38

#. If you made a new series, create a new pqm-controlled branch for this

39

release series, by asking a Canonical sysadmin. This branch means that

40

from the first release beta or candidate onwards, general development

41

continues on the trunk, and only specifically-targeted fixes go into

42

the release branch.

43

44

#. If you made a new series, add milestones at

45

<https://edge.launchpad.net/bzr/x.y/+addmilestone> to that series for

46

the beta release, release candidate and the final release, and their

47

expected dates.

48

49

#. Create a new milestone <https://edge.launchpad.net/bzr/x.y/+addmilestone>

50

and add information about this release. We will not use it yet, but it

42

51

will be available for targeting or nominating bugs.

43

52

44

#. We create a new pqm-controlled branch for this release series, by

45

asking a Canonical sysadmin.

46

This branch means that from the first release beta or candidate onwards,

47

general development continues on the trunk, and only

48

specifically-targeted fixes go into the release branch.

49

50

#. Add milestones at <https://edge.launchpad.net/bzr/x.y/+addmilestone> to

51

that series for the beta release, release candidate and the final release,

52

and their expected dates.

53

54

#. 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.

57

58

#. Add a new section at the top of ``NEWS`` about the new release,

59

including its version number and the headings from

60

``NEWS-template.txt``.

61

62

53

#. Send mail to the list with the key dates, who will be the release

63

54

manager, and the main themes or targeted bugs. Ask people to nominate

64

55

objectives, or point out any high-risk things that are best done early,

71

62

bzr branch trunk prepare-1.14

72

63

73

64

#. Configure pqm-submit for this branch, with a section like this (where

74

x.y is the version to release).

65

x.y is the version to release). **Or use hydrazine for easy use**

75

66

``~/.bazaar/locations.conf``::

76

67

77

68

[/home/mbp/bzr/prepare-x.y]

85

76

Please see <http://doc.bazaar-vcs.org/developers/HACKING.html#an-overview-of-pqm>

86

77

for more details on PQM

87

78

79

#. Update the version number in the ``bzr`` script, and the

80

``bzrlib/__init__.py`` file::

81

82

version_info = (x, y, z, 'dev', 0)

83

84

#. Add a new section at the top of ``NEWS`` about the new release,

85

including its version number and the headings from

86

``NEWS-template.txt``.

87

88

#. Commit this and send it to PQM.

89

90

91

Doing a particular release

92

==========================

93

94

Update the source code

95

----------------------

96

97

#. Check that there is a milestone for the release you're doing. If there

98

is no milestone it indicates a process problem - make the milestone but

99

also mail the list to raise this issue in our process. Milestones are

100

found at <https://launchpad.net/bzr/+milestone/x.y.z>.

101

88

102

#. In the release branch, update ``version_info`` in ``./bzrlib/__init__.py``.

89

103

Make sure the corresponding milestone exists.

90

104

Double check that ./bzr ``_script_version`` matches ``version_info``. Check

92

106

93

107

For beta releases use::

94

108

109

version_info = (2, 1, 0, 'beta', SERIAL)

110

111

For instance 2.1b1::

112

95

113

version_info = (2, 1, 0, 'beta', 1)

96

114

97

98

115

For release candidates use::

99

116

100

version_info = (2, 0, 1, 'candidate', 1)

101

102

103

Starting the release phase

104

--------------------------

105

106

#. Create a new milestone at <https://launchpad.net/bzr/x.y/+addmilestone>

107

for the beta release or release candidate if you haven't already.

108

109

#. Add the date and release number to ``./NEWS``

110

111

Depending on whether you're doing a beta or a bugfix release, you'll

112

have to create a NEWS section for your release in the right

113

place. Most of the time, the new section is at the top of the file

114

(look what have been done for the various 2.0x and 2.1.0bx releases).

115

The rule is to keep the sections sorted by date. You'll need to be

116

cautious when merging back to trunk to respect that.

117

version_info = (2, 0, 1, 'candidate', SERIAL)

118

119

For stable releases use::

120

121

version_info = (2, 1, 2, 'final', 0)

122

123

#. Check the release number in ``./NEWS``

124

125

Fill out the date and a description of the release under the existing

126

header. If there isn't one, follow the above for using the NEWS

127

template.

128

129

See *2.1.1* or similar for an example of what this looks like.

117

130

118

131

#. To check that all bugs mentioned in ``./NEWS`` are actually marked as

119

132

closed in Launchpad, you can run ``tools/check-newsbugs.py``::

120

133

121

134

./tools/check-newsbugs.py NEWS

122

135

123

(But note there can be some false positives, and this script may be

136

(But note there will be many false positives, and this script may be

124

137

flaky <https://bugs.edge.launchpad.net/bzr/+bug/354985>. Don't let

125

138

this slow you down too much.)

126

139

127

#. Summarize into one or two paragraphs what's new in this release.

128

129

140

#. Commit these changes to the release branch, using a command like::

130

141

131

142

bzr commit -m "Release 1.14."

170

181

171

182

bzr tag bzr-1.14

172

183

173

#. Push those changes to a bzr reposistory that is public and accessible on

184

#. Push those changes to a bzr repository that is public and accessible on

174

185

the Internet. PQM will pull from this repository when it attempts to merge

175

186

your changes. Then submit those changes to PQM for merge into the

176

187

appropriate release branch::

178

189

bzr push

179

190

bzr pqm-submit -m "(mbp) prepare 1.14"

180

191

192

Or with hydrazine::

193

194

bzr lp-propose -m "Release 1.14" --approve lp:bzr/1.14

195

feed-pqm bzr

196

181

197

#. When PQM succeeds, pull down the master release branch.

182

198

183

199

215

disable the faulty plugins one by one until you get no more

200

216

failures.

201

217

218

Remember that PQM has just tested everything too, this step is

219

particularly testing that the pyrex extensions, which are updated

220

by your local pyrex version when you run make dist, are in good

221

shape.

222

202

223

203

224

Publishing the source tarball

204

225

-----------------------------

205

226

206

227

#. Go to the relevant milestone page in Launchpad.

207

228

208

#. Within that release, upload the source tarball and the GPG

209

signature. Or, if you prefer, use the

210

``tools/packaging/lp-upload-release`` script to do this.

229

#. Create a release of the milestone, and upload the source tarball and

230

the GPG signature. Or, if you prefer, use the

231

``tools/packaging/lp-upload-release`` script to do this. Note that

232

this changes what the download widget on the Launchpad bzr home

233

page shows, so don't stop the release process yet, or platform binary

234

installers won't be made and the download list will stay very small!

235

<https://bugs.edge.launchpad.net/launchpad/+bug/586445>

211

236

212

237

213

238

Announcing the source freeze

219

244

release.

220

245

221

246

247

Kick off the next cycle

248

-----------------------

249

250

#. To let developers work on the next release, do

251

`At the start of a release cycle` now.

252

253

#. Pause for a few days.

254

255

222

256

Publishing the release

223

257

----------------------

224

258

227

261

we have a releasable product. The next step is to make it generally

228

262

available to the world.

229

263

230

go to the release

231

232

#. Within that release, upload the source tarball and zipfile and the GPG

233

signature. Or, if you prefer, use the

234

``tools/packaging/lp-upload-release`` script to do this.

264

#. Go to the release web page at <https://launchpad.net/bzr/x.y/x.y.z>

235

265

236

266

#. Link from http://bazaar-vcs.org/SourceDownloads to the tarball and

237

267

signature.

270

300

271

301

The announce mail will look something like this::

272

302

273

Subject: bzr x.yy released!

303

Subject: bzr x.y.z released!

274

304

275

305

<<Summary paragraph from news>>

276

306

318

348

Merging the released code back to trunk

319

349

---------------------------------------

320

350

351

The rule is to keep ``NEWS`` sections sorted by date. You'll need to

352

review the merge and make sure that that is respected.

353

321

354

Merge the release branch back into the trunk. Check that changes in NEWS

322

355

were merged into the right sections. If it's not already done, advance

323

356

the version number in ``bzr`` and ``bzrlib/__init__.py``. Submit this

327

360

created the corresponding milestone to ensure the continuity in bug

328

361

targeting or nominating. Depending on the change, you may even have to

329

362

create a new series (if your change the major or minor release number), in

330

that case go to `Starting a cycle` and follow the instructions from there.

363

that case go to `At the start of a release cycle` and follow the instructions from there.

331

364

332

365

You should also merge (not pull) the release branch into

333

366

``lp:~bzr/bzr/current``, so that branch contains the current released code

341

374

candidate, you're not finished yet. Another beta or candidate or

342

375

hopefully a final release is still to come.

343

376

344

The process is the same as for the first release. Goto `Starting the

345

release phase`_ and follow the instructions again. Some details change

377

The process is the same as for the first release. Goto `Doing a

378

particular release`_ and follow the instructions again. Some details change

346

379

between beta, candidate and final releases, but they should be

347

380

documented. If the instructions aren't clear enough, please fix them.

348

381