Commit a5a686a
doc: update commit-queue documentation
update the commit-queue contributing documentation by:
- removing the references of the feature being experimental
- clarifying that it applies to mergeable pull requests
PR-URL: #58275
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>1 parent fdf7612 commit a5a686a
1 file changed
Lines changed: 2 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,10 +1,8 @@ | |||
| 1 | 1 | # Commit queue | |
| 2 | 2 | ||
| 3 | - > Stability: 1 - Experimental | ||
| 4 | - | ||
| 5 | 3 | _tl;dr: You can land pull requests by adding the `commit-queue` label to it._ | |
| 6 | 4 | ||
| 7 | - Commit Queue is an experimental feature for the project which simplifies the | ||
| 5 | + Commit Queue is a feature for the project which simplifies the | ||
| 8 | 6 | landing process by automating it via GitHub Actions. With it, collaborators can | |
| 9 | 7 | land pull requests by adding the `commit-queue` label to a PR. All | |
| 10 | 8 | checks will run via `@node-core/utils`, and if the pull request is ready to | |
@@ -18,7 +16,7 @@ implementation details, reasoning for design choices, and current limitations. | |||
| 18 | 16 | From a high-level, the Commit Queue works as follow: | |
| 19 | 17 | ||
| 20 | 18 | 1. Collaborators will add `commit-queue` label to pull requests ready to land | |
| 21 | - 2. Every five minutes the queue will do the following for each pull request | ||
| 19 | + 2. Every five minutes the queue will do the following for each mergeable pull request | ||
| 22 | 20 | with the label: | |
| 23 | 21 | 1. Check if the PR also has a `request-ci` label (if it has, skip this PR | |
| 24 | 22 | since it's pending a CI run) | |
0 commit comments