docs: Update release checklist with thoughts from 1.7.1.

This commit is contained in:
Greg Price
2017-11-22 16:13:21 -08:00
parent 50ea5ff4b1
commit 49f4c33a57
2 changed files with 24 additions and 15 deletions

View File

@@ -13,33 +13,45 @@ preparing a new release.
* Update `changelog.md` with major changes going into the release. * Update `changelog.md` with major changes going into the release.
* Create a burndown list of bugs that need to be fixed before we can * Create a burndown list of bugs that need to be fixed before we can
release, and make sure all of them are being worked on. release, and make sure all of them are being worked on.
* Draft the release blog post (aka the release notes.)
### Final release preparation ### Final release preparation
* Update `changelog.md` with any final changes since the last update. * Update `changelog.md` with any changes since the last update, and
* Draft the release notes; see previous zulip-announce emails for the with revisions from the draft blog post.
tooling needed.
* Download updated translation strings from Transifex and commit them. * Download updated translation strings from Transifex and commit them.
* Use `build-release-tarball` to generate a release tarball. * Use `build-release-tarball` to generate a release tarball.
* Test the new tarball extensively, both new install and upgrade from last * Test the new tarball extensively, both new install and upgrade from last
release, on both Trusty and Xenial. release, on both Trusty and Xenial.
* Repeat until release is ready. * Repeat until release is ready.
* When near finished: move the blog post draft to Ghost. (For a draft
in Dropbox Paper, use "··· > Download > Markdown" to get a pretty
good markup conversion.) Proofread the post, especially for
formatting.
### Executing the release ### Executing the release
* Do final updates to `changelog.md`. * Do final updates to `changelog.md`, for any final changes and with
any revisions from the draft blog post. (And the date!)
* Update `ZULIP_VERSION` in `version.py`. * Update `ZULIP_VERSION` in `version.py`.
* Update `version` and/or `release` in `docs/conf.py` (ReadTheDocs meta tags). * Update `version` and/or `release` in `docs/conf.py` (ReadTheDocs meta tags).
* Use `build-release-tarball` to generate a final release tarball. * Use `build-release-tarball` to generate a final release tarball.
* Post the release tarball on zulip.org and update zulip.org. * Post the release tarball on https://www.zulip.org/dist/releases/ :
* Add the sha256sum of the release to the file SHA256SUMS.txt in https://www.zulip.org/dist/releases/ add the file, update the `zulip-server-latest.tar.gz` symlink, and
* Create a git tag and push the tag. add to SHA256SUMS.txt.
* Upload the release on GitHub so it doesn't provide a broken release tarball. * Create a Git tag and push the tag.
* Email zulip-announce with the release notes * Post the release on GitHub, using the text from `changelog.md`.
* For a major release, post on the blog, tweet, etc. * Publish the blog post.
* Email zulip-announce, and send a tweet.
* For a major release: submit blog post to aggregators.
### Post-release ### Post-release
* Update `ZULIP_VERSION` in `version.py` to e.g. `1.6.0+git`. Also * Push the release commit to master, if applicable (typically for a
update `docs/conf.py`. major release); otherwise, make sure any last changes make it back
to master.
* Update `ZULIP_VERSION` in `version.py` and `release` in
`docs/conf.py` to e.g. `1.6.0+git`.
* Update the handful of places where we link to docs for the latest
release, rather than for master. See `git grep 'zulip.readthedocs.io/en/[0-9]'`.
* Consider removing a few old releases from ReadTheDocs. * Consider removing a few old releases from ReadTheDocs.

View File

@@ -1,6 +1,3 @@
# When bumping this for a release, we should also update the handful
# of places we link to docs for the latest release, rather than master.
# To find them: git grep 'zulip.readthedocs.io/en/[0-9]'
ZULIP_VERSION = "1.7.1+git" ZULIP_VERSION = "1.7.1+git"
PROVISION_VERSION = '12.1' PROVISION_VERSION = '12.1'