Skip to content

Commit 8a63b73

Browse files
anth-volkclaude
andcommitted
Say the PR description check runs on open pull requests
github-prs.md said the job checks every pull request; since the previous commit it skips closed ones. Also correct a test fixture's docstring: it loads the check script as a module, which is not how the workflow runs it. Part of #861. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 parent 3aba8cd commit 8a63b73

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

‎docs/engineering/skills/github-prs.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ human instead.
4646
In a stack of pull requests, only the lowest unmerged one runs the full PR
4747
workflow (`.github/workflows/pr.yml`) and the Modal image smoke. The ones above
4848
it run only the `CI complete` job, which fails and says so, and the
49-
`PR description` job, which every pull request runs. A stack therefore uses one
50-
set of runners instead of one per layer.
49+
`PR description` job, which every open pull request runs. A stack therefore
50+
uses one set of runners instead of one per layer.
5151

5252
- **`CI complete` is the required check.** It needs every other job in
5353
`pr.yml`. On a pull request that isn't stacked, or is the lowest unmerged
@@ -68,10 +68,10 @@ set of runners instead of one per layer.
6868
## The `Fixes` Line
6969

7070
Rule `sim.process.pr-tracking-issue`. The `PR description` job, in
71-
`.github/workflows/pr-description.yml`, checks every pull request whenever it is
72-
opened, reopened or edited and on every push, including each pull request in a
73-
stack. It reads the description from the event that started the run and fails
74-
unless:
71+
`.github/workflows/pr-description.yml`, checks every open pull request whenever
72+
it is opened, reopened or edited and on every push, including each pull request
73+
in a stack. It skips closed pull requests. It reads the description from the
74+
event that started the run and fails unless:
7575

7676
- the first line is exactly `Fixes #ISSUE_NUMBER`;
7777
- `ISSUE_NUMBER` is an open issue in this repository. A pull request's number,

‎projects/policyengine-simulation-entry/tests/test_pr_description_check.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656

5757
@pytest.fixture(scope="module")
5858
def check_module() -> ModuleType:
59-
"""Load the check script in this process, as the workflow runs it."""
59+
"""Load the check script as a module in this process."""
6060
spec = importlib.util.spec_from_file_location("check_pr_description", CHECK_SCRIPT)
6161
module = importlib.util.module_from_spec(spec)
6262
spec.loader.exec_module(module)

0 commit comments

Comments
 (0)