Update release drafter workflow to support release branches

[afritzler]

Summary by CodeRabbit

• Chores
  • Enhanced release workflow to support automated triggering on release branches and manual dispatch options.
  • Improved release draft generation to accurately use the correct branch reference.

[coderabbitai]

Walkthrough

The PR modifies the release-drafter GitHub Actions workflow to trigger on release-prefixed branches (release-**), support manual workflow dispatch, add explicit permissions, and configure the release-drafter action to base drafts on the triggering branch using the commitish parameter.

Changes

Cohort / File(s)	Summary
GitHub Actions Workflow Configuration .github/workflows/release-drafter.yml	Adds release-branch pattern to push triggers, enables workflow_dispatch, introduces named job with pull-requests write permission, and configures release-drafter to use the triggering branch name via commitish parameter.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

• Create release branches for minor versions #159 — Creates release-<major.minor> branches that this workflow now targets and processes with the updated release-drafter configuration.

Suggested reviewers

• defo89

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The pull request description is missing entirely; no content was provided to explain the changes, objectives, or rationale for the workflow modifications.	Add a pull request description using the repository template, including proposed changes and any related issue numbers to provide context for reviewers.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely summarizes the main change: adding support for release branches to the release drafter workflow.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch chore/release-drafter

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

🧹 Nitpick comments (1)

.github/workflows/release-drafter.yml (1)

24-24: Tighten the comment wording for trigger accuracy.

Line 24 still implies merge-only behavior, but this workflow also runs on PR sync/open and manual dispatch.

Suggested wording

-      # Drafts your next Release notes as Pull Requests are merged into "main"
-      # or a release branch
+      # Drafts/updates release notes for the current target branch
+      # on PR target events, pushes, and manual dispatch.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In @.github/workflows/release-drafter.yml at line 24, Replace the ambiguous
comment "# or a release branch" with a more accurate comment that reflects all
triggers—for example replace that line with something like "# also runs on
pull_request (synchronize, opened) and workflow_dispatch" so the workflow's
comment clearly indicates it runs on PR sync/open, manual dispatch, and release
branches; update the existing comment string "# or a release branch"
accordingly.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.github/workflows/release-drafter.yml:
- Line 24: Replace the ambiguous comment "# or a release branch" with a more
accurate comment that reflects all triggers—for example replace that line with
something like "# also runs on pull_request (synchronize, opened) and
workflow_dispatch" so the workflow's comment clearly indicates it runs on PR
sync/open, manual dispatch, and release branches; update the existing comment
string "# or a release branch" accordingly.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 14d4a379-d77e-4c82-8cbd-6d67c9fb1eed

📥 Commits

Reviewing files that changed from the base of the PR and between ed20527 and 4fd567b.

📒 Files selected for processing (1)

• .github/workflows/release-drafter.yml