Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Add an `unreleased` tag. 

This allows us to conditionally include a note just for unreleased
versions of the docs (i.e., "latest") and omit it when released.
This commit is contained in:
Greg Price 2018-01-23 10:50:55 -08:00
parent d4a86c840d
commit bffc11f824
2 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/conf.py
View File

@ -58,6 +58,11 @@ version = '1.7+git'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '1.7.1+git' release = '1.7.1+git'
# This allows us to insert a warning that appears only on an unreleased
# version, e.g. to say that something is likely to have changed.
if release.endswith('+git'):
tags.add('unreleased')
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
# #

5
docs/subsystems/release-checklist.md
View File

@ -35,6 +35,7 @@ preparing a new release.
any revisions from the draft blog post. (And the date!) 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).
Leave "+git" off.
* 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 https://www.zulip.org/dist/releases/ : * Post the release tarball on https://www.zulip.org/dist/releases/ :
add the file, update the `zulip-server-latest.tar.gz` symlink, and add the file, update the `zulip-server-latest.tar.gz` symlink, and
@ -50,8 +51,8 @@ preparing a new release.
* Push the release commit to master, if applicable (typically for a * Push the release commit to master, if applicable (typically for a
major release); otherwise, make sure any last changes make it back major release); otherwise, make sure any last changes make it back
to master. to master.
* Update `ZULIP_VERSION` in `version.py` and `release` in * Update `ZULIP_VERSION` in `version.py`, and `release` and `version` in
`docs/conf.py` to e.g. `1.6.0+git`. `docs/conf.py`, to e.g. `1.6.0+git`.
* Update the handful of places where we link to docs for the latest * 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]'`. 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.