Skip to content

Commit

Permalink
Update release guide (#4963)
Browse files Browse the repository at this point in the history
* update release guide

* adress review comments
  • Loading branch information
stephenworsley committed Sep 22, 2022
1 parent d18b84c commit a131d86
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions docs/src/developers_guide/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -224,17 +224,14 @@ These steps assume a release for ``1.9.0`` is to be created.
Release Steps
~~~~~~~~~~~~~

#. Create the release feature branch ``v1.9.x`` on `SciTools/iris`_.
The only exception is for a point/bugfix release, as it should already exist
#. Update the ``iris.__init__.py`` version string e.g., to ``1.9.0``
#. Update the ``whatsnew`` for the release:

* Use ``git`` to rename ``docs/src/whatsnew/latest.rst`` to the release
version file ``v1.9.rst``
* Update ``docs/src/whatsnews/index.rst`` to rename ``latest.rst`` in the
include statement and toctree.
* Use ``git`` to delete the ``docs/src/whatsnew/latest.rst.template`` file
* In ``v1.9.rst`` remove the ``[unreleased]`` caption from the page title.
Replace this with ``[release candidate]`` for the release candidate and
remove this for the actual release.
Note that, the Iris version and release date are updated automatically
when the documentation is built
* Review the file for correctness
Expand All @@ -253,24 +250,28 @@ Release Steps
#. Once all the above steps are complete, the release is cut, using
the :guilabel:`Draft a new release` button on the
`Iris release page <https://github.com/SciTools/iris/releases>`_
and targeting the release branch if it exists
#. Create the release feature branch ``v1.9.x`` on `SciTools/iris`_ if it doesn't
already exist. For point/bugfix releases use the branch which already exists


Post Release Steps
~~~~~~~~~~~~~~~~~~

#. Check the documentation has built on `Read The Docs`_. The build is
triggered by any commit to ``main``. Additionally check that the versions
available in the pop out menu in the bottom left corner include the new
available in the pop out menu in the bottom right corner include the new
release version. If it is not present you will need to configure the
versions available in the **admin** dashboard in `Read The Docs`_.
#. Review the `Active Versions`_ for the ``scitools-iris`` project on
`Read The Docs`_ to ensure that the appropriate versions are ``Active``
and/or ``Hidden``. To do this ``Edit`` the appropriate version e.g.,
see `Editing v3.0.0rc0`_ (must be logged into Read the Docs).
#. Make a new ``latest.rst`` from ``latest.rst.template`` and update the include
statement and the toctree in ``index.rst`` to point at the new
#. Merge back to ``main``. This should be done after all releases, including
the release candidate, and also after major changes to the release branch.
#. On main, make a new ``latest.rst`` from ``latest.rst.template`` and update
the include statement and the toctree in ``index.rst`` to point at the new
``latest.rst``.
#. Merge back to ``main``


.. _SciTools/iris: https://github.com/SciTools/iris
Expand All @@ -285,4 +286,4 @@ Post Release Steps
.. _Generating Distribution Archives: https://packaging.python.org/tutorials/packaging-projects/#generating-distribution-archives
.. _Packaging Your Project: https://packaging.python.org/guides/distributing-packages-using-setuptools/#packaging-your-project
.. _latest CF standard names: http:https://cfconventions.org/standard-names.html
.. _setuptools-scm: https://github.com/pypa/setuptools_scm
.. _setuptools-scm: https://github.com/pypa/setuptools_scm

0 comments on commit a131d86

Please sign in to comment.