Add updating AUTHORS to the release checklist
| ... | ... |
@@ -213,7 +213,13 @@ That last command will give you the proper link to visit to ensure that you |
| 213 | 213 |
open the PR against the "release" branch instead of accidentally against |
| 214 | 214 |
"master" (like so many brave souls before you already have). |
| 215 | 215 |
|
| 216 |
-### 7. Build release candidate rpms and debs |
|
| 216 |
+### 7. Create a PR to update the AUTHORS file for the release |
|
| 217 |
+ |
|
| 218 |
+Update the AUTHORS file, by running the `hack/generate-authors.sh` on the |
|
| 219 |
+release branch. To prevent duplicate entries, you may need to update the |
|
| 220 |
+`.mailmap` file accordingly. |
|
| 221 |
+ |
|
| 222 |
+### 8. Build release candidate rpms and debs |
|
| 217 | 223 |
|
| 218 | 224 |
**NOTE**: It will be a lot faster if you pass a different graphdriver with |
| 219 | 225 |
`DOCKER_GRAPHDRIVER` than `vfs`. |
| ... | ... |
@@ -228,7 +234,7 @@ docker run \ |
| 228 | 228 |
hack/make.sh binary build-deb build-rpm |
| 229 | 229 |
``` |
| 230 | 230 |
|
| 231 |
-### 8. Publish release candidate rpms and debs |
|
| 231 |
+### 9. Publish release candidate rpms and debs |
|
| 232 | 232 |
|
| 233 | 233 |
With the rpms and debs you built from the last step you can release them on the |
| 234 | 234 |
same server, or ideally, move them to a dedicated release box via scp into |
| ... | ... |
@@ -252,14 +258,14 @@ docker run --rm -it --privileged \ |
| 252 | 252 |
hack/make.sh release-deb release-rpm sign-repos generate-index-listing |
| 253 | 253 |
``` |
| 254 | 254 |
|
| 255 |
-### 9. Upload the changed repos to wherever you host |
|
| 255 |
+### 10. Upload the changed repos to wherever you host |
|
| 256 | 256 |
|
| 257 | 257 |
For example, above we bind mounted `/volumes/repos` as the storage for |
| 258 | 258 |
`DOCKER_RELEASE_DIR`. In this case `/volumes/repos/apt` can be synced with |
| 259 | 259 |
a specific s3 bucket for the apt repo and `/volumes/repos/yum` can be synced with |
| 260 | 260 |
a s3 bucket for the yum repo. |
| 261 | 261 |
|
| 262 |
-### 10. Publish release candidate binaries |
|
| 262 |
+### 11. Publish release candidate binaries |
|
| 263 | 263 |
|
| 264 | 264 |
To run this you will need access to the release credentials. Get them from the |
| 265 | 265 |
Core maintainers. |
| ... | ... |
@@ -281,7 +287,7 @@ docker run \ |
| 281 | 281 |
It will run the test suite, build the binaries and upload to the specified bucket, |
| 282 | 282 |
so this is a good time to verify that you're running against **test**.docker.com. |
| 283 | 283 |
|
| 284 |
-### 11. Purge the cache! |
|
| 284 |
+### 12. Purge the cache! |
|
| 285 | 285 |
|
| 286 | 286 |
After the binaries are uploaded to test.docker.com and the packages are on |
| 287 | 287 |
apt.dockerproject.org and yum.dockerproject.org, make sure |
| ... | ... |
@@ -315,7 +321,7 @@ We recommend announcing the release candidate on: |
| 315 | 315 |
- The [docker-maintainers](https://groups.google.com/a/dockerproject.org/forum/#!forum/maintainers) group |
| 316 | 316 |
- Any social media that can bring some attention to the release candidate |
| 317 | 317 |
|
| 318 |
-### 12. Iterate on successive release candidates |
|
| 318 |
+### 13. Iterate on successive release candidates |
|
| 319 | 319 |
|
| 320 | 320 |
Spend several days along with the community explicitly investing time and |
| 321 | 321 |
resources to try and break Docker in every possible way, documenting any |
| ... | ... |
@@ -365,7 +371,7 @@ git push -f $GITHUBUSER bump_$VERSION |
| 365 | 365 |
Repeat step 6 to tag the code, publish new binaries, announce availability, and |
| 366 | 366 |
get help testing. |
| 367 | 367 |
|
| 368 |
-### 13. Finalize the bump branch |
|
| 368 |
+### 14. Finalize the bump branch |
|
| 369 | 369 |
|
| 370 | 370 |
When you're happy with the quality of a release candidate, you can move on and |
| 371 | 371 |
create the real thing. |
| ... | ... |
@@ -381,9 +387,9 @@ git commit --amend |
| 381 | 381 |
|
| 382 | 382 |
You will then repeat step 6 to publish the binaries to test |
| 383 | 383 |
|
| 384 |
-### 14. Get 2 other maintainers to validate the pull request |
|
| 384 |
+### 15. Get 2 other maintainers to validate the pull request |
|
| 385 | 385 |
|
| 386 |
-### 15. Build final rpms and debs |
|
| 386 |
+### 16. Build final rpms and debs |
|
| 387 | 387 |
|
| 388 | 388 |
```bash |
| 389 | 389 |
docker build -t docker . |
| ... | ... |
@@ -394,7 +400,7 @@ docker run \ |
| 394 | 394 |
hack/make.sh binary build-deb build-rpm |
| 395 | 395 |
``` |
| 396 | 396 |
|
| 397 |
-### 16. Publish final rpms and debs |
|
| 397 |
+### 17. Publish final rpms and debs |
|
| 398 | 398 |
|
| 399 | 399 |
With the rpms and debs you built from the last step you can release them on the |
| 400 | 400 |
same server, or ideally, move them to a dedicated release box via scp into |
| ... | ... |
@@ -418,14 +424,14 @@ docker run --rm -it --privileged \ |
| 418 | 418 |
hack/make.sh release-deb release-rpm sign-repos generate-index-listing |
| 419 | 419 |
``` |
| 420 | 420 |
|
| 421 |
-### 17. Upload the changed repos to wherever you host |
|
| 421 |
+### 18. Upload the changed repos to wherever you host |
|
| 422 | 422 |
|
| 423 | 423 |
For example, above we bind mounted `/volumes/repos` as the storage for |
| 424 | 424 |
`DOCKER_RELEASE_DIR`. In this case `/volumes/repos/apt` can be synced with |
| 425 | 425 |
a specific s3 bucket for the apt repo and `/volumes/repos/yum` can be synced with |
| 426 | 426 |
a s3 bucket for the yum repo. |
| 427 | 427 |
|
| 428 |
-### 18. Publish final binaries |
|
| 428 |
+### 19. Publish final binaries |
|
| 429 | 429 |
|
| 430 | 430 |
Once they're tested and reasonably believed to be working, run against |
| 431 | 431 |
get.docker.com: |
| ... | ... |
@@ -443,9 +449,9 @@ docker run \ |
| 443 | 443 |
hack/release.sh |
| 444 | 444 |
``` |
| 445 | 445 |
|
| 446 |
-### 19. Purge the cache! |
|
| 446 |
+### 20. Purge the cache! |
|
| 447 | 447 |
|
| 448 |
-### 20. Apply tag and create release |
|
| 448 |
+### 21. Apply tag and create release |
|
| 449 | 449 |
|
| 450 | 450 |
It's very important that we don't make the tag until after the official |
| 451 | 451 |
release is uploaded to get.docker.com! |
| ... | ... |
@@ -464,12 +470,12 @@ You can see examples in this two links: |
| 464 | 464 |
https://github.com/docker/docker/releases/tag/v1.8.0 |
| 465 | 465 |
https://github.com/docker/docker/releases/tag/v1.8.0-rc3 |
| 466 | 466 |
|
| 467 |
-### 21. Go to github to merge the `bump_$VERSION` branch into release |
|
| 467 |
+### 22. Go to github to merge the `bump_$VERSION` branch into release |
|
| 468 | 468 |
|
| 469 | 469 |
Don't forget to push that pretty blue button to delete the leftover |
| 470 | 470 |
branch afterwards! |
| 471 | 471 |
|
| 472 |
-### 22. Update the docs branch |
|
| 472 |
+### 23. Update the docs branch |
|
| 473 | 473 |
|
| 474 | 474 |
You will need to point the docs branch to the newly created release tag: |
| 475 | 475 |
|
| ... | ... |
@@ -488,7 +494,7 @@ distributed CDN system) is flushed. The `make docs-release` command will do this |
| 488 | 488 |
_if_ the `DISTRIBUTION_ID` is set correctly - this will take at least 15 minutes to run |
| 489 | 489 |
and you can check its progress with the CDN Cloudfront Chrome addon. |
| 490 | 490 |
|
| 491 |
-### 23. Create a new pull request to merge your bump commit back into master |
|
| 491 |
+### 24. Create a new pull request to merge your bump commit back into master |
|
| 492 | 492 |
|
| 493 | 493 |
```bash |
| 494 | 494 |
git checkout master |
| ... | ... |
@@ -502,7 +508,7 @@ echo "https://github.com/$GITHUBUSER/docker/compare/docker:master...$GITHUBUSER: |
| 502 | 502 |
Again, get two maintainers to validate, then merge, then push that pretty |
| 503 | 503 |
blue button to delete your branch. |
| 504 | 504 |
|
| 505 |
-### 24. Rejoice and Evangelize! |
|
| 505 |
+### 25. Rejoice and Evangelize! |
|
| 506 | 506 |
|
| 507 | 507 |
Congratulations! You're done. |
| 508 | 508 |
|