Skip to content

Compress tool outputs, logs, files, and RAG chunks before they reach the LLM. 20% fewer tokens for coding agents, 60-95% fewer tokens for JSON, same answers. Library, proxy, MCP server.

fix(release): normalize damaged release PR envelopes before detection (#4664)

JD Davis917edc62230c
diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml
index c40893be2..6acd263ed 100644
--- a/.github/workflows/release-please.yml
+++ b/.github/workflows/release-please.yml
@@ -59,6 +59,16 @@ jobs:
app-id: ${{ vars.RELEASE_APP_ID }}
private-key: ${{ secrets.RELEASE_APP_PRIVATE_KEY }}
+ # A Windows body edit can introduce CRCRLF. release-please strips one CR,
+ # then cannot find its exact `---` delimiters and silently skips release
+ # creation. Repair only merged, pending release PR envelopes before the
+ # action reads them; do not infer versions or rewrite generated notes.
+ - uses: actions/checkout@v7
+ - name: Normalize pending release PR body line endings
+ env:
+ GH_TOKEN: ${{ steps.app-token.outputs.token || secrets.RELEASE_PLEASE_TOKEN || secrets.GITHUB_TOKEN }}
+ run: python scripts/normalize_release_pr_bodies.py --repo "${{ github.repository }}" --apply
+
- uses: googleapis/release-please-action@v5
with:
# Neither an app token nor a PAT is GITHUB_TOKEN, and that matters: a
diff --git a/.gitignore b/.gitignore
index 9c0b0e989..9b731df6a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -18,6 +18,7 @@ scripts/*
!scripts/changelog-gen.py
!scripts/verify-versions.py
!scripts/verify-ruff-version.py
+!scripts/normalize_release_pr_bodies.py
!scripts/pr-governance.py
!scripts/bootstrap-windows-dev.ps1
!scripts/codeql_triage.sh
diff --git a/scripts/normalize_release_pr_bodies.py b/scripts/normalize_release_pr_bodies.py
new file mode 100644
index 000000000..faa736f91
--- /dev/null
+++ b/scripts/normalize_release_pr_bodies.py
@@ -0,0 +1,95 @@
+"""Repair newline-damaged merged release-please bodies before release detection.
+
+Windows text-mode writes can turn existing CRLF into CRCRLF. release-please
+normalizes CRLF once and then looks for an exact ``---`` line, so the remaining
+CR hides its envelope and a successful run silently skips the pending release.
+This tool only repairs merged, pending release PRs on the configured base.
+It never changes labels, tags, releases, release notes, or package versions.
+"""
+
+from __future__ import annotations
+
+import argparse
+import json
+import os
+import re
+import subprocess
+from typing import Any
+from urllib.parse import urlencode
+
+
+def github_json(endpoint: str, **payload: Any) -> Any:
+ command = ["gh", "api", endpoint]
+ if payload:
+ command.extend(["--method", "PATCH", "--input", "-"])
+ result = subprocess.run(
+ command,
+ input=json.dumps(payload) if payload else None,
+ capture_output=True,
+ text=True,
+ encoding="utf-8",
+ check=True,
+ )
+ return json.loads(result.stdout)
+
+
+def normalize_body(body: str) -> str:
+ """Collapse CR runs before LF without altering note content or blank lines."""
+ return re.sub(r"\r+\n", "\n", body)
+
+
+def repair_release(repo: str, pr: dict[str, Any], *, apply: bool = True) -> bool:
+ if (
+ not pr.get("merged_at")
+ or pr.get("base", {}).get("ref") != "main"
+ or pr.get("user", {}).get("type") != "Bot"
+ or (pr.get("head", {}).get("repo") or {}).get("full_name") != repo
+ or not pr.get("head", {}).get("ref", "").startswith("release-please--branches--main--")
+ or "autorelease: pending" not in {label["name"] for label in pr.get("labels", [])}
+ ):
+ return False
+ body = pr.get("body") or ""
+ # Normal CRLF already works. Do not rewrite unrelated historical formats.
+ if not re.search(r"\r{2,}\n", body):
+ return False
+ normalized = normalize_body(body)
+ # Match the structural boundary release-please needs, not an arbitrary body
+ # containing a version somewhere in its maintainer comments.
+ lines = normalized.strip().split("\n")
+ delimiters = [i for i, line in enumerate(lines) if line == "---"]
+ if len(delimiters) < 2 or not re.search(
+ r"^#{2,} \[?\d+\.\d+\.\d+", "\n".join(lines[delimiters[0] + 1 : delimiters[-1]]), re.M
+ ):
+ raise ValueError(f"PR #{pr['number']} lacks a parseable release-please envelope")
+ if body == normalized:
+ return False
+ if apply:
+ github_json(f"repos/{repo}/pulls/{pr['number']}", body=normalized)
+ print(f"{'Normalized' if apply else 'Would normalize'} release PR #{pr['number']}")
+ return True
+
+
+def main() -> None:
+ parser = argparse.ArgumentParser(description=__doc__)
+ parser.add_argument("--repo", default=os.environ.get("GITHUB_REPOSITORY"), required=False)
+ parser.add_argument("--apply", action="store_true", help="Write only normalized PR body text")
+ args = parser.parse_args()
+ if not args.repo or not re.fullmatch(r"[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+", args.repo):
+ parser.error("--repo must be owner/repository")
+ page = 1
+ while True:
+ query = urlencode(
+ {"state": "closed", "labels": "autorelease: pending", "per_page": 100, "page": page}
+ )
+ issues = github_json(f"repos/{args.repo}/issues?{query}")
+ for issue in issues:
+ if "pull_request" in issue:
+ pr = github_json(f"repos/{args.repo}/pulls/{issue['number']}")
+ repair_release(args.repo, pr, apply=args.apply)
+ if len(issues) < 100:
+ return
+ page += 1
+
+
+if __name__ == "__main__":
+ main()
diff --git a/scripts/tests/test_normalize_release_pr_bodies.py b/scripts/tests/test_normalize_release_pr_bodies.py
new file mode 100644
index 000000000..48d97c6ac
--- /dev/null
+++ b/scripts/tests/test_normalize_release_pr_bodies.py
@@ -0,0 +1,129 @@
+"""Regression coverage for Windows-corrupted release-please PR envelopes."""
+
+from __future__ import annotations
+
+import importlib.util
+import sys
+from pathlib import Path
+from types import SimpleNamespace
+
+import pytest
+
+SCRIPT = Path(__file__).resolve().parents[1] / "normalize_release_pr_bodies.py"
+
+
+def load_module():
+ spec = importlib.util.spec_from_file_location("normalize_release_pr_bodies", SCRIPT)
+ assert spec and spec.loader
+ module = importlib.util.module_from_spec(spec)
+ sys.modules[spec.name] = module
+ spec.loader.exec_module(module)
+ return module
+
+
+BODY = ":robot: I have created a release *beep* *boop*\n\n---\n\n## [0.43.0](url)\n\n- fix\n\n---\n\nGenerated by Release Please.\n"
+
+
[email protected]("ending", ["\n", "\r\n", "\r\r\n", "\r\r\r\n"])
+def test_normalization_restores_exact_release_please_delimiters(ending):
+ module = load_module()
+ damaged = BODY.replace("\n", ending)
+ # This is release-please's splitBody normalization: an extra CR survives.
+ if ending.count("\r") > 1:
+ assert "---" not in damaged.strip().replace("\r\n", "\n").split("\n")
+ assert module.normalize_body(damaged) == BODY
+
+
+def pending_release(**overrides):
+ pr = {
+ "number": 4643,
+ "merged_at": "2026-11-05T16:35:16Z",
+ "base": {"ref": "main"},
+ "head": {
+ "ref": "release-please--branches--main--components--headroom-ai",
+ "repo": {"full_name": "owner/repo"},
+ },
+ "user": {"type": "Bot"},
+ "labels": [{"name": "autorelease: pending"}],
+ "body": BODY.replace("\n", "\r\r\n"),
+ }
+ return {**pr, **overrides}
+
+
+def test_dry_run_never_writes(monkeypatch):
+ module = load_module()
+ monkeypatch.setattr(
+ module, "github_json", lambda *args, **kwargs: pytest.fail("unexpected write")
+ )
+ assert module.repair_release("owner/repo", pending_release(), apply=False)
+
+
+def test_api_write_uses_json_stdin_without_windows_text_file_roundtrip(monkeypatch):
+ module = load_module()
+ calls = []
+
+ def run(command, **kwargs):
+ calls.append((command, kwargs))
+ return SimpleNamespace(stdout="{}")
+
+ monkeypatch.setattr(module.subprocess, "run", run)
+ module.github_json("repos/owner/repo/pulls/4643", body=BODY)
+ command, kwargs = calls[0]
+ assert command[-4:] == ["--method", "PATCH", "--input", "-"]
+ assert module.json.loads(kwargs["input"])["body"] == BODY
+
+
+def test_workflow_repairs_before_release_detection():
+ workflow = SCRIPT.parents[1] / ".github" / "workflows" / "release-please.yml"
+ source = workflow.read_text(encoding="utf-8")
+ assert source.index("python scripts/normalize_release_pr_bodies.py") < source.index(
+ "uses: googleapis/release-please-action"
+ )
+ assert '--repo "${{ github.repository }}" --apply' in source
+
+
+def test_repairs_only_merged_pending_release_prs(monkeypatch):
+ module = load_module()
+ calls = []
+ monkeypatch.setattr(
+ module, "github_json", lambda endpoint, **kwargs: calls.append((endpoint, kwargs))
+ )
+ assert module.repair_release("owner/repo", pending_release())
+ assert calls == [("repos/owner/repo/pulls/4643", {"body": BODY})]
+
+
+ "overrides",
+ [
+ {"merged_at": None},
+ {"labels": [{"name": "autorelease: tagged"}]},
+ {"base": {"ref": "maintenance"}},
+ {"head": {"ref": "contributor-feature"}},
+ {"user": {"type": "User"}},
+ {
+ "head": {
+ "ref": "release-please--branches--main--components--headroom-ai",
+ "repo": {"full_name": "someone/fork"},
+ }
+ },
+ {"body": BODY},
+ {"body": BODY.replace("\n", "\r\n")},
+ ],
+)
+def test_does_not_edit_unrelated_or_already_valid_prs(monkeypatch, overrides):
+ module = load_module()
+ monkeypatch.setattr(
+ module, "github_json", lambda *args, **kwargs: pytest.fail("unexpected write")
+ )
+ assert not module.repair_release("owner/repo", pending_release(**overrides))
+
+
+def test_missing_release_envelope_fails_instead_of_silently_making_another_release(monkeypatch):
+ module = load_module()
+ monkeypatch.setattr(
+ module, "github_json", lambda *args, **kwargs: pytest.fail("unexpected write")
+ )
+ with pytest.raises(ValueError, match="4643.*release-please envelope"):
+ module.repair_release(
+ "owner/repo", pending_release(body="Oversized notes are elsewhere.\r\r\n")
+ )