Skip to content

ci: enable the PR readiness helper #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Joibel wants to merge 1 commit into
base: main
Choose a base branch
from
Open

ci: enable the PR readiness helper #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/pr-readiness/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ A deterministic check ([`template.ts`](template.ts)) compares the description ag
- PR title/body/branch are attacker-controlled: they are only ever handled as data, never interpolated into shell or scripts. The comment never echoes contributor-supplied text — only the bot's own guidance, check titles/URLs, and template section names.
- All actions are pinned to full commit SHAs (enforced by repo lint).

## Dry run & rollout
## Dry run

`DRY_RUN: "true"` in the workflow renders the would-be comment and decisions to the job's **step summary** instead of commenting or drafting. Roll out: merge with dry-run on → watch summaries on real PRs (correct PR resolution, author gating, sensible text) → flip to `"false"`.
Setting `DRY_RUN: "true"` in the workflow renders the would-be comment and decisions to the job's **step summary** instead of commenting or drafting. Use it to test changes to the bot against real PRs (correct PR resolution, author gating, sensible text) without posting.

## Maintenance notes

Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/pr-readiness.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ concurrency:
cancel-in-progress: false

env:
# Dry-run: render to the job summary instead of commenting/drafting.
# Flip to "false" to go live.
DRY_RUN: "true"
# Dry-run: set to "true" to render to the job summary instead of
# commenting/drafting.
DRY_RUN: "false"

jobs:
assess:
Expand Down