README

auto-approver

Automatically approve all GitHub PRs which match a specific pattern.

Installation

Run yarn global add auto-approver or npm i -g auto-approver.

Usage

CLI

Usage: auto-approver [options]

Automatically approve all GitHub PRs which match a specific pattern.

Options:
  -m, --message <text>  comment on PRs instead of approving them
  -c, --config <path>   specify a configuration file (default: .approverrc.json)
  -V, --version         output the version number
  -h, --help            display help for command

Configuration file

To use a configuration file, add a configuration file following the cosmiconfig standard (e.g. .approverrc.json) to your project and the auto-approver will find it automatically. Options from the CLI still take precedence over the configuration file.

The structure of the configuration file is the following:

{
  /** The GitHub auth token */
  authToken: string;
  /** Don't send any data */
  dryRun?: boolean;
  /** Include draft PRs */
  keepDrafts?: boolean;
  /** All projects to include */
  projects: {
    /** All projects hosted on GitHub in the format `user/repo` */
    gitHub: string[];
  };
  /** Post a comment on the PRs instead of approving them */
  useComment?: string;
  /**
   * Currently not in use
   * @deprecated
   */
  verbose?: boolean;
}

If you would like to use a custom configuration file, start the CLI with the option --config <file>.

Configuration file examples

JSON configuration example

Usage no npm install needed!