meta: document collaborator automation · nodejs/node@db0e859 · GitHub
Skip to content

Commit db0e859

Browse files
panvaaduh95
panva
authored and
aduh95
committed
meta: document collaborator automation
Document how collaborators should use the commit queue, fast-track, stale automation, and saved triage views. Clarify needs-ci semantics and reviewer follow-through. Signed-off-by: Filip Skokan <panva.ip@gmail.com> PR-URL: #65671 Refs: nodejs/collaborators#256 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
1 parent 4bb07ab commit db0e859

3 files changed

Lines changed: 101 additions & 20 deletions

File tree

‎doc/contributing/collaborator-guide.md‎

Lines changed: 65 additions & 5 deletions

‎doc/contributing/commit-queue.md‎

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,29 @@
33
_tl;dr: You can ask the queue to land pull requests by adding the
44
`commit-queue` label to them._
55

6-
Commit Queue is a feature for the project which simplifies the
7-
landing process by automating it via GitHub Actions. With it, collaborators can
8-
queue pull requests for landing by adding the `commit-queue` label to a PR. The
9-
selector checks readiness with `@node-core/utils`. If the pull request is only
10-
blocked on a deferrable condition, currently wait time, the queue leaves the
11-
label in place and retries later. For pull requests that are at least two days
12-
old and still waiting for a second approval, the queue adds the
13-
`lacks-second-approval` label. The queue removes that label when it removes the
14-
`commit-queue` label. Other failures continue to the existing landing and
15-
failure-reporting path.
6+
Commit Queue simplifies the landing process by automating it with GitHub
7+
Actions. Once a pull request is [author ready][] and its current CI has passed, a
8+
collaborator can queue it for landing by adding the `commit-queue` label. A
9+
second approval is not required before adding the label.
10+
11+
The queue checks readiness with `@node-core/utils`, including the required wait
12+
time measured from when the pull request was opened:
13+
14+
* Pull requests with at least two approvals must be open for 48 hours.
15+
* Pull requests with one approval must be open for seven days.
16+
* Correctly approved [fast-track pull requests][] have no minimum wait time.
17+
18+
If wait time is the only unmet condition, the queue leaves the `commit-queue`
19+
label in place and retries later. For queued pull requests that are at least two
20+
days old and still waiting for a second approval, it also adds the
21+
`lacks-second-approval` label. Another approval makes the pull request eligible
22+
for the next queue run, provided that all other requirements remain satisfied.
23+
The queue removes `lacks-second-approval` automatically when it removes
24+
`commit-queue`; collaborators do not need to remove it manually.
25+
26+
Hard failures remove `commit-queue`, add `commit-queue-failed`, and post a
27+
comment with the actionable failure reason and retry instructions. To resolve the
28+
failure, remove `commit-queue-failed`, and add `commit-queue` to retry.
1629

1730
To make the Commit Queue squash all the commits of a pull request into the
1831
first one, add the `commit-queue-squash` label.
@@ -35,3 +48,6 @@ These are the currently known limitations of the commit queue:
3548
4. Only Jenkins CI and GitHub Actions are checked (V8 CI and CITGM are ignored).
3649
5. The PR must target the `main` branch (PRs opened against other branches, such
3750
as backport PRs, are ignored).
51+
52+
[author ready]: ./collaborator-guide.md#author-ready-pull-requests
53+
[fast-track pull requests]: ./collaborator-guide.md#waiting-for-approvals

‎doc/contributing/first-contributions.md‎

Lines changed: 10 additions & 5 deletions

0 commit comments

Comments
 (0)