https://github.com/jamiebuilds/is-mergeable

Check if a GitHub Pull Request is in a (most likely) mergeable state
https://github.com/jamiebuilds/is-mergeable

Last synced: about 2 months ago
JSON representation

Check if a GitHub Pull Request is in a (most likely) mergeable state

• Host: GitHub
• URL: https://github.com/jamiebuilds/is-mergeable
• Owner: jamiebuilds
• License: mit
• Created: 2019-10-02T19:42:04.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-02-27T02:42:32.000Z (over 3 years ago)
• Last Synced: 2024-07-18T06:41:49.762Z (2 months ago)
• Language: JavaScript
• Size: 441 KB
• Stars: 22
• Watchers: 4
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# is-mergeable

> Check if a GitHub Pull Request is in a (most likely) mergeable state

## Install

```sh

npm install --global is-mergeable

```

## Usage

```sh

GITHUB_API_TOKEN="$TOKEN" is-mergeable \

  --owner jamiebuilds \

  --repo is-mergeable \

  --pull-request 14 \

  --min-reviews 1

  --check ci-tests

# [ Open ] Updating Documentation (jamiebuilds/is-mergeable#14)

# @jamiebuilds wants to merge 1 commit into `master` from `update-docs`

# https://github.com/jamiebuilds/is-mergeable/pull/14

#

#   ✓ Open

#   ✓ Mergeable

#   ✓ Rebaseable

#   ✗ Reviews: (0 approved, 1 requested changes, 1 pending)

#     ✗ @user1 requested changes

#     • @user2 pending reviewer

#   ✓ Checks: (1 successes, 1 failures, 0 pending)

#     ✓ ci-tests success

#     ✗ ci-build failure

#

#  ✗ jamiebuilds/is-mergeable#14 is not ready to be merged.

```

> **Note:** `GITHUB_API_TOKEN` needs (at least) read privileges of your repo

> and have the `repo` scope.