Skip to content

Warning

You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?

Merge Schedule

Actions
merge pull requests on a scheduled day
v2.3.0
By gr2m
Star (145)

merge-schedule-action

GitHub Action to merge pull requests on a scheduled day

Usage

Create .github/workflows/merge-schedule.yml

name: Merge Schedule

on:
  pull_request:
    types:
      - opened
      - edited
      - synchronize
  schedule:
    # https://crontab.guru/every-hour
    - cron: '0 * * * *'

jobs:
  merge_schedule:
    runs-on: ubuntu-latest
    steps:
      - uses: gr2m/merge-schedule-action@v2
        with:
          # Merge method to use. Possible values are merge, squash or
          # rebase. Default is merge.
          merge_method: squash
          # Time zone to use. Default is UTC.
          time_zone: 'America/Los_Angeles'
          # Require all pull request statuses to be successful before
          # merging. Default is `false`.
          require_statuses_success: 'true'
          # Label to apply to the pull request if the merge fails. Default is
          # `automerge-fail`.
          automerge_fail_label: 'merge-schedule-failed'
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

In your pull requests, add a line to the end of the pull request description looking like this

/schedule 2022-06-08

Or if you need a more precise, timezone-safe setting, you can use an ISO 8601 date string

/schedule 2022-06-08T09:00:00.000Z

Any string that works with the new Date() constructor will work.

To control at which time of the day you want the pull request to be merged, I recommend adapting the - cron: ... setting in the workflow file.

The action sets a pending commit status if the pull request was recognized as being scheduled.

Note that pull requests from forks are ignored for security reasons.

License

ISC

Merge Schedule is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

merge pull requests on a scheduled day
v2.3.0
By gr2m

Merge Schedule is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.