Release do-nothing script: correct handling of patch releases by trexfeathers · Pull Request #6675 · SciTools/iris

trexfeathers · 2025-08-28T13:29:30Z

🚀 Pull Request

Description

Significantly re-works the release do-nothing script
Corrects how the release do-nothing script handles patch releases
Additional advice for how to patch multiple releases in one 'go'
Automated testing for the release do-nothing script

To-do

Find a solution to installing nothing for testing the do-nothing script

Include in dependencies?
Install on the fly?

iris/tools/release_do_nothing.py

Lines 22 to 29 in bb248bc

    
           try: 
        
               from nothing import Progress 
        
           except ImportError: 
        
               install_message = ( 
        
                   "This script requires the `nothing` package to be installed:\n" 
        
                   "pip install git+https://github.com/SciTools-incubator/nothing.git" 
        
               ) 
        
               raise ImportError(install_message)

Finish writing the automated tests
Action any corrections that the testing highlights
Find an alternative term to series, which is meaningful to everyone while not being ambiguous

Consult Iris pull request check list

Add any of the below labels to trigger actions on this PR:

benchmark_this Request that this pull request be benchmarked to check if it introduces performance shifts

…eases.

scitools-ci

Please see: SciTools/.github#191

trexfeathers · 2025-08-28T13:30:20Z

tools/release_do_nothing.py

-            cls.get_github_user,
-            cls.get_release_type,
+            cls.analyse_remotes,
+            # cls.parse_tags,


SciTools/.github#191 (comment)

trexfeathers · 2025-10-31T14:15:27Z

tools/release_do_nothing.py

+            for parts in remotes_split
+        ]
+
+        scitools_regex = re.compile(r"github\.com[:/]SciTools/iris\.git")


Remotes do not have to end with .git. Would it still be unambiguous enough without?

trexfeathers · 2025-10-31T15:42:37Z

tools/release_do_nothing.py

        self.wait_for_done(message)

-        message = f"Set {self.strings.branch} to Active, Hidden."
+        message = f"Set {self.version.branch} to Active, Hidden."


New RTD interface: we believe that branches never built before now have to be added using the Add version button.

trexfeathers · 2025-10-31T16:08:28Z

tools/release_do_nothing.py

@@ -608,7 +858,7 @@ def validate(sha256_string: str) -> str:
            "Confirm that pip install works as expected:\n"
            "conda create -y -n tmp_iris pip cf-units;\n"


This Conda environment will obviously be the latest version of Python. Sometimes Iris is incompatible with the latest version while we work on updating it; if we have added a Python max pin into pyproject.toml then Pip will detect this and refuse to install Iris into this environment.

So a note needs to be included that the developer should potentially include the appropriate Python pin when creating the Conda environment.

Potential extra work! Attempt to install with the latest version of Python to prove that the pin works, then attempt to install with the correct version.

trexfeathers · 2025-10-31T16:51:37Z

tools/release_do_nothing.py

@@ -795,33 +1051,45 @@ def update_conda_forge(self):
            "sometimes take minutes, or up to an hour.\n"


