Skip to content

fix(scripts): remove static issue line from release PR template#1596

Open
brandonpelfrey wants to merge 1 commit intomainfrom
fix/bump-version-pr-template
Open

fix(scripts): remove static issue line from release PR template#1596
brandonpelfrey wants to merge 1 commit intomainfrom
fix/bump-version-pr-template

Conversation

@brandonpelfrey
Copy link
Copy Markdown
Collaborator

@brandonpelfrey brandonpelfrey commented Apr 8, 2026

Summary

Fix the release PR body generated by scripts/bump-version.ts so it no longer includes a static issue-closing line for version bumps.
This also corrects an oversight introduced in #1581 by making the test and formatting checkboxes reflect what the script actually ran.

Related Issue

Changes

  • remove the hardcoded Fixes #1577. line from the generated release PR body
  • make buildPrBody() accept runtime status so npm test and formatting checklist items match the actual run
  • update the release PR creation call site to pass the runtime flags used for the current invocation

Type of Change

  • Code change for a new feature, bug fix, or refactor.
  • Code change with doc updates.
  • Doc only. Prose changes without code sample modifications.
  • Doc only. Includes code sample changes.

Testing

  • npx prek run --all-files passes (or equivalently make check).
  • npm test passes.
  • make docs builds without warnings. (for doc-only changes)

Checklist

General

Code Changes

  • Formatters applied — npx prek run --all-files auto-fixes formatting (or make format for targeted runs).
  • Tests added or updated for new or changed behavior.
  • No secrets, API keys, or credentials committed.
  • Doc pages updated for any user-facing behavior changes (new commands, changed defaults, new features, bug fixes that contradict existing docs).

Doc Changes

  • Follows the style guide. Try running the update-docs agent skill to draft changes while complying with the style guide. For example, prompt your agent with "/update-docs catch up the docs for the new changes I made in this PR."
  • New pages include SPDX license header and frontmatter, if creating a new page.
  • Cross-references and links verified.

Signed-off-by: Brandon Pelfrey [email protected]

Summary by CodeRabbit

  • Chores
    • Updated PR generation to display test and formatting execution status through checkbox indicators in PR descriptions.
    • Removed "Related Issue" section from generated PR body template.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 8, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: e0f794c4-2803-4770-acb2-41884b1d102d

📥 Commits

Reviewing files that changed from the base of the PR and between 4c38bfa and a3731b6.

📒 Files selected for processing (1)
  • scripts/bump-version.ts

📝 Walkthrough

Walkthrough

The version bump script's PR body generation was refactored to dynamically reflect whether formatting and tests were executed during the release process. The function signature was updated to accept runtime state, and the PR template was simplified by removing the related issue section.

Changes

Cohort / File(s) Summary
PR Body Generation Logic
scripts/bump-version.ts
Updated buildPrBody to accept a PrBodyOptions object containing ranTests and ranFormat flags. These flags now dynamically set the checked/unchecked state of checkboxes in the "Testing" section. The "Related Issue" section was removed from the PR template.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes


🐰 A script so neat, it checks what was done,
Tests run? Format spun? Now everyone knows!
No mystery issue left hanging around,
Just clarity checked with each checkbox sound!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately describes the main change: removing the static issue line from the release PR template, which is the primary objective of this fix.
Linked Issues check ✅ Passed The PR addresses #1577's requirement for an automated version bump script by fixing the PR body generation, but the core automation requirement from #1577 was addressed in prior work; this PR refines it.
Out of Scope Changes check ✅ Passed All changes are within scope: removing the hardcoded issue line and updating buildPrBody() to reflect runtime test/format status are directly related to the release PR template objectives.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/bump-version-pr-template

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

@brandonpelfrey brandonpelfrey requested a review from cv April 8, 2026 03:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant