Skip to content

Commit 030e504

Browse files
committed
no-mistakes(document): Fixed stale PR CI docs: integration suite trigger wrong in CONTRIBUTING.md; overlong workflow comments reflowed. GOVERNANCE.md paid-work commitment checked, accurate.
1 parent 797c5b3 commit 030e504

3 files changed

Lines changed: 11 additions & 9 deletions

File tree

‎.github/workflows/conformance.yml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
name: conformance
22

33
# COST: the cross-port conformance matrix + full Java reactor + drift/mutation gates
4-
# are heavy, so they do NOT run on every push or PR (pr-ci.yml runs the touched ports' lanes on a PR) — release gate (tag `v*`), a NIGHTLY
5-
# schedule, and on-demand (workflow_dispatch). Run them LOCALLY before opening/merging
4+
# are heavy, so they do NOT run on every push or PR (pr-ci.yml runs the touched ports'
5+
# lanes on a PR) — release gate (tag `v*`), a NIGHTLY schedule, and on-demand
6+
# (workflow_dispatch). Run them LOCALLY before opening/merging
67
# a PR:
78
# scripts/ci-local.sh # full parity (this + integration suite + drift)
89
# scripts/ci-local.sh --quick # everything except the docker integration suite

‎.github/workflows/pr-ci.yml‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ name: pr-ci
1212
# WHICH PORTS: `detect` maps the PR's changed paths to ports with
1313
# scripts/ci-affected-ports.sh, the same mapper local-ci.yml uses. A change under a
1414
# port's directory selects that port; a change to fixtures/, spec/, scripts/, .github/,
15-
# agent-context/ or anything unrecognised selects ALL ports (the mapper fails open); a docs-only change
16-
# selects none and runs only the offline `gates` lane.
15+
# agent-context/ or anything unrecognised selects ALL ports (the mapper fails open); a
16+
# docs-only change selects none and runs only the offline `gates` lane.
1717
#
1818
# WHAT RUNS PER PORT: unit tests plus the conformance corpora, not the docker
1919
# integration suites (integration-tests.yml owns those, on tags and on demand):
@@ -24,8 +24,9 @@ name: pr-ci
2424
# python / csharp — the port's full test suite and conformance
2525
#
2626
# THE REQUIRED CHECK: the final job, `pr-ci`, is the name to put in branch protection
27-
# when a maintainer decides to (it is not required yet; `leak-scan` is). It always runs and is green only when every lane that was selected passed, so the
28-
# set of lanes can change per PR without touching branch protection. Do not rename it.
27+
# when a maintainer decides to (it is not required yet; `leak-scan` is). It always runs
28+
# and is green only when every lane that was selected passed, so the set of lanes can
29+
# change per PR without touching branch protection. Do not rename it.
2930
#
3031
# SECURITY: this is a `pull_request` workflow on GitHub-hosted runners with a read-only
3132
# token and no secrets, so fork-submitted code cannot reach anything. It must NEVER move

‎CONTRIBUTING.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ conformance corpora. This guide covers how to propose changes.
3030
3. Run the gates locally with **`scripts/ci-local.sh --quick`** and make sure it's
3131
green. On a pull request GitHub Actions runs the leak scan (`hygiene.yml`) and the
3232
unit and conformance tests of the ports your change touches (`pr-ci.yml`); the docker
33-
integration suites run on `main`, nightly and on release tags — see the *Local CI*
33+
integration suites run on release tags and on manual dispatch — see the *Local CI*
3434
section below.
3535
4. Open a **pull request** against `main` and fill out the PR template.
3636
5. A maintainer reviews the change and the checks on the pull request before merge. Who can
@@ -90,8 +90,8 @@ under `fixtures/`, `spec/`, `scripts/`, `.github/` or `agent-context/`, or to an
9090
outside a port's directory that the selector does not recognise, touches every port; a
9191
change only to `docs/` or to Markdown files outside those directories runs just the
9292
offline gates). Its `pr-ci` job is green only when every selected lane is, and a newer
93-
push cancels the superseded run. The docker integration suites run on `main`, nightly and
94-
on release tags. Run the script locally before opening or merging a PR, so nothing red
93+
push cancels the superseded run. The docker integration suites run on release tags and on
94+
manual dispatch. Run the script locally before opening or merging a PR, so nothing red
9595
reaches `main`:
9696

9797
```bash

0 commit comments

Comments
 (0)