diff options
Diffstat (limited to 'hack/RELEASE-CHECKLIST.md')
| -rw-r--r-- | hack/RELEASE-CHECKLIST.md | 65 |
1 files changed, 50 insertions, 15 deletions
diff --git a/hack/RELEASE-CHECKLIST.md b/hack/RELEASE-CHECKLIST.md index 84a0ff70e1..31f0adb757 100644 --- a/hack/RELEASE-CHECKLIST.md +++ b/hack/RELEASE-CHECKLIST.md @@ -6,6 +6,21 @@ So you're in charge of a Docker release? Cool. Here's what to do. If your experience deviates from this document, please document the changes to keep it up-to-date. +It is important to note that this document assumes that the git remote in your +repository that corresponds to "https://github.com/dotcloud/docker" is named +"origin". If yours is not (for example, if you've chosen to name it "upstream" +or something similar instead), be sure to adjust the listed snippets for your +local environment accordingly. If you are not sure what your upstream remote is +named, use a command like `git remote -v` to find out. + +If you don't have an upstream remote, you can add one easily using something +like: + +```bash +git remote add origin https://github.com/dotcloud/docker.git +git remote add YOURUSER git@github.com:YOURUSER/docker.git +``` + ### 1. Pull from master and create a release branch ```bash @@ -124,7 +139,7 @@ docker run \ -e AWS_ACCESS_KEY \ -e AWS_SECRET_KEY \ -e GPG_PASSPHRASE \ - -i -t -privileged \ + -i -t --privileged \ docker \ hack/release.sh ``` @@ -158,12 +173,28 @@ docker run \ -e AWS_ACCESS_KEY \ -e AWS_SECRET_KEY \ -e GPG_PASSPHRASE \ - -i -t -privileged \ + -i -t --privileged \ docker \ hack/release.sh ``` -### 9. Apply tag +### 9. Breakathon + +Spend several days along with the community explicitly investing time and +resources to try and break Docker in every possible way, documenting any +findings pertinent to the release. This time should be spent testing and +finding ways in which the release might have caused various features or upgrade +environments to have issues, not coding. During this time, the release is in +code freeze, and any additional code changes will be pushed out to the next +release. + +It should include various levels of breaking Docker, beyond just using Docker +by the book. + +Any issues found may still remain issues for this release, but they should be +documented and give appropriate warnings. + +### 10. Apply tag ```bash git tag -a $VERSION -m $VERSION bump_$VERSION @@ -173,22 +204,26 @@ git push origin $VERSION It's very important that we don't make the tag until after the official release is uploaded to get.docker.io! -### 10. Go to github to merge the `bump_$VERSION` branch into release +### 11. Go to github to merge the `bump_$VERSION` branch into release -Don't delete the leftover branch just yet, as we will need it for the next step. +Don't forget to push that pretty blue button to delete the leftover +branch afterwards! -### 11. Go to github to merge the `bump_$VERSION` branch into docs +### 12. Update the docs branch -Merging the pull request to the docs branch will automatically -update the documentation on the "latest" revision of the docs. You -should see the updated docs 5-10 minutes after the merge. The docs -will appear on http://docs.docker.io/. For more information about -documentation releases, see `docs/README.md`. +```bash +git checkout docs +git fetch +git reset --hard origin/release +git push -f origin docs +``` -Don't forget to push that pretty blue button to delete the leftover -branch afterwards! +Updating the docs branch will automatically update the documentation on the +"latest" revision of the docs. You should see the updated docs 5-10 minutes +after the merge. The docs will appear on http://docs.docker.io/. For more +information about documentation releases, see `docs/README.md`. -### 12. Create a new pull request to merge release back into master +### 13. Create a new pull request to merge release back into master ```bash git checkout master @@ -206,7 +241,7 @@ echo "https://github.com/dotcloud/docker/compare/master...merge_release_$VERSION Again, get two maintainers to validate, then merge, then push that pretty blue button to delete your branch. -### 13. Rejoice and Evangelize! +### 14. Rejoice and Evangelize! Congratulations! You're done. |