From 96ac5add9d76156d5d771d1c26f3b0954a3ce3e2 Mon Sep 17 00:00:00 2001 From: Massimiliano Culpo Date: Wed, 26 Aug 2020 21:47:47 +0200 Subject: [PATCH] release procedure: add step to activate the documentation on readthedocs (#18288) --- lib/spack/docs/developer_guide.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/lib/spack/docs/developer_guide.rst b/lib/spack/docs/developer_guide.rst index 284690bd6f9..1341a196b46 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 `_ -#. 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 `_ @@ -795,6 +796,10 @@ Publishing a release on GitHub page `_ and search for ``download_count`` to see this. +#. Go to `readthedocs.org `_ and activate + the release tag. This builds the documentation and makes the released version + selectable in the versions menu. + .. _merging-releases: