Skip to content
This repository has been archived by the owner on Jun 22, 2021. It is now read-only.

jonathanong/gh-automerge

Repository files navigation

gh-automerge

GH-Automerge

CircleCI


GH-Automerge is a cron bot that uses CircleCi to automatically merge pull requests that pass CI.


GH-Automerge automatically

  • Merges the master into out-of-date pull request branches
  • Merges pull requests when they're up-to-date and pass CI

Usage

Using GH-Automerge is easy. Once setup, enable automerging pull requests by adding a Github AUTOMERGE Label. See the image above.


Setup

Setting up GH-Automerge for a repository in with these steps.

  • Create a repository
  • Install, npm install --save-dev gh-automerge
  • Copy cron config from this .circleci/config.yml template into your repository
  • Enable your repository in CircleCi
  • Add a GITHUB_TOKEN env var in CircleCi
  • Add a GITHUB_ORG env var in CircleCi (the GITHUB_ORG can be a Github Organization or your Github User Name).
  • Add the Github label AUTOMERGE to your repository