From efc0968418a89e110ee38de0aa0469e52a885306 Mon Sep 17 00:00:00 2001 From: "stephen.worsley" Date: Wed, 14 Sep 2022 15:01:05 +0100 Subject: [PATCH 1/2] update release guide --- docs/src/developers_guide/release.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/src/developers_guide/release.rst b/docs/src/developers_guide/release.rst index 25a426e20b..7f30da2033 100644 --- a/docs/src/developers_guide/release.rst +++ b/docs/src/developers_guide/release.rst @@ -226,7 +226,6 @@ 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 @@ -235,6 +234,8 @@ Release Steps 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 @@ -253,6 +254,7 @@ 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 `_ + and targeting the release branch Post Release Steps @@ -267,10 +269,11 @@ Post Release Steps `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 From 58a67acca88783e3bf75a0fb381f8af8f38e2418 Mon Sep 17 00:00:00 2001 From: stephenworsley <49274989+stephenworsley@users.noreply.github.com> Date: Thu, 22 Sep 2022 15:22:07 +0100 Subject: [PATCH 2/2] adress review comments --- docs/src/developers_guide/release.rst | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/src/developers_guide/release.rst b/docs/src/developers_guide/release.rst index 7f30da2033..37a17ed791 100644 --- a/docs/src/developers_guide/release.rst +++ b/docs/src/developers_guide/release.rst @@ -224,14 +224,10 @@ 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 ``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 @@ -254,7 +250,9 @@ 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 `_ - and targeting the release branch + 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 @@ -262,7 +260,7 @@ 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 @@ -288,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://cfconventions.org/standard-names.html -.. _setuptools-scm: https://github.com/pypa/setuptools_scm \ No newline at end of file +.. _setuptools-scm: https://github.com/pypa/setuptools_scm