Skip to content

Commit be1047a

Browse files
committed
Merge pull request #2253 from mboersma/update-release-docs
docs(releases): update with post-release "+git" procedures
2 parents 503b082 + 0b60803 commit be1047a

1 file changed

Lines changed: 34 additions & 5 deletions

File tree

docs/contributing/releases.rst

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,10 @@ product release. Please keep this document up-to-date with any changes in this p
1111

1212
deis repo
1313
---------
14-
- Create the next `deis milestone`_
15-
- Move any `deis open issues`_ from the current release to the next milestone
16-
- Close the current `deis milestone`_
14+
- If this release was managed as a milestone in GitHub:
15+
* Create the next `deis milestone`_
16+
* Move any `deis open issues`_ from the current release to the next milestone
17+
* Close the current `deis milestone`_
1718
- Create a branch for the release PR: ``git checkout -b release-X.Y.Z``
1819
- Update CHANGELOG.md using the `changelog script`_
1920
* ``./contrib/util/generate-changelog.sh vU.V.W | cat - CHANGELOG.md > tmp && mv tmp CHANGELOG.md``
@@ -31,11 +32,14 @@ deis repo
3132
deisctl/deis-version \
3233
deisctl/deisctl.go \
3334
deisctl/README.md \
34-
deisctl/cmd/cmd.go \
3535
contrib/coreos/user-data \
3636
controller/deis/__init__.py \
3737
README.md
3838
39+
- Edit deisctl/cmd/cmd.go and change the default in the RefreshUnits usage string
40+
(near the bottom of the file) from ``[master]`` to ``[vX.Y.Z]``.
41+
- Examine the output of ``git grep vU.V.W`` to ensure that no old version strings
42+
were missed
3943
- Commit and push the deis/deis release and tag
4044
* ``git commit -a -m 'chore(release): update version to vX.Y.Z'``
4145
* ``git push origin release-X.Y.Z``
@@ -74,13 +78,38 @@ Documentation
7478
* click "Settings" for each project (deis/controller, deis/cache, etc.)
7579
* paste the contents of each README.md into the "long description" field if
7680
there are discrepencies
77-
- Create release notes docs
81+
- For a milestone release, create release notes docs
7882
* follow the format of previous `release notes`_
7983
* summarize all work done since the previous release
8084
* visit all deis/* project issues to make sure we don't
8185
miss any contributors for the "Community Shout-Outs" section
8286
* include "what's next" and "future directions" sections
8387
* add Markdown version of release notes to `deis/deis.io`_ website project
88+
- For a patch release, paste the new CHANGELOG.md section as GitHub release notes
89+
90+
Post-Release
91+
------------
92+
- Update the #deis IRC channel topic to reference the newly released version
93+
- For a milestone release, update HipChat channel topics to reference the
94+
next planned version
95+
- Create a branch for the post-release PR: ``git checkout -b release-X.Y.Z+git``
96+
- Update version strings to vX.Y.Z+git with the ``bumpver`` tool:
97+
98+
.. code-block:: console
99+
100+
$ ./contrib/bumpver/bumpver X.Y.Z+git \
101+
version/version.go \
102+
client/deis.py \
103+
deisctl/deis-version \
104+
deisctl/deisctl.go \
105+
controller/deis/__init__.py \
106+
README.md
107+
108+
- Edit deisctl/cmd/cmd.go and change the default in the RefreshUnits usage string
109+
(near the bottom of the file) from ``[vX.Y.Z]`` to ``[master]``.
110+
- Create a pull request for vX.Y.Z+git
111+
* ``git commit -a -m 'chore(release): update version in master to vX.Y.Z+git'``
112+
- Ensure that this PR is merged before others are allowed to be merged!
84113

85114

86115
.. _`deis milestone`: https://github.com/deis/deis/issues/milestones

0 commit comments

Comments
 (0)