From 5a054d486073307d0c5a7c5d714d03f59503f8e3 Mon Sep 17 00:00:00 2001 From: lbdreyer Date: Thu, 11 Nov 2021 15:55:25 +0000 Subject: [PATCH 1/4] Add release docs sections describing the role of a Release Manager --- docs/src/developers_guide/release.rst | 14 ++++++++++++++ docs/src/whatsnew/latest.rst | 3 +++ 2 files changed, 17 insertions(+) diff --git a/docs/src/developers_guide/release.rst b/docs/src/developers_guide/release.rst index 896cc582f1..5fc0e541e0 100644 --- a/docs/src/developers_guide/release.rst +++ b/docs/src/developers_guide/release.rst @@ -11,6 +11,20 @@ The summary below is of the main areas that constitute the release. The final section details the :ref:`iris_development_releases_steps` to take. +.. _release-manager: + +Release Manager +--------------- +A Release Manager will be nominated for each release of Iris. This role involves: + +* deciding which features and bug fixes should be included in the release +* managing the project board for the release +* updating the iris dev community via the discussion board + +The Release Manager will make the release, ensuring that all the steps outlined +on this page are completed. + + Before Release -------------- diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst index 33f2e7a699..bf9b91e747 100644 --- a/docs/src/whatsnew/latest.rst +++ b/docs/src/whatsnew/latest.rst @@ -168,6 +168,9 @@ This document explains the changes made to Iris for this release #. `@trexfeathers`_ added more detail on making `iris-test-data`_ available during :ref:`developer_running_tests`. (:pull:`4359`) +#. `@lbdreyer`_ added a section to the release documentation outlining the role + of the :ref:`release-manager`. (:pull:`4412`) + 💼 Internal =========== From 79c2dacb33678567f3ae1b7fbffd2b361c5fa8bb Mon Sep 17 00:00:00 2001 From: lbdreyer Date: Tue, 16 Nov 2021 18:05:10 +0000 Subject: [PATCH 2/4] review actions --- docs/src/developers_guide/release.rst | 6 ++++-- docs/src/whatsnew/latest.rst | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/src/developers_guide/release.rst b/docs/src/developers_guide/release.rst index 5fc0e541e0..687cf4db24 100644 --- a/docs/src/developers_guide/release.rst +++ b/docs/src/developers_guide/release.rst @@ -11,7 +11,7 @@ The summary below is of the main areas that constitute the release. The final section details the :ref:`iris_development_releases_steps` to take. -.. _release-manager: +.. _release_manager: Release Manager --------------- @@ -19,7 +19,8 @@ A Release Manager will be nominated for each release of Iris. This role involves * deciding which features and bug fixes should be included in the release * managing the project board for the release -* updating the iris dev community via the discussion board +* using a `GitHub Discussions forum`_ for documenting intent and capturing any + discussion about the release The Release Manager will make the release, ensuring that all the steps outlined on this page are completed. @@ -257,6 +258,7 @@ Post Release Steps .. _SciTools/iris: https://github.com/SciTools/iris .. _tag on the SciTools/Iris: https://github.com/SciTools/iris/releases +.. _GitHub Discussions forum: https://github.com/SciTools/iris/discussions .. _conda-forge Anaconda channel: https://anaconda.org/conda-forge/iris .. _conda-forge iris-feedstock: https://github.com/conda-forge/iris-feedstock .. _CFEP-05: https://github.com/conda-forge/cfep/blob/master/cfep-05.md diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst index bf9b91e747..601be550c2 100644 --- a/docs/src/whatsnew/latest.rst +++ b/docs/src/whatsnew/latest.rst @@ -169,7 +169,7 @@ This document explains the changes made to Iris for this release during :ref:`developer_running_tests`. (:pull:`4359`) #. `@lbdreyer`_ added a section to the release documentation outlining the role - of the :ref:`release-manager`. (:pull:`4412`) + of the :ref:`release_manager`. (:pull:`4413`) 💼 Internal From 118a732dc336eb4ca045bff39c9c38f7a174c0df Mon Sep 17 00:00:00 2001 From: lbdreyer Date: Wed, 17 Nov 2021 10:03:38 +0000 Subject: [PATCH 3/4] fix releases discussion link --- docs/src/developers_guide/release.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/developers_guide/release.rst b/docs/src/developers_guide/release.rst index 687cf4db24..3a46946956 100644 --- a/docs/src/developers_guide/release.rst +++ b/docs/src/developers_guide/release.rst @@ -19,7 +19,7 @@ A Release Manager will be nominated for each release of Iris. This role involves * deciding which features and bug fixes should be included in the release * managing the project board for the release -* using a `GitHub Discussions forum`_ for documenting intent and capturing any +* using a `GitHub Releases Discussion Forum`_ for documenting intent and capturing any discussion about the release The Release Manager will make the release, ensuring that all the steps outlined @@ -258,7 +258,7 @@ Post Release Steps .. _SciTools/iris: https://github.com/SciTools/iris .. _tag on the SciTools/Iris: https://github.com/SciTools/iris/releases -.. _GitHub Discussions forum: https://github.com/SciTools/iris/discussions +.. _GitHub Discussions forum: https://github.com/SciTools/iris/discussions/categories/releases .. _conda-forge Anaconda channel: https://anaconda.org/conda-forge/iris .. _conda-forge iris-feedstock: https://github.com/conda-forge/iris-feedstock .. _CFEP-05: https://github.com/conda-forge/cfep/blob/master/cfep-05.md From d2b5e671b9e405f976950efe659793624a5f5bf5 Mon Sep 17 00:00:00 2001 From: lbdreyer Date: Wed, 17 Nov 2021 14:59:10 +0000 Subject: [PATCH 4/4] Update docs/src/developers_guide/release.rst Co-authored-by: tkknight <2108488+tkknight@users.noreply.github.com> --- docs/src/developers_guide/release.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/developers_guide/release.rst b/docs/src/developers_guide/release.rst index 3a46946956..bcf075e4ae 100644 --- a/docs/src/developers_guide/release.rst +++ b/docs/src/developers_guide/release.rst @@ -258,7 +258,7 @@ Post Release Steps .. _SciTools/iris: https://github.com/SciTools/iris .. _tag on the SciTools/Iris: https://github.com/SciTools/iris/releases -.. _GitHub Discussions forum: https://github.com/SciTools/iris/discussions/categories/releases +.. _GitHub Releases Discussion Forum: https://github.com/SciTools/iris/discussions/categories/releases .. _conda-forge Anaconda channel: https://anaconda.org/conda-forge/iris .. _conda-forge iris-feedstock: https://github.com/conda-forge/iris-feedstock .. _CFEP-05: https://github.com/conda-forge/cfep/blob/master/cfep-05.md