55* tl;dr: You can land Pull Requests by adding the ` commit-queue ` label to it.*
66
77Commit 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
1010checks will run via node-core-utils, and if the Pull Request is ready to land,
1111the 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
1414implementation details, reasoning for design choices, and current limitations.
1515
1616## Overview
1717
1818From 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
21212 . 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
46461 . 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
50502 . A CI must've ran and succeeded since the last change on the PR
51513 . 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
5858the scheduler. The scheduler is not guaranteed to run every five minutes, it
5959might 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
6262reasons:
6363
64641 . 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
87871 . The repository owner
88882 . The repository name
89893 . 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
9393The 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
9797if the last CI failed.
9898
9999The 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
102102to 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
115115once we start using the Commit Queue we notice that the number of required
116116reverts increases drastically, we can pause the queue until a Revert Queue is
117117implemented, 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