Skip to content

Commit

Permalink
Merge pull request #1 from jwenz723/jwenz723-patch-1
Browse files Browse the repository at this point in the history
update docs about ignore_auto_merge
  • Loading branch information
Jeff Wenzbauer authored Jan 27, 2023
2 parents a79104a + b3385b1 commit 0b8d9f4
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Auto-update is a minimalist [JavaScript GitHub action](https://help.github.com/en/articles/about-actions#javascript-actions) to keep pull requests with [auto-merge](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request) enabled [up to date with their base branch](https://developer.github.com/changes/2019-05-29-update-branch-api/). Setting the `auto_merge_all_prs` input to `true` will cause all PRs to be updated.
Auto-update is a minimalist [JavaScript GitHub action](https://help.github.com/en/articles/about-actions#javascript-actions) to keep pull requests with [auto-merge](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request) enabled [up to date with their base branch](https://developer.github.com/changes/2019-05-29-update-branch-api/). Setting the `ignore_auto_merge` input to `true` will cause all PRs to be updated.

It is the missing piece to really automatically merge pull requests when [strict status checks](https://help.github.com/en/articles/types-of-required-status-checks) are set up to protect against [semantic conflicts](https://bors.tech/essay/2017/02/02/pitch/).

Expand Down
7 changes: 5 additions & 2 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ const handleUnupdatablePullRequest = async (

const handlePullRequest = async (
pullRequest: PullRequest,
ignore_auto_merge: String,
ignore_auto_merge: string,
{
eventPayload,
octokit,
Expand Down Expand Up @@ -158,7 +158,10 @@ const run = async () => {
for (const pullRequest of pullRequests) {
// PRs are handled sequentially to avoid breaking GitHub's log grouping feature.
// eslint-disable-next-line no-await-in-loop
await handlePullRequest(pullRequest, ignore_auto_merge, { eventPayload, octokit });
await handlePullRequest(pullRequest, ignore_auto_merge, {
eventPayload,
octokit,
});
}
} catch (error: unknown) {
setFailed(ensureError(error));
Expand Down

0 comments on commit 0b8d9f4

Please sign in to comment.