Should consider moving some steps to fill the conda-forge wait. Definitely RTD. Possibly some other post-release steps (although I'm cautious about things like posting an announcement until conda has finished).

trexfeathers · 2025-10-31T17:13:09Z

tools/release_do_nothing.py

-        return self.Strings(
-            series=series,
-            branch=series + ".x",  # v1.2.x
-            release=self.git_tag[1:],  # 1.2.3rc0


This needs to still be a thing - can't use self.release.public like I have tried to do (that includes the v).

Places this is a problem:

conda search

conda create

...?

trexfeathers · 2025-10-31T18:41:33Z

tools/release_do_nothing.py

+        )
+        self.wait_for_done(message)
+
+        if self.first_in_series:


This logic is fine, but first_in_series is flawed - it is written assuming that the release hasn't been cut yet, and the merge-back step happens post-release. Since the list of releases is refreshed every time, first_in_series will return False as soon as the first release has been cut, preventing this block from being entered.

trexfeathers · 2025-11-03T09:41:09Z

tools/release_do_nothing.py

-                f"git add {self.whats_news.index.absolute()};\n"
-                'git commit -m "Restore latest Whats New files.";\n'
-                f"git push -u origin {working_branch};"
+                f"git add {self.whats_news.index_.absolute()};\n"


The git add for latest.rst is too early - the script suggests subsequent edits, without adding again.

trexfeathers · 2025-11-14T13:21:02Z

tools/release_do_nothing.py

+            f'git commit -m "Recipe updates for {self.version} .";\n'
+            f"git push -u origin {self.version};"


We would benefit from a warning about what happens if you push directly to upstream - it prompts an immediate release without any pull request.

Perhaps we could get the user to explicitly input the name of their fork remote, at the same time as warning them.

trexfeathers · 2025-12-04T09:31:30Z

tools/release_do_nothing.py

-                        "The first release in a series is expected to be a "
-                        "release candidate, but this is not. Are you sure you "
-                        "want to continue?"
+                        "The patch change(s) are on the ideal branch to avoid later"


Suggested change

"The patch change(s) are on the ideal branch to avoid later"

"The patch change(s) are on the ideal branch to avoid later "

trexfeathers · 2025-12-05T17:23:28Z

tools/release_do_nothing.py

-            f'git commit -m "Recipe updates for {self.git_tag} .";\n'
-            f"git push -u origin {self.git_tag};"
+            f'git commit -m "Recipe updates for {self.version} .";\n'
+            f"git push -u origin {self.version};"


Perhaps pre-empt the thing about resetting the build number (could copy the text straight from conda-forge). Would make the process smoother - it's important to get conda-forge merged ASAP given the post-merge automation takes so long.

trexfeathers · 2026-03-17T15:57:08Z

tools/release_do_nothing.py

+            f"Visit the below and click `view details` for the Source Distribution"
            f"(`.tar.gz`):\n"
-            f"https://pypi.org/project/scitools-iris/{self.strings.release}#files\n"
+            f"https://pypi.org/project/scitools-iris/{self.version.public}#files\n"


Better URL: https://pypi.org/project/scitools-iris/3.15.0rc0/#scitools_iris-3.15.0rc0.tar.gz

trexfeathers · 2026-03-17T16:03:52Z

tools/release_do_nothing.py


        if self.is_release_candidate:
-            readme_url = f"https://github.com/{self.github_user}/iris-feedstock/blob/{self.git_tag}/README.md"
+            readme_url = f"https://github.com/{self.github_user}/iris-feedstock/blob/{self.version}/README.md"


Note that this step only applies after re-rendering has happened.

trexfeathers · 2026-03-17T17:28:28Z

tools/release_do_nothing.py

-            f"https://anaconda.org/conda-forge/iris?version={self.strings.release}\n"
+            f"https://scitools-iris.readthedocs.io/en/{self.version}/\n"
+            f"https://pypi.org/project/scitools-iris/{self.version.public}/\n"
+            f"https://anaconda.org/conda-forge/iris?version={self.version.public}\n"


No longer possible to filter anaconda.org using the URL (new UI)

Found a new way: https://anaconda.org/channels/conda-forge/packages/iris/files?file_q=3.15.0rc0

scitools-ci

Templating

This PR includes changes that may be worth sharing via templating. For each file listed below, please either:

Action the suggestion via a pull request editing/adding the relevant file in the SciTools/.github templates/ directory. ¹
Raise an issue against the SciTools/.github repo for the above action if you really don't have 10mins spare right now. Include an assignee, to avoid it being forgotten.
Dismiss the suggestion if the changes are not suitable for templating.

You will need to dismiss this review before this PR can be merged. Recommend the reviewer does this as their final action before merging, as this text will continually update as commits come in.

Templated files

The following changed files are templated:

.pre-commit-config.yaml, templated by SciTools/.github/templates/.pre-commit-config.yaml

Include this text in the PR body to avoid any notifications about applying the template changes back to the source repo!
@scitools-templating: please no update notification on: iris ↩

trexfeathers added 7 commits August 22, 2025 13:44

Note about merging directly to release branch.

133614e

Large updates to release-do-nothing for correct handling of patch rel…

905130e

…eases.

Pre-commit compliance.

41ee980

test_release_do_nothing.

604effd

Correct use of WhatsNewRsts.index_ .

f794bb6

Correct phrasing for PyPI SHA256.

c08b945

Series to-do.

bb248bc

trexfeathers added the Type: Infrastructure label Aug 28, 2025

scitools-ci bot previously requested changes Aug 28, 2025

View reviewed changes

scitools-ci bot mentioned this pull request Aug 28, 2025

Share SciTools/iris#6675 changes via templating? SciTools/.github#191

Closed

2 tasks

trexfeathers commented Aug 28, 2025

View reviewed changes

scitools-ci bot added this to 🚴 Peloton Aug 29, 2025

scitools-ci bot removed this from 🚴 Peloton Sep 24, 2025

scitools-ci bot added this to 🚴 Peloton Sep 25, 2025

trexfeathers commented Oct 31, 2025

View reviewed changes

trexfeathers commented Nov 3, 2025

View reviewed changes

trexfeathers commented Nov 14, 2025

View reviewed changes

trexfeathers commented Dec 4, 2025

View reviewed changes

trexfeathers commented Dec 5, 2025

View reviewed changes

Progress on test_release_do_nothing.

e51ec42

trexfeathers commented Mar 17, 2026

View reviewed changes

trexfeathers self-assigned this Mar 25, 2026

Finished most tests.

35ce398

scitools-ci bot requested changes Mar 28, 2026

View reviewed changes

	try:
	from nothing import Progress
	except ImportError:
	install_message = (
	"This script requires the `nothing` package to be installed:\n"
	"pip install git+https://github.com/SciTools-incubator/nothing.git"
	)
	raise ImportError(install_message)

		@@ -608,7 +858,7 @@ def validate(sha256_string: str) -> str:
		"Confirm that pip install works as expected:\n"
		"conda create -y -n tmp_iris pip cf-units;\n"

		@@ -795,33 +1051,45 @@ def update_conda_forge(self):
		"sometimes take minutes, or up to an hour.\n"

		f'git commit -m "Recipe updates for {self.version} .";\n'
		f"git push -u origin {self.version};"

	"The patch change(s) are on the ideal branch to avoid later"
	"The patch change(s) are on the ideal branch to avoid later "

Conversation

trexfeathers commented Aug 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Pull Request

Description

To-do

Uh oh!

scitools-ci bot left a comment • edited by trexfeathers Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

trexfeathers Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

trexfeathers Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

trexfeathers Mar 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

scitools-ci bot left a comment

Choose a reason for hiding this comment

Templated files

Footnotes

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

trexfeathers commented Aug 28, 2025 •

edited

Loading

scitools-ci bot left a comment •

edited by trexfeathers

Loading

trexfeathers Oct 31, 2025 •

edited

Loading

trexfeathers Oct 31, 2025 •

edited

Loading

trexfeathers Mar 17, 2026 •

edited

Loading