Release do-nothing script: correct handling of patch releases

.pre-commit-config.yaml

@@ -13,7 +13,8 @@ files: |
         setup\.py|
         docs\/.+\.py|
         lib\/.+\.py|
-        benchmarks\/.+\.py
+        benchmarks\/.+\.py|
+        tools\/.+\.py
     )
 minimum_pre_commit_version: 1.21.0
 

docs/src/developers_guide/release.rst

@@ -88,6 +88,11 @@ New features shall not be included in a patch release, these are for bug fixes.
 A patch release does not require a release candidate, but the rest of the
 release process is to be followed.
 
+As mentioned in :ref:`release_branch`: branch/commit management is much simpler
+if the patch changes are **first merged into the release branch** -
+e.g. ``v1.9.x`` - and are only added to ``main`` during :ref:`merge_back` (post
+release).
+
 
 Before Release
 --------------
@@ -111,6 +116,8 @@ from the `latest CF standard names`_.
 The Release
 -----------
 
+.. _release_branch:
+
 Release Branch
 ~~~~~~~~~~~~~~
 
@@ -193,6 +200,8 @@ of the new release. Ideally this would be updated before the release, but
 the DOI for the new version is only available once the release has been
 created in GitHub.
 
+.. _merge_back:
+
 Merge Back
 ~~~~~~~~~~
 

noxfile.py

@@ -180,12 +180,14 @@ def tests(session: nox.sessions.Session):
     """
     prepare_venv(session)
     session.install("--no-deps", "--editable", ".")
+    session.install("git+https://github.com/SciTools-incubator/nothing.git")
     session.env.update(ENV)
     run_args = [
         "pytest",
         "-n",
         "auto",
         "lib/iris/tests",
+        "tools",
     ]
     if "-c" in session.posargs or "--coverage" in session.posargs:
         run_args[-1:-1] = ["--cov=lib/iris", "--cov-report=xml"]

pyproject.toml

@@ -65,13 +65,13 @@ extend-exclude = [
     "_ff_cross_references.py",
     "um_cf_map.py",
     "docs/src/sphinxext/api_rst_formatting.py",
-    "tools",
 ]
 line-length = 88
 src = [
     "benchmarks",
     "lib",
     "docs/src",
+    "tools",
 ]
 
 [tool.ruff.format]
@@ -108,9 +108,16 @@ known-first-party = ["iris"]
 "lib/iris/tests/*.py" = [
     # https://docs.astral.sh/ruff/rules/undocumented-public-module/
     "D100",  # Missing docstring in public module
+    "D106",  # Missing docstring in public nested class
     "D205",  # 1 blank line required between summary line and description
     "D401",  # 1 First line of docstring should be in imperative mood
 ]
+"tools/test_*.py" = [
+    "D100",
+    "D106",
+    "D205",
+    "D401",
+]
 
 # Deprecated unittest tests
 

tools/generate_std_names.py

@@ -2,9 +2,7 @@
 #
 # This file is part of Iris and is released under the BSD license.
 # See LICENSE in the root of the repository for full licensing details.
-"""
-A script to convert the standard names information from the provided XML
-file into a Python dictionary format.
+"""Script converting standard names information from provided XML file to a Python dict.
 
 Takes two arguments: the first is the XML file to process and the second
 is the name of the file to write the Python dictionary file into.
@@ -19,10 +17,10 @@
 """
 
 import argparse
+from pathlib import Path
 import pprint
 import xml.etree.ElementTree as ET
 
-
 STD_VALUES_FILE_TEMPLATE = '''
 # Copyright Iris contributors
 #
@@ -61,7 +59,8 @@
 
 
 def process_name_table(tree, element_name, *child_elements):
-    """
+    """Yield id->mapping dictionaries for each entry in the standard name table.
+
     Yields a series of dictionaries with the key being the id of the entry element and the value containing
     another dictionary mapping other attributes of the standard name to their values, e.g. units, description, grib value etc.
     """
@@ -70,9 +69,11 @@ def process_name_table(tree, element_name, *child_elements):
 
         for child_elem in child_elements:
             found_elem = elem.find(child_elem)
-            sub_section[child_elem] = found_elem.text if found_elem is not None else None
+            sub_section[child_elem] = (
+                found_elem.text if found_elem is not None else None
+            )
 
-        yield {elem.get("id") : sub_section}
+        yield {elem.get("id"): sub_section}
 
 
 def to_dict(infile, outfile):
@@ -81,36 +82,41 @@ def to_dict(infile, outfile):
 
     tree = ET.parse(infile)
 
-    cf_table_version_string = tree.find('version_number').text
+    cf_table_version_string = tree.find("version_number").text
 
-    for section in process_name_table(tree, 'entry', 'canonical_units'):
+    for section in process_name_table(tree, "entry", "canonical_units"):
         values.update(section)
 
-    for section in process_name_table(tree, 'alias', 'entry_id'):
+    for section in process_name_table(tree, "alias", "entry_id"):
         aliases.update(section)
 
     for key, valued in aliases.items():
-        values.update({
-                key : {'canonical_units' : values.get(valued['entry_id']).get('canonical_units')}
-            })
+        values.update(
+            {
+                key: {
+                    "canonical_units": values.get(valued["entry_id"]).get(
+                        "canonical_units"
+                    )
+                }
+            }
+        )
 
     text = STD_VALUES_FILE_TEMPLATE.format(table_version=cf_table_version_string)
     text += pprint.pformat(values)
-    text += f'\n\nCF_STANDARD_NAMES_TABLE_VERSION = {cf_table_version_string}\n'
+    text += f"\n\nCF_STANDARD_NAMES_TABLE_VERSION = {cf_table_version_string}\n"
     outfile.write(text)
 
 
 if __name__ == "__main__":
     parser = argparse.ArgumentParser(
-        description='Create Python code from CF standard name XML.')
-    parser.add_argument('input', metavar='INPUT',
-                        help='Path to CF standard name XML')
-    parser.add_argument('output', metavar='OUTPUT',
-                        help='Path to resulting Python code')
+        description="Create Python code from CF standard name XML."
+    )
+    parser.add_argument("input", metavar="INPUT", help="Path to CF standard name XML")
+    parser.add_argument(
+        "output", metavar="OUTPUT", help="Path to resulting Python code"
+    )
     args = parser.parse_args()
 
-    encoding = {'encoding': 'utf-8'}
-
-    with open(args.input, 'r', **encoding) as in_fh:
-        with open(args.output, 'w', **encoding) as out_fh:
+    with open(args.input, "r", encoding="utf-8") as in_fh:
+        with open(args.output, "w", encoding="utf-8") as out_fh:
             to_dict(in_fh, out_fh)