diff --git a/.changes/pr-pipeline/docs-github-token-approval-required-runs-d3d999e5.md b/.changes/pr-pipeline/docs-github-token-approval-required-runs-d3d999e5.md new file mode 100644 index 00000000000..634656e03d2 --- /dev/null +++ b/.changes/pr-pipeline/docs-github-token-approval-required-runs-d3d999e5.md @@ -0,0 +1,7 @@ +--- +bump: patch +--- + +### Fixed + +- The README's identity table now says a pull request `GITHUB_TOKEN` opens or pushes to gets `pull_request` runs that wait for approval, rather than none, and links GitHub's [Triggering a workflow from a workflow](https://docs.github.com/en/actions/how-tos/write-workflows/choose-when-workflows-run/trigger-a-workflow#triggering-a-workflow-from-a-workflow). The release workflows' header comments say the same. diff --git a/.github/workflows/release-generate-dependabot-changelog-fragments.yml b/.github/workflows/release-generate-dependabot-changelog-fragments.yml index 015d2c893dc..453d4d22100 100644 --- a/.github/workflows/release-generate-dependabot-changelog-fragments.yml +++ b/.github/workflows/release-generate-dependabot-changelog-fragments.yml @@ -10,8 +10,8 @@ name: Release Generate Dependabot Changelog Fragments # fragments, armed to auto-merge. The release pull request then takes them. # # It runs as the release GitHub App, never GITHUB_TOKEN: a pull request that -# GITHUB_TOKEN opens or updates starts no `pull_request` runs, and this one needs -# `ci-status`. The commit goes through createCommitOnBranch, which GitHub signs, +# GITHUB_TOKEN opens or updates gets its `pull_request` runs only after +# approval, and this one needs `ci-status` unattended. The commit goes through createCommitOnBranch, which GitHub signs, # so main's required_signatures rule accepts it (the pattern of # release-publish-plugins.yml). A fragment is named after its merge commit, so # a rerun writes nothing twice. diff --git a/.github/workflows/release-publish-plugins.yml b/.github/workflows/release-publish-plugins.yml index fd527e5574a..7f71c7e0eb9 100644 --- a/.github/workflows/release-publish-plugins.yml +++ b/.github/workflows/release-publish-plugins.yml @@ -8,8 +8,8 @@ name: Release Publish Plugins # the head it checked. # # Both run as the dedicated release GitHub App, never GITHUB_TOKEN: a pull -# request that GITHUB_TOKEN opens or updates starts no `pull_request` runs, and -# the release pull request needs `ci-status`. The commit goes through the GraphQL +# request that GITHUB_TOKEN opens or updates gets its `pull_request` runs only +# after approval, and the release pull request needs `ci-status` unattended. The commit goes through the GraphQL # createCommitOnBranch mutation, which GitHub signs, so main's # required_signatures rule accepts it. # diff --git a/docs/conventions/pr-pipeline/README.md b/docs/conventions/pr-pipeline/README.md index 1382ec492ea..d5f232d6b6f 100644 --- a/docs/conventions/pr-pipeline/README.md +++ b/docs/conventions/pr-pipeline/README.md @@ -3585,8 +3585,8 @@ Which GitHub identity each workflow in `.github/workflows/` writes as. GitHub's | Identity | Workflows | Why | |---|---|---| -| `GITHUB_TOKEN` (`github-actions[bot]`) | every workflow not named below, and the reads and check runs of those that are | Its writes start no workflow run, a dispatch aside, which the lane sweep's digest and the monitoring lane rely on so their own issues start no lane; it has its own per-repository API quota ([ADR 0085](../../adr/0085-run-org-lanes-from-ci-workflows-under-one-lanes-app-with-central-grants.md)) | -| Lanes App `melodic-automation-lanes`, minted per job by the broker (`.github/actions/request-lane-token`) | `pr-merge.yml`, `pr-run-activity-write.yml` (which the write jobs of `pr-unblock`, `pr-refine` and `work-resolve-issue` call), `intake-triage.yml`, `work-unblock.yml`, `upstream-apply-changelog.yml`, `maintenance-tidy-code-upkeep.yml`, `maintenance-measure-skill-edit.yml` | Its pushes, labels and auto-merge arms must start the next lane's runs, which a `GITHUB_TOKEN` write does not; one App identity also lets the person tests tell a lane from a person ([lane write identity](../loop-lane/README.md#lane-write-identity)) | +| `GITHUB_TOKEN` (`github-actions[bot]`) | every workflow not named below, and the reads and check runs of those that are | Its writes start no workflow run, except a dispatch and a pull request it opens or pushes to, whose `pull_request` runs wait for approval ([GitHub](https://docs.github.com/en/actions/how-tos/write-workflows/choose-when-workflows-run/trigger-a-workflow#triggering-a-workflow-from-a-workflow)); the lane sweep's digest and the monitoring lane rely on this so their own issues start no lane; it has its own per-repository API quota ([ADR 0085](../../adr/0085-run-org-lanes-from-ci-workflows-under-one-lanes-app-with-central-grants.md)) | +| Lanes App `melodic-automation-lanes`, minted per job by the broker (`.github/actions/request-lane-token`) | `pr-merge.yml`, `pr-run-activity-write.yml` (which the write jobs of `pr-unblock`, `pr-refine` and `work-resolve-issue` call), `intake-triage.yml`, `work-unblock.yml`, `upstream-apply-changelog.yml`, `maintenance-tidy-code-upkeep.yml`, `maintenance-measure-skill-edit.yml` | Its pushes, labels and auto-merge arms must start the next lane's runs unattended, which a `GITHUB_TOKEN` write does not (its pull request pushes start runs only after approval); one App identity also lets the person tests tell a lane from a person ([lane write identity](../loop-lane/README.md#lane-write-identity)) | | Release App `melodic-release` (`PLUGIN_RELEASE_APP_PRIVATE_KEY`, `actions/create-github-app-token`) | `release-publish-plugins.yml`, `release-generate-dependabot-changelog-fragments.yml` | A pull request `GITHUB_TOKEN` opens or updates gets its `pull_request` runs only after approval, and these pull requests need theirs unattended | | Owner token | none | Only the owner's own sessions use it; the babysit scripts count its calls as the `owner-token` API pool |