Connect GitHub and add your first repository
This takes about two minutes. Merge Scheduler works through a GitHub App, so you choose exactly which repositories it can see. It does not store your source code.
Step 1: sign in and install the app
- Press Start free with GitHub on the home page and sign in.
- GitHub asks where to install the app. Pick your account or organisation, then choose Only select repositories and tick the ones you want.
- GitHub sends you back to Merge Scheduler. If you are asked which workspace to link the installation to, pick yours or create a new one.
Step 2: add repositories to the workspace
- Open Settings, then Repositories, then Add repos.
- Tick the repositories you want to schedule merges for and press Add. Safe defaults apply straight away.
- A repository belongs to one workspace. Free covers 2 repositories.
Step 3: look at the defaults once
Press Edit on a repository to see how it is merged and watched. The ones worth a quick look:
- Merge into these branches: only pull requests into these branches can be scheduled. Remove them all to allow any branch.
- How to merge: merge commit, squash or rebase. Options turned off for the repository on GitHub are greyed out.
- Deploy to watch: tick the workflows that deploy. If none is ticked, every run the merge starts is watched.
- Require an approving review and Require green checks: when on, a pull request without them is skipped, not merged.
If a repository is missing from the list
The app can only list repositories you gave it access to. Open the installation on GitHub (Settings, Applications, Installed GitHub Apps), add the repository, and come back.
Next
Schedule your first merge, then switch on auto-revert so a bad deploy undoes itself.
Background reading: Merge commit vs squash vs rebase: what each GitHub merge actually does
More guides: Schedule your first merge · Set up automatic revert for a failed deploy