Skip to content

Latest commit

 

History

History
77 lines (55 loc) · 2.56 KB

README.md

File metadata and controls

77 lines (55 loc) · 2.56 KB
Raw

Build Status Dependencies Status

close-label

A GitHub App built with Probot that applies a specific label to an issue closed through a pull request in the same repository considering its current labels.

Setup for using the bot in your repo

Create a file named .github/close-label.yml and fill it with whatever you like. Example:

bug: fixed
enhancement: implemented
feature: implemented

If a pull request gets merged and it has "fixes #42" in its body, if issue #42 has the label feature, the label implemented will be applied to it.

Using the bot as a GitHub app

Install the app through the GitHub Marketplace.

Using the bot as a GitHub Action

name: Close-label
on:
- pull-request

jobs:
  triage:
    runs-on: ubuntu-latest
    steps:
    - uses: logerfo/[email protected]
      with:
        repo-token: ${{ secrets.GITHUB_TOKEN }}

It will work for

  • Every documented keyword.
  • Multiple index labels: if the issue has both bug and feature label, it will get labeled as both fixed and implemented.

It will not work for

  • Retroactively, as design.
  • Multiple target labels. Example: bug: ["fixed", "done"]. This should be easy to do and it's up for grabs, feel free to submit a pull request making this happen.
  • Cross-repo references. I think it might be possible to develop if both repos have the app installed, but I'm not sure.

Setup for running the bot

# Install dependencies
npm install

# Run typescript
npm run build

# Run the bot
npm start

Changelog

Click here.

Contributing

If you have suggestions for how close-label 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.

Donate

BTC: 1LoGErFoNzE1gCA5fzk6A82nV6iJdKssSZ

License

ISC © 2019 Bruno Logerfo [email protected] (https://github.com/Logerfo/close-label)

Icon

The application icon is a modified version of a icon by Cole Bemis under the Creative Commons 3.0 License.