Use the new re-entrant do-nothing script #6062

trexfeathers · 2024-07-18T16:53:04Z

🚀 Pull Request

Description

Just a draft so we can trial it in the upcoming release.

https://github.com/SciTools-incubator/nothing

need to set appropriate permissions for the new repo

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

codecov · 2024-07-18T17:02:35Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.77%. Comparing base (b8f554f) to head (84818cf).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6062   +/-   ##
=======================================
  Coverage   89.77%   89.77%           
=======================================
  Files          88       88           
  Lines       23026    23026           
  Branches     5036     5036           
=======================================
  Hits        20672    20672           
  Misses       1623     1623           
  Partials      731      731

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

trexfeathers · 2024-08-02T10:10:06Z

tools/release_do_nothing.py

+                f"{self.whats_news.latest.absolute()}\n"
+                f"{self.whats_news.template.absolute()}\n"


There will be Git commands that can get hold of these files.

Perhaps explicitly make the process:

Restore template

Create latest.rst from the template

Specifically mention bits that need changing/removing?

trexfeathers · 2024-08-02T10:12:03Z

tools/release_do_nothing.py

+# pip install git+https://github.com/SciTools-incubator/nothing.git
+from nothing import Progress


This would be better off as a try-except. If the import fails, provide instructions about WHY, then HOW to install nothing.

trexfeathers · 2024-08-02T10:15:55Z

tools/release_do_nothing.py

+            message = (
+                "Update the file ``etc/cf-standard-name-table.xml`` to the "
+                "latest CF standard names, via a new Pull Request.\n"
+                "(This is used during build to automatically generate the "
+                "sourcefile ``lib/iris/std_names.py``).\n"
+                "Latest standard names:\n"
+                'wget "https://cfconventions.org/Data/cf-standard-names'
+                '/current/src/cf-standard-name-table.xml";'
+            )
+            self.wait_for_done(message)


This wget command could easily put the new table into the correct place, too.

trexfeathers · 2024-08-02T10:19:06Z

tools/release_do_nothing.py

+            whatsnew_title = (
+                f"{self.strings.series} ({datetime.today().strftime('%d %b %Y')}"
+            )
+            if self.is_release_candidate:
+                whatsnew_title += " [release candidate]"


The title needs a bracket at the end

trexfeathers · 2024-08-02T10:21:58Z

tools/release_do_nothing.py

+                f"Review {self.whats_news.release.name} to ensure it is a good "
+                f"reflection of what is new in {self.strings.series}."


Useful to have example(s) here. E.g. something big that we definitely want people to know about like a NumPy pin.

trexfeathers · 2024-08-02T10:48:23Z

tools/release_do_nothing.py

+            f"conda create -n tmp_iris{channel_command}iris="
+            f"{self.strings.release};\n"
+            f"conda remove -n tmp_iris --all;"


Include an import iris step.

trexfeathers · 2024-08-02T10:49:59Z

tools/release_do_nothing.py

+            "Update the release page in GitHub discussions, with the above "
+            "links "
+            "and anything else appropriate.\n"
+            "https://github.com/SciTools/iris/discussions"


Encourage copying from a previous example.

trexfeathers · 2024-08-02T10:50:27Z

tools/release_do_nothing.py

+            "and anything else appropriate.\n"
+            "https://github.com/SciTools/iris/discussions"
+        )
+        self.wait_for_done(message)


Another step? Comment on the discussion in case anyone is following it.

trexfeathers · 2024-08-02T10:53:08Z

tools/release_do_nothing.py

