Skip to content

ci: shorten audit-fix PR body to avoid odd line-breaks#124

Merged
venables merged 1 commit into
mainfrom
chore/audit-fix-pr-body
Jul 2, 2026
Merged

ci: shorten audit-fix PR body to avoid odd line-breaks#124
venables merged 1 commit into
mainfrom
chore/audit-fix-pr-body

Conversation

@venables

@venables venables commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Summary

The scheduled audit-fix workflow generates a PR body whose paragraphs were hard-wrapped mid-sentence. GitHub renders those as stray line breaks in the middle of sentences.

This collapses each paragraph to a single line (letting GitHub reflow it) and trims the prose so it's shorter and cleaner. Ran pnpm format afterwards; no other files changed.

Only the body: block of the Open or update fix PR step is affected -- the audit logic, token minting, and fail-on-remaining-advisories behavior are untouched.

AI usage

Claude Code (Opus 4.8) made this edit: rewording the PR-body markdown and running the formatter. Reviewed by a human before merge.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Chores
    • Updated the generated pull request text used by the audit fix workflow.
    • Clarified how partial fixes should be handled and simplified the guidance for manually cleaning up version overrides.
    • Revised wording around how the PR is generated, with no changes to workflow behavior.

The generated PR body hard-wrapped paragraphs mid-sentence, which GitHub
renders with stray line breaks. Collapse each paragraph to a single line
and trim the prose so it reads cleanly.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5030e660-4504-44ab-a172-cc9712799928

📥 Commits

Reviewing files that changed from the base of the PR and between f16b753 and 602441c.

📒 Files selected for processing (1)
  • .github/workflows/audit-fix.yaml

Walkthrough

Updated the PR description body text generated within the audit-fix GitHub Actions workflow. The wording for partial fixes now references pnpm audit --fix=override, and detailed cleanup guidance was replaced with a shorter checklist for scoping overrides, pinning versions, and adding advisory-named comments. No workflow logic changed.

Changes

Workflow PR body text update

Layer / File(s) Summary
Update PR body wording
.github/workflows/audit-fix.yaml
Rewrote the create-pull-request step's PR body text: references pnpm audit --fix=override, retains the AI usage note tied to AI_POLICY.md, and shortens cleanup guidance into a checklist (scope to major, pin versions, add advisory-naming comments matching pnpm-workspace.yaml).

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

  • agentcommercekit/ack#121: Directly modifies the same PR body text and workflow behavior in .github/workflows/audit-fix.yaml around pnpm audit --fix=override.

Poem

A rabbit hopped through YAML lines so neat,
Trimming words to make the message sweet,
"Fix override," it now proclaims with cheer,
No AI wrote this, the policy's clear,
Shorter checklists, versions pinned tight,
Hop, hop, the workflow reads just right.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the PR’s main change: shortening the audit-fix workflow PR body to avoid awkward line breaks.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/audit-fix-pr-body

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

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

@venables venables merged commit 54d6f07 into main Jul 2, 2026
3 checks passed
@venables venables deleted the chore/audit-fix-pr-body branch July 2, 2026 22:34
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