@@ -9,7 +9,7 @@ Release Checklist
99These instructions are to assist the Deis maintainers with creating a new Deis
1010product release. Please keep this document up-to-date with any changes in this process.
1111
12- deis Repo
12+ deis repo
1313---------
1414- Create the next `deis milestone `_
1515- Move any `deis open issues `_ from the current release to the next milestone
@@ -21,55 +21,36 @@ deis Repo
2121 * ``git add CHANGELOG.md && git commit -m "docs(CHANGELOG): update for v.X.Y.Z" ``
2222- Merge git master into release branch locally
2323 * ``git checkout release && git merge master ``
24- - Edit contrib/coreos/user-data and update ``DEIS_RELEASE `` to ":vX.Y.Z"
24+ - Update version strings with the ``bumpver `` tool:
25+
26+ .. code-block :: console
27+
28+ $ ./contrib/bumpver/bumpver X.Y.Z \
29+ version/version.go \
30+ client/deis.py \
31+ client/README.rst \
32+ client/setup.py \
33+ contrib/coreos/user-data \
34+ controller/deis/__init__.py \
35+ docs/installing_deis/register-admin-user.rst \
36+ docs/using_deis/install-client.rst
37+
2538 - Commit and push the deis/deis release and tag
26- * remove "-dev" from __version__ fields in Python packages
27- * remove "-dev" from Version constant in version/version.go
2839 * ``git commit -a -m 'chore(release): update version to vX.Y.Z' ``
2940 * ``git push origin release ``
3041 * ``git tag vX.Y.Z ``
3142 * ``git push --tags origin vX.Y.Z ``
32- - At the Docker Hub, create an automatic tagged build ":vX.Y.Z" for every component
3343- Publish CLI to pypi.python.org
3444 - ``cd client && python setup.py sdist upload ``
3545 - use testpypi.python.org first to ensure there aren't any problems
3646- Continuous delivery jobs at ci.deis.io will update the deis CLI. Double-check that the
37- current binaries are publicly downloadable from the opdemand S3 bucket.
38- - Switch master to upcoming release
39- * ``git checkout master ``
40- * update __version__ fields in Python packages to *next * version + "-dev"
41- * update Version constant in version/version.go to *next * version + "-dev"
42- * ``git commit -a -m 'chore(release): update version to vR.S.T-dev' `` (**next ** version)
43- * ``git push origin master ``
47+ current binary installers are publicly downloadable from the opdemand S3 bucket.
4448
45- deisctl repo
49+ deis.io repo
4650------------
47- - Create the next `deisctl milestone `_ to match the next `deis milestone `_
48- - Move any `deisctl open issues `_ from the current release to the next milestone
49- - Close the current `deisctl milestone `_
50- - Update CHANGELOG.md using the `changelog script `_ in the deis project:
51- * ``../deis/contrib/util/generate-changelog.sh vU.V.W vX.Y.Z | cat - CHANGELOG.md > tmp && mv tmp CHANGELOG.md ``
52- substituting the previous release for vU.V.W and the current one for vX.Y.Z.
53- * proofread the new CHANGELOG.md to ensure it was generated correctly
54- * ``git add CHANGELOG.md && git commit -m "docs(CHANGELOG): update for v.X.Y.Z" ``
55- - Continuous delivery jobs at ci.deis.io will update the deisctl installer. Double-check that the
56- current binaries are publicly downloadable from the opdemand S3 bucket.
57- - Commit and push the deis/deisctl release and tag
58- * remove "-dev" from the deis-version file in the project root
59- * remove "-dev" from the string resource in deisctl.go
60- * remove "-dev" from the installer links in README.md
61- * ``git commit -a -m 'chore(release): update version to vX.Y.Z' ``
62- * ``git push origin master ``
63- * ``git tag vX.Y.Z ``
64- * ``git push --tags origin vX.Y.Z ``
65- - Switch master to upcoming release
66- * update deis-version file in the project root to *next * version + "-dev"
67- * update Version constant in deisctl.go to *next * version + "-dev"
68- * ``git commit -a -m 'chore(release): update version to vR.S.T-dev' `` (**next ** version)
69- * ``git push origin master ``
70- - Update deis.io installer script to point to new -dev version
71- * update https://github.com/deis/deis.io/blob/gh-pages/deisctl/install.sh to point to new
72- -dev release version
51+ - Update deis.io installer scripts to point to new versions by default
52+ * update https://github.com/deis/deis.io/blob/gh-pages/deis-cli/install.sh
53+ * update https://github.com/deis/deis.io/blob/gh-pages/deisctl/install.sh
7354
7455Documentation
7556-------------
@@ -89,21 +70,18 @@ Documentation
8970- Check documentation for deis/* projects at the `Docker Hub `_
9071 * click "Settings" for each project (deis/controller, deis/cache, etc.)
9172 * paste the contents of each README.md into the "long description" field if
92- there are discrepencies. (These don't automatically sync up after the
93- Trusted Build is first created.)
73+ there are discrepencies
9474- Create release notes docs
9575 * follow the format of previous `release notes `_
9676 * summarize all work done since the previous release
97- * visit all opdemand/* and deis/* project issues to make sure we don't
77+ * visit all deis/* project issues to make sure we don't
9878 miss any contributors for the "Community Shout-Outs" section
9979 * include "what's next" and "future directions" sections
10080 * add Markdown version of release notes to `deis/deis.io `_ website project
10181
10282
10383.. _`deis milestone` : https://github.com/deis/deis/issues/milestones
10484.. _`deis open issues` : https://github.com/deis/deis/issues?state=open
105- .. _`deisctl milestone` : https://github.com/deis/deisctl/issues/milestones
106- .. _`deisctl open issues` : https://github.com/deis/deisctl/issues?state=open
10785.. _`changelog script` : https://github.com/deis/deis/blob/master/contrib/util/generate-changelog.sh
10886.. _`release notes` : https://github.com/deis/deis/releases
10987.. _`aws-eng S3 bucket` : https://s3-us-west-2.amazonaws.com/opdemand/
0 commit comments