Skip to content
This repository has been archived by the owner on May 4, 2022. It is now read-only.

Latest commit

 

History

History
71 lines (47 loc) · 2.8 KB

SETTINGS.md

File metadata and controls

71 lines (47 loc) · 2.8 KB

Before you get started

Connect and configure these integrations:

  1. GitHub (required)

How to configure

  1. Disable dry-run mode

    Dry run

    By default, this skill will leave a comment on a PR that when it found one to auto-merge. This feature is intended for you to gain confidence with the skill and its configuration. Once you're happy with the configuration, you can disable dry-run and have this skill merge your pull requests for real.

  2. Select the default policy to use when auto-merging pull requests

    Auto-merge policy

    Select one of the auto-merge policies as the default. This can be changed for any pull request by changing the labels on the pull request.

    • On successful reviews and status checks — Triggers auto-merge if all requested reviews are approved and all commit status checks are green.
    • On successful status checks — Triggers auto-merge if all status checks are green.
    • On passing branch protection rule — Trigger auto-merge if a GitHub branch protection rule passes

    Note: there must be at least one commit status check in order for the auto-merge policy to be met. This skill supports commit status checks; and GitHub Checks API as well GitHub Branch Protection Rules.

  3. Specify the default merge method

    Auto-merge method

    Select one of these methods:

    • Merge commit — Create merge commit
    • Squash and merge — Squash all branch commits and merge
    • Rebase and merge — Rebase branch onto target branch and merge
  4. Auto-merge pull requests from certain users only

    Auto-merge authors

    This parameter lets you specify GitHub logins of users or bots from whom you want this skill to auto-merge pull requests. When this is configured, pull requests created by authors not in this list won't be auto-merged.

  5. Determine repository scope

    Repository filter

    By default, this skill will be enabled for all repositories in all organizations you have connected.

    To restrict the organizations or specific repositories on which the skill will run, you can explicitly choose organizations and repositories.

  6. Activate the skill

    Save your configuration and activate the skill by clicking the "Enable skill" button.