Add support for pull_request_review event.

.github/workflows/automerge.yml

@@ -3,6 +3,9 @@ name: automerge
 on:
  schedule:
  - cron: 0 * * * *
+ pull_request_review:
+ types:
+ - submitted
  pull_request_target:
  types:
  - opened

README.md

@@ -35,6 +35,7 @@ Ensure the following is set up in your repository settings before enabling this
 | `required-labels` | no | Comma-separated list of labels that are required to be applied to a pull request for it to be merged automatically. |
 | `pull-request` | no | Try merging the specified pull request automatically. For example, you can pass an input from a `workflow_dispatch` event. |
 | `pull-request-author-associations` | no | Comma-separated list of required [author associations](https://docs.github.com/en/graphql/reference/enums#commentauthorassociation) for the pull request author. (By default, pull requests by any author are allowed.) |
+| `review-author-associations` | no | Comma-separated list of required [author associations](https://docs.github.com/en/graphql/reference/enums#commentauthorassociation) for the review author. (By default, pull requests reviewd by `OWNER`s, `MEMBER`s and `COLLABORATOR`s are allowed.) |
 | `dry-run` | no | If set to `true`, will not actually merge pull requests but still perform all other checks. |
 
 ## Example Workflow
@@ -50,6 +51,12 @@ on:
  schedule:
  - cron: 0 * * * *
 
+ # Try enabling auto-merge when a pull request is approved. Note that this event skips the check
+ # for the pull request author association and instead checks the review author association.
+ pull_request_review:
+ types:
+ - submitted
+
  # Try enabling auto-merge for a pull request when a draft is marked as “ready for review”, when
  # a required label is applied or when a “do not merge” label is removed, or when a pull request
  # is updated in any way (opened, synchronized, reopened, edited).

action.yml

@@ -48,6 +48,12 @@ inputs:
  description: >
  Comma-separated list of required author associations for the pull request author.
  (By default, pull requests by any author are allowed.)
+ review-author-associations:
+ required: false
+ default: OWNER,MEMBER,COLLABORATOR
+ description: >
+ Comma-separated list of required author associations for the review author.
+ (By default, pull requests reviewed by `OWNER`s, `MEMBER`s and `COLLABORATOR`s are allowed.)
  dry-run:
  required: true
  description: >

src/automerge-action.ts

@@ -17,7 +17,7 @@ import {
  requiredStatusChecksForBranch,
  squashCommit,
 } from './helpers'
-import { MergeMethod, Octokit, PullRequest } from './types'
+import { MergeMethod, Octokit, PullRequest, Review } from './types'
 
 export class AutomergeAction {
  octokit: Octokit
@@ -117,7 +117,7 @@ export class AutomergeAction {
  }
  }
 
- async autoMergePullRequest(number: number): Promise<void> {
+ async autoMergePullRequest(number: number, review?: Review): Promise<void> {
  core.info(`Evaluating mergeability for pull request ${number}:`)
 
  const pullRequest = (
@@ -146,14 +146,38 @@ export class AutomergeAction {
  return
  }
 
- const authorAssociations = this.input.pullRequestAuthorAssociations
- if (authorAssociations.length > 0 && !isAuthorAllowed(pullRequest, authorAssociations)) {
- core.info(
- `Author of pull request ${number} is ${pullRequest.author_association} but must be one of the following: ` +
- `${authorAssociations.join(', ')}`
- )
- await this.disableAutoMerge(pullRequest)
- return
+ if (review) {
+ const authorAssociations = this.input.reviewAuthorAssociations
+
+ if (authorAssociations.length > 0 && !isAuthorAllowed(review, authorAssociations)) {
+ core.info(
+ `Reviewer of pull request ${number} is ${review.author_association} but must be one of the following: ` +
+ `${authorAssociations.join(', ')}`
+ )
+ return
+ }
+
+ if (review.state !== 'approved') {
+ core.info(`Pull request ${number} is not mergable because the review is not an approval.`)
+ return
+ }
+
+ if (pullRequest.head.sha !== review.commit_id) {
+ core.info(
+ `Pull request ${number} is not mergable because current commit ${pullRequest.head.sha} does not match reviewed commit ${review.commit_id}.`
+ )
+ return
+ }
+ } else {
+ const authorAssociations = this.input.pullRequestAuthorAssociations
+ if (authorAssociations.length > 0 && !isAuthorAllowed(pullRequest, authorAssociations)) {
+ core.info(
+ `Author of pull request ${number} is ${pullRequest.author_association} but must be one of the following: ` +
+ `${authorAssociations.join(', ')}`
+ )
+ await this.disableAutoMerge(pullRequest)
+ return
+ }
  }
 
  const baseBranch = pullRequest.base.ref
@@ -247,7 +271,7 @@ export class AutomergeAction {
  async handlePullRequestTarget(): Promise<void> {
  core.debug('handlePullRequestTarget()')
 
- const { action, label, pull_request: pullRequest } = github.context.payload
+ const { action, pull_request: pullRequest } = github.context.payload
 
  if (!action || !pullRequest) {
  return
@@ -256,6 +280,25 @@ export class AutomergeAction {
  await this.autoMergePullRequest(pullRequest.number)
  }
 
+ async handlePullRequestReview(): Promise<void> {
+ core.debug('handlePullRequestReview()')
+
+ const { action, pull_request: pullRequest, review } = github.context.payload
+
+ if (!action || !pullRequest || !review) {
+ return
+ }
+
+ if (action !== 'submitted') {
+ core.warning(
+ `This action does not support the '${action}' action for the '${github.context.eventName}' event.`
+ )
+ return
+ }
+
+ await this.autoMergePullRequest(pullRequest.number, review)
+ }
+
  async handleSchedule(): Promise<void> {
  core.debug('handleSchedule()')
 

src/input.ts

@@ -33,6 +33,7 @@ export class Input {
  requiredLabels: string[]
  pullRequest: number | null
  pullRequestAuthorAssociations: string[]
+ reviewAuthorAssociations: string[]
  dryRun: boolean
 
  constructor() {
@@ -72,6 +73,8 @@ export class Input {
  this.pullRequest = getNumber('pull-request')
  this.pullRequestAuthorAssociations = getArray('pull-request-author-associations')
 
+ this.reviewAuthorAssociations = getArray('review-author-associations')
+
  this.dryRun = core.getInput('dry-run') === 'true'
  }
 

src/main.ts

@@ -19,6 +19,10 @@ async function run(): Promise<void> {
 
  const eventName = github.context.eventName
  switch (eventName) {
+ case 'pull_request_review': {
+ await action.handlePullRequestReview()
+ break
+ }
  case 'pull_request_target': {
  await action.handlePullRequestTarget()
  break