Skip to content

Commit 67d3a45

Browse files
committed
docs(releases): update release procedure with deisctl tasks
1 parent d3ff1ce commit 67d3a45

1 file changed

Lines changed: 43 additions & 20 deletions

File tree

docs/contributing/releases.rst

Lines changed: 43 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,47 +17,68 @@ product release.
1717

1818
Please keep this document up-to-date with any changes in this process.
1919

20-
github.com/deis/deis Repo
21-
-------------------------
20+
deis Repo
21+
---------
2222
- Create the next `deis milestone`_
23-
- Move any `deis open issues`_ from the current release to the
24-
next milestone
23+
- Move any `deis open issues`_ from the current release to the next milestone
2524
- Close the current `deis milestone`_
26-
- Recreate CHANGELOG.md in the root of the project using the `changelog script`_
25+
- Update CHANGELOG.md using the `changelog script`_
2726
* ``./contrib/util/generate-changelog.sh vU.V.W vX.Y.Z | cat - CHANGELOG.md > tmp && mv tmp CHANGELOG.md``
2827
substituting the previous release for vU.V.W and the current one for vX.Y.Z.
2928
* proofread the new CHANGELOG.md to ensure it was generated correctly
30-
* ``git add CHANGELOG.md && git commit -m "Updated CHANGELOG.md."``
29+
* ``git add CHANGELOG.md && git commit -m "docs(CHANGELOG): update for v.X.Y.Z"``
3130
- Merge git master into release branch locally
3231
* ``git checkout release && git merge master``
3332
- Edit contrib/coreos/user-data and update ``DEIS_RELEASE`` to ":vX.Y.Z"
34-
- At the Docker Index, create a tagged image build ":vX.Y.Z" for every component
35-
* The UI for this is well-hidden: go to https://index.docker.io/builds/ and
36-
click "Edit".
3733
- Commit and push the deis/deis release and tag
3834
* remove "-dev" from __version__ fields in Python packages
3935
* remove "-dev" from Version constant in version/version.go
40-
* ``git commit -a -m 'Updated for vX.Y.Z release.'``
36+
* ``git commit -a -m 'chore(release): update version to vX.Y.Z'``
4137
* ``git push origin release``
4238
* ``git tag vX.Y.Z``
4339
* ``git push --tags origin vX.Y.Z``
40+
- At the Docker Hub, create an automatic tagged build ":vX.Y.Z" for every component
4441
- Publish CLI to pypi.python.org
4542
- ``cd client && python setup.py sdist upload``
4643
- use testpypi.python.org first to ensure there aren't any problems
47-
- Create CLI binaries for Windows, Mac OS X, Debian
48-
- ``pip install pyinstaller && make -C controller client``
49-
- build **deis-osx-X.Y.Z.tgz** on Mac OS X 10.9
50-
- build **deis-win64-X.Y.Z.zip** on Windows 7 64-bit
51-
- build **deis-ubuntu-X.Y.Z.tgz** on Ubuntu 14.04
52-
- upload all binaries to the `aws-eng S3 bucket`_ and set each as
53-
publically downloadable
44+
- Continuous delivery jobs at ci.deis.io will update the deis CLI. Double-check that the
45+
current binaries are publicly downloadable from the opdemand S3 bucket.
5446
- Switch master to upcoming release
5547
* ``git checkout master``
5648
* update __version__ fields in Python packages to *next* version + "-dev"
5749
* update Version constant in version/version.go to *next* version + "-dev"
58-
* ``git commit -a -m 'Switch master to vA.B.C.'`` (**next** version)
50+
* ``git commit -a -m 'chore(release): update version to vR.S.T-dev'`` (**next** version)
5951
* ``git push origin master``
6052

53+
deisctl repo
54+
------------
55+
- Create the next `deisctl milestone`_ to match the next `deis milestone`_
56+
- Move any `deisctl open issues`_ from the current release to the next milestone
57+
- Close the current `deisctl milestone`_
58+
- Update CHANGELOG.md using the `changelog script`_ in the deis project:
59+
* ``../deis/contrib/util/generate-changelog.sh vU.V.W vX.Y.Z | cat - CHANGELOG.md > tmp && mv tmp CHANGELOG.md``
60+
substituting the previous release for vU.V.W and the current one for vX.Y.Z.
61+
* proofread the new CHANGELOG.md to ensure it was generated correctly
62+
* ``git add CHANGELOG.md && git commit -m "docs(CHANGELOG): update for v.X.Y.Z"``
63+
- Continuous delivery jobs at ci.deis.io will update the deisctl installer. Double-check that the
64+
current binaries are publicly downloadable from the opdemand S3 bucket.
65+
- Commit and push the deis/deisctl release and tag
66+
* remove "-dev" from the deis-version file in the project root
67+
* remove "-dev" from the string resource in deisctl.go
68+
* remove "-dev" from the installer links in README.md
69+
* ``git commit -a -m 'chore(release): update version to vX.Y.Z'``
70+
* ``git push origin master``
71+
* ``git tag vX.Y.Z``
72+
* ``git push --tags origin vX.Y.Z``
73+
- Switch master to upcoming release
74+
* update deis-version file in the project root to *next* version + "-dev"
75+
* update Version constant in deisctl.go to *next* version + "-dev"
76+
* ``git commit -a -m 'chore(release): update version to vR.S.T-dev'`` (**next** version)
77+
* ``git push origin master``
78+
- Update deis.io installer script to point to new -dev version
79+
* update https://github.com/deis/deis.io/blob/gh-pages/deisctl/install.sh to point to new
80+
-dev release version
81+
6182
Documentation
6283
-------------
6384
- (CHANGELOG.md files were regenerated and committed above.)
@@ -73,7 +94,7 @@ Documentation
7394
* the zipfile will be at **docs/docs.zip**
7495
* log in to http://pypi.python.org/ and use the web form at the
7596
`Deis Pypi`_ page to upload the zipfile
76-
- Check documentation for deis/* projects at the `Docker Index`_
97+
- Check documentation for deis/* projects at the `Docker Hub`_
7798
* click "Settings" for each project (deis/controller, deis/cache, etc.)
7899
* paste the contents of each README.md into the "long description" field if
79100
there are discrepencies. (These don't automatically sync up after the
@@ -89,9 +110,11 @@ Documentation
89110

90111
.. _`deis milestone`: https://github.com/deis/deis/issues/milestones
91112
.. _`deis open issues`: https://github.com/deis/deis/issues?state=open
113+
.. _`deisctl milestone`: https://github.com/deis/deisctl/issues/milestones
114+
.. _`deisctl open issues`: https://github.com/deis/deisctl/issues?state=open
92115
.. _`changelog script`: https://github.com/deis/deis/blob/master/contrib/util/generate-changelog.sh
93116
.. _`release notes`: https://github.com/deis/deis/releases
94117
.. _`aws-eng S3 bucket`: https://s3-us-west-2.amazonaws.com/opdemand/
95118
.. _`Deis Pypi`: https://pypi.python.org/pypi/deis/
96-
.. _`Docker Index`: https://index.docker.io/
119+
.. _`Docker Hub`: https://hub.docker.com/
97120
.. _`deis/deis.io`: https://github.com/deis/deis.io

0 commit comments

Comments
 (0)