dandua98 / PendingPR

A GitHub app to help you manage issues in pull requests better

Home Page:https://github.com/marketplace/pendingpr

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

PendingPR

PendingPR logo

A GitHub App built with Probot to help you manage issues in pull requests (PRs) better.

Usage

pending-pr-demo

PendingPR assigns a Pending PR label to an issue claimed to be closed by a PR in its body. The label is then removed from the issue as soon as the PR is closed. This provides better visibility to you and your team on what issues are currently in PRs so you can focus on what needs to be done instead!

For more infomation, check this GitHub article on Closing issues using keywords

Example:

The following PR body would assign a Pending PR label to issues 10, 12 and 15 if they exist.

This PR closes #10, resolves #12 and fixes: #15

Once this PR is closed, the Pending PR label will be removed from these issues. The issues are automatically closed by GitHub if the PR is closed.

Notes

  • PendingPR only assigns labels to open issues.
  • Reopening a closed PR will lead to Pending PR label being assigned to issues mentioned in the body if the issues are still open.
  • Editing a PR's body and removing/adding issues from body will remove/add the label to those issues.
  • Labelling an issue in a different repository isn't supported yet.

Developer Setup

To contribute to this repo and test locally, you will need to register a private github app and run this probot application locally. Follow this tutorial by probot for setup and instead of Generating a new app, simply fork and clone this repo.

# Install dependencies
yarn install

# Compile TypeScript
yarn build

# Run the bot
yarn start

# Run for local development
yarn dev

If it's your first time running the application or you haven't registered your app with a github yet, navigate to localhost:3000 in your browser to setup.

Contributing

If you have suggestions for how PendingPR could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.

License

ISC © 2019 Danish Dua danish@dandua.com (https://github.com/dandua98/PendingPR)

About

A GitHub app to help you manage issues in pull requests better

https://github.com/marketplace/pendingpr

License:ISC License


Languages

Language:TypeScript 97.1%Language:JavaScript 2.9%