Browse code

Early API version bump

Signed-off-by: Arnaud Porterie <arnaud.porterie@docker.com>

Arnaud Porterie authored on 2015/04/21 03:24:28
Showing 1 changed files
... ...
@@ -49,7 +49,17 @@ git cherry-pick <commit-id>
49 49
 ...
50 50
 ```
51 51
 
52
-### 2. Update CHANGELOG.md
52
+### 2. Bump the API version on master
53
+
54
+We don't want to stop contributions to master just because we are releasing. At
55
+the same time, now that the release branch exists, we don't want API changes to
56
+go to the now frozen API version.
57
+
58
+Create a new entry in `docs/sources/reference/api/` by copying the latest and
59
+bumping the version number (in both the file's name and content), and submit
60
+this in a PR against master.
61
+
62
+### 3. Update CHANGELOG.md
53 63
 
54 64
 You can run this command for reference with git 2.0:
55 65
 
... ...
@@ -124,7 +134,7 @@ git log --format='%aN <%aE>' v0.7.0...bump_v0.8.0 | sort -uf
124 124
 Obviously, you'll need to adjust version numbers as necessary.  If you just need
125 125
 a count, add a simple `| wc -l`.
126 126
 
127
-### 3. Change the contents of the VERSION file
127
+### 4. Change the contents of the VERSION file
128 128
 
129 129
 Before the big thing, you'll want to make successive release candidates and get
130 130
 people to test. The release candidate number `N` should be part of the version:
... ...
@@ -134,7 +144,7 @@ export RC_VERSION=${VERSION}-rcN
134 134
 echo ${RC_VERSION#v} > VERSION
135 135
 ```
136 136
 
137
-### 4. Test the docs
137
+### 5. Test the docs
138 138
 
139 139
 Make sure that your tree includes documentation for any modified or
140 140
 new features, syntax or semantic changes.
... ...
@@ -153,7 +163,7 @@ To make a shared test at https://beta-docs.docker.io:
153 153
 make AWS_S3_BUCKET=beta-docs.docker.io BUILD_ROOT=yes docs-release
154 154
 ```
155 155
 
156
-### 5. Commit and create a pull request to the "release" branch
156
+### 6. Commit and create a pull request to the "release" branch
157 157
 
158 158
 ```bash
159 159
 git add VERSION CHANGELOG.md
... ...
@@ -166,7 +176,7 @@ That last command will give you the proper link to visit to ensure that you
166 166
 open the PR against the "release" branch instead of accidentally against
167 167
 "master" (like so many brave souls before you already have).
168 168
 
169
-### 6. Publish release candidate binaries
169
+### 7. Publish release candidate binaries
170 170
 
171 171
 To run this you will need access to the release credentials. Get them from the
172 172
 Core maintainers.
... ...
@@ -219,7 +229,7 @@ We recommend announcing the release candidate on:
219 219
 - The [docker-maintainers](https://groups.google.com/a/dockerproject.org/forum/#!forum/maintainers) group
220 220
 - Any social media that can bring some attention to the release candidate
221 221
 
222
-### 7. Iterate on successive release candidates
222
+### 8. Iterate on successive release candidates
223 223
 
224 224
 Spend several days along with the community explicitly investing time and
225 225
 resources to try and break Docker in every possible way, documenting any
... ...
@@ -269,7 +279,7 @@ git push -f $GITHUBUSER bump_$VERSION
269 269
 Repeat step 6 to tag the code, publish new binaries, announce availability, and
270 270
 get help testing.
271 271
 
272
-### 8. Finalize the bump branch
272
+### 9. Finalize the bump branch
273 273
 
274 274
 When you're happy with the quality of a release candidate, you can move on and
275 275
 create the real thing.
... ...
@@ -285,9 +295,9 @@ git commit --amend
285 285
 
286 286
 You will then repeat step 6 to publish the binaries to test
287 287
 
288
-### 9. Get 2 other maintainers to validate the pull request
288
+### 10. Get 2 other maintainers to validate the pull request
289 289
 
290
-### 10. Publish final binaries
290
+### 11. Publish final binaries
291 291
 
292 292
 Once they're tested and reasonably believed to be working, run against
293 293
 get.docker.com:
... ...
@@ -303,7 +313,7 @@ docker run \
303 303
        hack/release.sh
304 304
 ```
305 305
 
306
-### 9. Apply tag
306
+### 12. Apply tag
307 307
 
308 308
 It's very important that we don't make the tag until after the official
309 309
 release is uploaded to get.docker.com!
... ...
@@ -313,12 +323,12 @@ git tag -a $VERSION -m $VERSION bump_$VERSION
313 313
 git push origin $VERSION
314 314
 ```
315 315
 
316
-### 10. Go to github to merge the `bump_$VERSION` branch into release
316
+### 13. Go to github to merge the `bump_$VERSION` branch into release
317 317
 
318 318
 Don't forget to push that pretty blue button to delete the leftover
319 319
 branch afterwards!
320 320
 
321
-### 11. Update the docs branch
321
+### 14. Update the docs branch
322 322
 
323 323
 If this is a MAJOR.MINOR.0 release, you need to make an branch for the previous release's
324 324
 documentation:
... ...
@@ -350,7 +360,7 @@ distributed CDN system) is flushed. The `make docs-release` command will do this
350 350
 _if_ the `DISTRIBUTION_ID` is set correctly - this will take at least 15 minutes to run
351 351
 and you can check its progress with the CDN Cloudfront Chrome addin.
352 352
 
353
-### 12. Create a new pull request to merge your bump commit back into master
353
+### 15. Create a new pull request to merge your bump commit back into master
354 354
 
355 355
 ```bash
356 356
 git checkout master
... ...
@@ -364,17 +374,14 @@ echo "https://github.com/$GITHUBUSER/docker/compare/docker:master...$GITHUBUSER:
364 364
 Again, get two maintainers to validate, then merge, then push that pretty
365 365
 blue button to delete your branch.
366 366
 
367
-### 13. Update the API docs and VERSION files
367
+### 16. Update the VERSION files
368 368
 
369 369
 Now that version X.Y.Z is out, time to start working on the next! Update the
370 370
 content of the `VERSION` file to be the next minor (incrementing Y) and add the
371 371
 `-dev` suffix. For example, after 1.5.0 release, the `VERSION` file gets
372 372
 updated to `1.6.0-dev` (as in "1.6.0 in the making").
373 373
 
374
-Also create a new entry in `docs/sources/reference/api/` by copying the latest
375
-and bumping the version number (in both the file's name and content).
376
-
377
-### 14. Rejoice and Evangelize!
374
+### 17. Rejoice and Evangelize!
378 375
 
379 376
 Congratulations! You're done.
380 377