Schedule your first merge
Before you start, the repository needs to be added to your workspace. If it is not, follow the connect guide first.
Schedule it
- Open Schedule from the menu.
- Pick the repository. Its open pull requests appear on the allowed branches; search by number, title, author or branch.
- Pick the pull request, then choose Merge at. The time is shown in your own time zone.
- Press Schedule merge.
What is checked
- When you schedule, and again at merge time, it checks that the pull request is open, not a draft, has no merge conflicts, is not blocked by branch protection, and passes the gates you set (approving review, green checks). If a check fails at merge time, the release is skipped and you are told why.
- The commit you scheduled is pinned. If someone pushes a new commit afterwards, the release is skipped instead of merging code nobody reviewed.
- If another scheduled pull request on the same branch touches the same files, you get a warning. On Pro you tick each one as checked before you can schedule.
After it merges
It follows the GitHub Actions deploy the merge started and emails you the result, with the failed step if there was one. Your workspace notify list gets the same email.
Several merges on the same branch
- One release merges at a time per repository and branch. The next one waits until the previous deploy has finished, up to 60 minutes by default (change it under Timeouts). After that wait it is skipped, not merged.
- Everything is checked again at merge time. If an earlier merge made your pull request conflict, or left it behind the branch, it is skipped and you are told why.
- The queue only covers releases made in this app. A merge a teammate makes directly on GitHub is not waited for: at your time the pull request is checked again, and if it is still clean it merges on top, even while their deploy is running.
- As soon as any pull request merges into that branch, including one a teammate merges directly on GitHub without this app, the owners of the releases waiting on that branch are checked and emailed if theirs would now be skipped, so you can fix it before its time.
- When you schedule, every other pull request already scheduled on that branch, before or after yours, is compared file by file. If any touches the same files you get a warning with the file names, and on Pro you tick a box for each one to confirm you checked it.
Change your mind
- Cancel: possible until the merge starts.
- Reschedule: open the release and pick a new time while it is still scheduled.
- Pause everything: on the Releases page, Pause all merges is an emergency brake. Anything that comes due while paused is skipped, not merged, and reverts already under way still run. Anyone who can schedule can pause; an owner resumes.
- Late runs: if the service was down and a release starts more than 15 minutes after its time, it is skipped and you are emailed, not merged at a time nobody planned.
- Revert: after a merge, the release page has a Revert button that opens and merges a revert pull request.
Background reading: How to schedule a GitHub pull request merge (4 ways) · Why a scheduled merge should pin the commit you approved
More guides: Connect GitHub and add your first repository · Set up automatic revert for a failed deploy · Release a backend and a frontend in order