From 4280a279e7877a465755a24366675cd71f5899af Mon Sep 17 00:00:00 2001
From: Petr Viktorin <encukou@gmail.com>
Date: Fri, 16 Aug 2024 17:40:03 +0200
Subject: [PATCH] Grep built docs for the string '(unreleased)'

---
 release.py     |  4 ++++
 run_release.py | 30 +++++++++++++++++++++++++++++-
 2 files changed, 33 insertions(+), 1 deletion(-)

diff --git a/release.py b/release.py
index 45d3e31..bdff8d3 100755
--- a/release.py
+++ b/release.py
@@ -209,6 +209,10 @@ def committed_at(self) -> datetime.datetime:
             int(proc.stdout.decode().strip()), tz=datetime.timezone.utc
         )
 
+    @property
+    def includes_docs(self) -> bool:
+        return self.is_final or self.is_release_candidate
+
     @property
     def doc_version(self) -> str:
         """Text used for notes in docs like 'Added in x.y'"""
diff --git a/run_release.py b/run_release.py
index 69b5b85..2150550 100755
--- a/run_release.py
+++ b/run_release.py
@@ -517,7 +517,7 @@ def create_tag(db: ReleaseShelf) -> None:
 def wait_for_source_and_docs_artifacts(db: ReleaseShelf) -> None:
     # Determine if we need to wait for docs or only source artifacts.
     release_tag = db["release"]
-    should_wait_for_docs = release_tag.is_final or release_tag.is_release_candidate
+    should_wait_for_docs = release_tag.includes_docs
 
     # Create the directory so it's easier to place the artifacts there.
     release_path = Path(db["git_repo"] / str(release_tag))
@@ -557,6 +557,33 @@ def wait_for_source_and_docs_artifacts(db: ReleaseShelf) -> None:
         time.sleep(1)
 
 
+def check_doc_unreleased_version(db: ReleaseShelf) -> None:
+    print("Checking built docs for '(unreleased)'")
+    # This string is generated when a `versionadded:: next` directive is
+    # left in the docs, which means the `bump_version_in_docs` step
+    # didn't do its job.
+    # But, there could also be a false positive.
+    release_tag = db["release"]
+    docs_path = Path(db["git_repo"] / str(release_tag) / 'docs')
+    archive_path = docs_path / f"python-{release_tag}-docs-html.tar.bz2"
+    if release_tag.includes_docs:
+        assert archive_path.exists()
+    if archive_path.exists():
+        proc = subprocess.run(
+            [
+                "tar",
+                "-xjf",
+                archive_path,
+                '--to-command=! grep -Hn --label="$TAR_FILENAME" "[(]unrelesed[)]"'
+            ],
+        )
+        if proc.returncode != 0:
+            if not ask_question(
+                "Are these `(unreleased)` strings in built docs OK?"
+            ):
+                proc.check_returncode()
+
+
 def sign_source_artifacts(db: ReleaseShelf) -> None:
     print("Signing tarballs with GPG")
     uid = os.environ.get("GPG_KEY_FOR_RELEASE")
@@ -1279,6 +1306,7 @@ def _api_key(api_key: str) -> str:
             wait_for_source_and_docs_artifacts,
             "Wait for source and docs artifacts to build",
         ),
+        Task(check_doc_unreleased_version, "Check docs for `(unreleased)`"),
         Task(build_sbom_artifacts, "Building SBOM artifacts"),
         *([] if no_gpg else [Task(sign_source_artifacts, "Sign source artifacts")]),
         Task(upload_files_to_server, "Upload files to the PSF server"),