summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorMassimiliano Culpo <massimiliano.culpo@gmail.com>2020-08-26 21:47:47 +0200
committerGitHub <noreply@github.com>2020-08-26 12:47:47 -0700
commit96ac5add9d76156d5d771d1c26f3b0954a3ce3e2 (patch)
tree3b381a917f3210cb267ce4733458ce0bb8e22c6f /lib
parent02dc84a2b3c4f5737e205b25088830c7ad0733ea (diff)
downloadspack-96ac5add9d76156d5d771d1c26f3b0954a3ce3e2.tar.gz
spack-96ac5add9d76156d5d771d1c26f3b0954a3ce3e2.tar.bz2
spack-96ac5add9d76156d5d771d1c26f3b0954a3ce3e2.tar.xz
spack-96ac5add9d76156d5d771d1c26f3b0954a3ce3e2.zip
release procedure: add step to activate the documentation on readthedocs (#18288)
Diffstat (limited to 'lib')
-rw-r--r--lib/spack/docs/developer_guide.rst9
1 files changed, 7 insertions, 2 deletions
diff --git a/lib/spack/docs/developer_guide.rst b/lib/spack/docs/developer_guide.rst
index 284690bd6f..1341a196b4 100644
--- a/lib/spack/docs/developer_guide.rst
+++ b/lib/spack/docs/developer_guide.rst
@@ -620,12 +620,12 @@ for a major release, the steps to make the release are as follows:
#. Bump the version in ``lib/spack/spack/__init__.py``. See `this example from 0.13.0
<https://github.com/spack/spack/commit/8eeb64096c98b8a43d1c587f13ece743c864fba9>`_
-#. Updaate the release version lists in these files to include the new version:
+#. Update the release version lists in these files to include the new version:
* ``lib/spack/spack/schema/container.py``
* ``lib/spack/spack/container/images.json``
- **TODO**: We should get rid of this step in some future release.
+.. TODO: We should get rid of this step in some future release.
#. Update ``CHANGELOG.md`` with major highlights in bullet form. Use
proper markdown formatting, like `this example from 0.15.0
@@ -634,6 +634,7 @@ for a major release, the steps to make the release are as follows:
#. Push the release branch to GitHub.
#. Make sure CI passes on the release branch, including:
+
* Regular unit tests
* Build tests
* The E4S pipeline at `gitlab.spack.io <https://gitlab.spack.io>`_
@@ -795,6 +796,10 @@ Publishing a release on GitHub
page <https://api.github.com/repos/spack/spack/releases>`_ and search
for ``download_count`` to see this.
+#. Go to `readthedocs.org <https://readthedocs.org/projects/spack>`_ and activate
+ the release tag. This builds the documentation and makes the released version
+ selectable in the versions menu.
+
.. _merging-releases: