Skip to content

Commit f1217d6

Browse files
Trottrichardlau
authored andcommitted
doc: revise commit-queue.md
Make minor fixes to the text. PR-URL: #35006 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Mary Marchini <[email protected]> Reviewed-By: Denys Otrishko <[email protected]> Reviewed-By: Daijiro Wachi <[email protected]> Reviewed-By: Yosuke Furukawa <[email protected]> Reviewed-By: Gerhard Stöbich <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent fb2111e commit f1217d6

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

doc/guides/commit-queue.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@
55
*tl;dr: You can land Pull Requests by adding the `commit-queue` label to it.*
66

77
Commit Queue is an experimental feature for the project which simplifies the
8-
landing process by automating it via GitHub Actions. With it, Collaborators are
9-
able to land Pull Requests by adding the `commit-queue` label to a PR. All
8+
landing process by automating it via GitHub Actions. With it, Collaborators can
9+
land Pull Requests by adding the `commit-queue` label to a PR. All
1010
checks will run via node-core-utils, and if the Pull Request is ready to land,
1111
the Action will rebase it and push to master.
1212

13-
This document gives an overview on how the Commit Queue works, as well as
13+
This document gives an overview of how the Commit Queue works, as well as
1414
implementation details, reasoning for design choices, and current limitations.
1515

1616
## Overview
1717

1818
From a high-level, the Commit Queue works as follow:
1919

20-
1. Collaborators will add `commit-queue` label to Pull Reuqests ready to land
20+
1. Collaborators will add `commit-queue` label to Pull Requests ready to land
2121
2. Every five minutes the queue will do the following for each Pull Request
2222
with the label:
2323
1. Check if the PR also has a `request-ci` label (if it has, skip this PR
@@ -45,7 +45,7 @@ of the commit queue:
4545

4646
1. All commits in a Pull Request must either be following commit message
4747
guidelines or be a valid [`fixup!`](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---fixupltcommitgt)
48-
commits that will be correctly handled by [`--autosquash`](https://git-scm.com/docs/git-rebase#Documentation/git-rebase.txt---autosquash)
48+
commit that will be correctly handled by the [`--autosquash`](https://git-scm.com/docs/git-rebase#Documentation/git-rebase.txt---autosquash)
4949
option
5050
2. A CI must've ran and succeeded since the last change on the PR
5151
3. A Collaborator must have approved the PR since the last change
@@ -58,7 +58,7 @@ events every five minutes. Five minutes is the smallest number accepted by
5858
the scheduler. The scheduler is not guaranteed to run every five minutes, it
5959
might take longer between runs.
6060

61-
Using the scheduler is preferrable over using pull_request_target for two
61+
Using the scheduler is preferable over using pull_request_target for two
6262
reasons:
6363

6464
1. if two Commit Queue Actions execution overlap, there's a high-risk that
@@ -87,7 +87,7 @@ that into a list of PR ids we can pass as arguments to
8787
1. The repository owner
8888
2. The repository name
8989
3. The Action GITHUB_TOKEN
90-
4. Every positional argument starting at this one will be a Pull Reuqest ID of
90+
4. Every positional argument starting at this one will be a Pull Request ID of
9191
a Pull Request with commit-queue set.
9292

9393
The script will iterate over the pull requests. `ncu-ci` is used to check if
@@ -97,7 +97,7 @@ is pending. No other CI validation is done here since `git node land` will fail
9797
if the last CI failed.
9898

9999
The script removes the `commit-queue` label. It then runs `git node land`,
100-
forwarding stdout and stderr to a file. If any errors happens,
100+
forwarding stdout and stderr to a file. If any errors happen,
101101
`git node land --abort` is run, and then a `commit-queue-failed` label is added
102102
to the PR, as well as a comment with the output of `git node land`.
103103

@@ -115,4 +115,4 @@ Queue to work because the Action lands PRs just like collaborators do today. If
115115
once we start using the Commit Queue we notice that the number of required
116116
reverts increases drastically, we can pause the queue until a Revert Queue is
117117
implemented, but until then we can enable the Commit Queue and then work on a
118-
Revert Queue as a follow up.
118+
Revert Queue as a follow-up.

0 commit comments

Comments
 (0)