merger

command module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 21, 2020 License: MIT Imports: 8 Imported by: 0

README

merger

A super simple utility for merging github PRs that pass all their checks and are mergeable.

merger is intended to be used on some sort of schedule. This can easily be done using something like GitHub workflows (see .github/workflows/merger.yml).

⚠ Only use merger if you have CI setup so that your required checks are run on PRs ⚠

Usage

Usage of merger:
  -label string
    	Label to filter pull requests by. Only PRs with this label will be checked and merged.
  -repository string
    	GitHub repository to check issues on. Should be of the for <owner>/<repo>. Uses GITHUB_REPOSITORY if not provided.
  -token string
    	GitHub token used for authentication. Uses GITHUB_TOKEN if not provided.

If you're using merger in a GitHub workflow GITHUB_REPOSITORY is an environment variable provided by default and GITHUB_TOKEN can be provided as a secret. You can then call merger like so:

merger -label dependencies

Where any PR with the dependencies label (e.g. dependabot) will be merged if its checks are passing and it is mergeable.

License

Licensed under

Contribution

Any contribution shall be licensed under the MIT license without any additional terms or conditions.

Documentation

Overview

CLI tool to merge PRs with specified labels that have passed checks.

This tool is intended to be run at a regular interval (e.g. using GitHub workflows).

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL