Add workflow to draft release notes (open-telemetry#18359)

Author: trask

.github/scripts/draft-release-notes/merge.py

@@ -13,9 +13,9 @@
 section and bullet, is reported on stderr and excluded.
 
 By default writes to stdout. Use --splice to rewrite CHANGELOG.md in
-place, replacing just the `## Unreleased` block and preserving any
-unlinked summary bullets under `### 🚫 Deprecations` by pulling them
-forward into the new block.
+place, replacing the entire `## Unreleased` block. Any hand-written
+content in that block is discarded; review the resulting diff to recover
+anything worth keeping.
 """
 
 from __future__ import annotations
@@ -42,37 +42,6 @@
 PR_URL = "https://github.com/open-telemetry/opentelemetry-java-instrumentation/pull/{pr}"
 
 
-def extract_unlinked_deprecations(changelog_text: str) -> list[str]:
-    """Return bullet blocks under ## Unreleased / ### 🚫 Deprecations that
-    have no PR link, preserving multi-line wrapping."""
-    m = re.search(r"^## Unreleased\n(.*?)(?=^## |\Z)", changelog_text, re.S | re.M)
-    if not m:
-        return []
-    unreleased = m.group(1)
-    m = re.search(
-        r"^### 🚫 Deprecations\n(.*?)(?=^### |\Z)",
-        unreleased,
-        re.S | re.M,
-    )
-    if not m:
-        return []
-    section = m.group(1)
-    # Split into bullet blocks. A bullet starts with "- " at column 0 and runs
-    # until the next "- " at column 0; indented lines and blank lines inside
-    # a bullet are absorbed, anything else outside a bullet is dropped.
-    blocks: list[list[str]] = []
-    for line in section.splitlines():
-        if line.startswith("- "):
-            blocks.append([line])
-        elif blocks and (line.startswith(" ") or not line.strip()):
-            blocks[-1].append(line)
-    # Keep only blocks without a PR link.
-    return [
-        b for b in ("\n".join(lines).rstrip() for lines in blocks)
-        if b and not re.search(r"\[#\d+\]\(", b)
-    ]
-
-
 def load_decisions() -> list[dict]:
     out = []
     if not BUNDLE_ROOT.is_dir():
@@ -168,26 +137,17 @@ def main() -> int:
             continue
         grouped[section].append(d)
 
-    unlinked_deprecations: list[str] = []
-    if args.splice and CHANGELOG.exists():
-        unlinked_deprecations = extract_unlinked_deprecations(
-            CHANGELOG.read_text(encoding="utf-8")
-        )
-
     out_lines = [
         "## Unreleased",
         "",
     ]
 
     for key, header in SECTION_ORDER:
         items = sorted(grouped[key], key=lambda d: d["pr"])
-        preserved = unlinked_deprecations if key == "deprecations" else []
-        if not items and not preserved:
+        if not items:
             continue
         out_lines.append(header)
         out_lines.append("")
-        for block in preserved:
-            out_lines.append(block)
         for d in items:
             out_lines.append(format_bullet(d["bullet"], d["pr"]))
         out_lines.append("")
@@ -208,17 +168,14 @@ def main() -> int:
         new_text = text[: m.start()] + block + "\n" + text[m.end():]
         CHANGELOG.write_text(new_text, encoding="utf-8")
         bullet_count = sum(len(v) for v in grouped.values())
-        suffix = f", {len(unlinked_deprecations)} unlinked deprecation(s) preserved" if unlinked_deprecations else ""
-        print(f"Rewrote {CHANGELOG} ({bullet_count} PR-linked bullets{suffix})", file=sys.stderr)
+        print(f"Rewrote {CHANGELOG} ({bullet_count} PR-linked bullets)", file=sys.stderr)
     else:
         sys.stdout.write(block)
 
     if args.report:
         print("Section counts:", file=sys.stderr)
         for key, header in SECTION_ORDER:
             print(f"  {key}: {len(grouped[key])}", file=sys.stderr)
-        if unlinked_deprecations:
-            print(f"  unlinked-deprecations preserved: {len(unlinked_deprecations)}", file=sys.stderr)
 
     return 1 if errors else 0
 

.github/workflows/draft-release-notes.yml

@@ -0,0 +1,73 @@
+name: Draft release notes
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: draft-release-notes
+
+jobs:
+  draft:
+    if: github.repository == 'open-telemetry/opentelemetry-java-instrumentation'
+    runs-on: ubuntu-latest
+    environment: protected
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+
+      - name: Install Copilot CLI
+        run: |
+          curl -fsSL https://gh.io/copilot-install | bash
+          echo "$HOME/.local/bin" >> "$GITHUB_PATH"
+
+      - name: Use CLA approved bot
+        run: .github/scripts/use-cla-approved-bot.sh
+
+      - name: Run draft-release-notes
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}
+        run: python .github/scripts/draft-release-notes/draft-release-notes.py
+
+      - name: Upload draft diagnostics artifact
+        if: always()
+        id: upload-diagnostics
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: draft-release-notes-diagnostics-${{ github.run_id }}
+          path: build/changelog-bundle/**
+
+      - uses: actions/create-github-app-token@1b10c78c7865c340bc4f6099eb2f838309f1e8c3 # v3.1.1
+        id: otelbot-token
+        with:
+          app-id: ${{ vars.OTELBOT_APP_ID }}
+          private-key: ${{ secrets.OTELBOT_PRIVATE_KEY }}
+
+      - name: Create pull request against main
+        env:
+          ARTIFACT_URL: ${{ steps.upload-diagnostics.outputs.artifact-url }}
+          # not using secrets.GITHUB_TOKEN since pull requests from that token do not run workflows
+          GH_TOKEN: ${{ steps.otelbot-token.outputs.token }}
+        run: |
+          message="Draft release notes"
+          body=$(cat <<EOF
+          Automated draft of the \`## Unreleased\` section of \`CHANGELOG.md\`.
+
+          The entire \`## Unreleased\` block was regenerated from per-PR
+          classifications. Review the diff to recover any hand-written
+          content that should be retained.
+
+          [Download draft diagnostics]($ARTIFACT_URL)
+          EOF
+          )
+          branch="otelbot/draft-release-notes-${GITHUB_RUN_ID}"
+
+          git checkout -b $branch
+          git add CHANGELOG.md
+          git commit -m "$message"
+          git push --set-upstream origin $branch
+          gh pr create --title "$message" \
+                       --body "$body" \
+                       --base main