+        message = (
+            "Announce the release via https://twitter.com/scitools_iris, "
+            "and any "
+            "other appropriate message boards (e.g. Yammer).\n"


Suggested change

"other appropriate message boards (e.g. Yammer).\n"

"other appropriate message boards (e.g. Viva Engage).\n"

tools/release_do_nothing.py

trexfeathers · 2024-08-13T12:37:30Z

tools/release_do_nothing.py

-    _wait_for_done(message)
+        def validate(sha256_string: str) -> str:
+            try:
+                sha_len = int(sha256_string, 16).bit_length() + 1


This doesn't actually work - the bit_length() of the string can be anywhere from 253 to 256. The correct two things to check are:

That the string can be validly parsed as a 16-bit number (int(sha256_string, 16))

That the string is 64 characters long

HGWright · 2024-08-13T12:41:47Z

tools/release_do_nothing.py

+            "conda activate tmp_iris;\n"
+            f"pip install scitools-iris=={self.strings.release};\n"
+            'python -c "import iris; print(iris.__version__)";\n'
+            "conda remove -n tmp_iris --all;\n"


This requires a "conda deactivate" to work

trexfeathers · 2024-08-13T14:15:53Z

tools/release_do_nothing.py

-            f"git push -u origin {working_branch};"
+            "After the PR is merged, wait for the CI to complete, after which "
+            "the new version of Iris will be on conda-forge's servers.\n"
+            "https://github.com/conda-forge/iris-feedstock/actions"


Suggested change

"https://github.com/conda-forge/iris-feedstock/actions"

"https://dev.azure.com/conda-forge/feedstock-builds/_build?definitionId=464"

trexfeathers · 2024-08-13T15:02:37Z

tools/release_do_nothing.py

-    )
+        message = (
+            f"Comment on {discussion_url} to notify anyone watching that "
+            f"{self.strings.tag} has been released."


Suggested change

f"{self.strings.tag} has been released."

f"{self.git_tag} has been released."

trexfeathers · 2024-08-13T16:14:33Z

tools/release_do_nothing.py

+                message = (
+                    "Follow the latest conda-forge guidance for creating a new "
+                    "release candidate branch from the `main` branch:\n"
+                    "https://conda-forge.org/docs/maintainer/knowledge_base.html#pre-release-builds\n\n"
+                    "DEVIATION FROM GUIDANCE: config file(s) should point to "
+                    "the `rc_iris` label (this is not the name that "
+                    "conda-forge suggest).\n"
+                )
+                rc_branch = self.get_input(message, "Input the name of your new branch")


The changes are best made within the same PR that proposes the new release.

pp-mo · 2024-09-12T11:49:20Z

Tested this in use + it was handy
But it would be nice if the "nothing" package allowed you to restart from latest stored.
I created a couple of issues to suggest improvements in the common code package : SciTools-incubator/nothing#1 SciTools-incubator/nothing#2

trexfeathers · 2024-09-12T13:05:45Z

Tested this in use + it was handy But it would be nice if the "nothing" package allowed you to restart from latest stored. I created a couple of issues to suggest improvements in the common code package : SciTools-incubator/nothing#1 SciTools-incubator/nothing#2

Thanks @pp-mo these are great suggestions! I don't consider them a blocker to this PR, which I know @HGWright is looking at today.

Use the new re-entrant do-nothing script.

044fdda

trexfeathers self-assigned this Jul 19, 2024

trexfeathers commented Aug 2, 2024

View reviewed changes

trexfeathers added 16 commits August 12, 2024 16:53

Proper import error handling.

7abb68e

Always use git add.

65f8294

More automation around CF standard names.

3ec6628

Missing bracket.

938f05f

Less nebulous language.

c0ac209

Encourage copy-pasting from previous releases.

7510b78

Clearer wording about release branches.

387c978

Clearer RTD versioning.

713662e

More precise installation tests.

61bf2a4

Clearer rc branch naming.

c2ef5b8

Draw attention to deviation from conda-forge guidance.

09b1191

Wait for CI to finish.

41c3e49

Include conda search command.

7047633

Comment on discussion.

76beb65

Viva Engage.

a010bd3

Use a git command for recreating files.

0c96810

trexfeathers commented Aug 13, 2024

View reviewed changes

HGWright reviewed Aug 13, 2024

View reviewed changes

trexfeathers commented Aug 13, 2024

View reviewed changes

trexfeathers added 5 commits August 14, 2024 11:39

Better SHA256 validation.

bc7f6bc

Add missing conda deactivate command.

0f8721b

Correct URL for watching conda-forge process.

78d0255

Correct use of self.git_tag.

94fa686

More guidance about when to change RC feedstock files.

25812b0

Better advice for waiting for conda testing.

7af5d22

trexfeathers marked this pull request as ready for review August 14, 2024 14:53

Merge branch 'main' into new_do_nothing

84818cf

trexfeathers assigned ESadek-MO Aug 15, 2024

trexfeathers assigned HGWright and unassigned trexfeathers and ESadek-MO Sep 11, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use the new re-entrant do-nothing script #6062

Use the new re-entrant do-nothing script #6062

trexfeathers commented Jul 18, 2024 •

edited

Loading

codecov bot commented Jul 18, 2024 •

edited

Loading

trexfeathers Aug 2, 2024

trexfeathers Aug 12, 2024 •

edited

Loading

trexfeathers Aug 2, 2024

trexfeathers Aug 12, 2024 •

edited

Loading

trexfeathers Aug 2, 2024

trexfeathers Aug 12, 2024 •

edited

Loading

trexfeathers Aug 2, 2024

trexfeathers Aug 12, 2024 •

edited

Loading

trexfeathers Aug 2, 2024

trexfeathers Aug 12, 2024 •

edited

Loading

trexfeathers Aug 2, 2024

trexfeathers Aug 12, 2024 •

edited

Loading

trexfeathers Aug 2, 2024

trexfeathers Aug 12, 2024 •

edited

Loading

trexfeathers Aug 2, 2024

trexfeathers Aug 12, 2024 •

edited

Loading

trexfeathers Aug 2, 2024

trexfeathers Aug 12, 2024 •

edited

Loading

trexfeathers Aug 13, 2024

trexfeathers Aug 14, 2024 •

edited

Loading

HGWright Aug 13, 2024

trexfeathers Aug 14, 2024 •

edited

Loading

trexfeathers Aug 13, 2024

trexfeathers Aug 14, 2024 •

edited

Loading

trexfeathers Aug 13, 2024

trexfeathers Aug 14, 2024 •

edited

Loading

trexfeathers Aug 13, 2024

trexfeathers Aug 14, 2024 •

edited

Loading

pp-mo commented Sep 12, 2024

trexfeathers commented Sep 12, 2024

		f"{self.whats_news.latest.absolute()}\n"
		f"{self.whats_news.template.absolute()}\n"

		# pip install git+https://github.com/SciTools-incubator/nothing.git
		from nothing import Progress

		f"Review {self.whats_news.release.name} to ensure it is a good "
		f"reflection of what is new in {self.strings.series}."

	"other appropriate message boards (e.g. Yammer).\n"
	"other appropriate message boards (e.g. Viva Engage).\n"

	"https://github.com/conda-forge/iris-feedstock/actions"
	"https://dev.azure.com/conda-forge/feedstock-builds/_build?definitionId=464"

	f"{self.strings.tag} has been released."
	f"{self.git_tag} has been released."

Use the new re-entrant do-nothing script #6062

Are you sure you want to change the base?

Use the new re-entrant do-nothing script #6062

Conversation

trexfeathers commented Jul 18, 2024 • edited Loading

🚀 Pull Request

Description

codecov bot commented Jul 18, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

trexfeathers Aug 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trexfeathers Aug 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trexfeathers Aug 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trexfeathers Aug 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trexfeathers Aug 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trexfeathers Aug 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trexfeathers Aug 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trexfeathers Aug 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trexfeathers Aug 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trexfeathers Aug 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trexfeathers Aug 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trexfeathers Aug 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trexfeathers Aug 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trexfeathers Aug 14, 2024 • edited Loading

Choose a reason for hiding this comment

pp-mo commented Sep 12, 2024

trexfeathers commented Sep 12, 2024

trexfeathers commented Jul 18, 2024 •

edited

Loading

codecov bot commented Jul 18, 2024 •

edited

Loading

trexfeathers Aug 12, 2024 •

edited

Loading

trexfeathers Aug 12, 2024 •

edited

Loading

trexfeathers Aug 12, 2024 •

edited

Loading

trexfeathers Aug 12, 2024 •

edited

Loading

trexfeathers Aug 12, 2024 •

edited

Loading

trexfeathers Aug 12, 2024 •

edited

Loading

trexfeathers Aug 12, 2024 •

edited

Loading

trexfeathers Aug 12, 2024 •

edited

Loading

trexfeathers Aug 12, 2024 •

edited

Loading

trexfeathers Aug 14, 2024 •

edited

Loading

trexfeathers Aug 14, 2024 •

edited

Loading

trexfeathers Aug 14, 2024 •

edited

Loading

trexfeathers Aug 14, 2024 •

edited

Loading

trexfeathers Aug 14, 2024 •

edited

Loading