An open API service indexing awesome lists of open source software.

https://github.com/fabernovel/probot-pr-milestone

🤖 GitHub App that checks that all the pull requests are tagged with a GitHub milestone
https://github.com/fabernovel/probot-pr-milestone

milestone probot-app pull-request

Last synced: 9 months ago
JSON representation

🤖 GitHub App that checks that all the pull requests are tagged with a GitHub milestone

Awesome Lists containing this project

README

          

# pr-milestone-checker

> A GitHub App built with [Probot](https://github.com/probot/probot) that checks that all the pull requests are tagged with a GitHub milestone.

## Usage

When a pull request is created/updated, this application checks whether it is properly [milestoned](https://help.github.com/en/articles/about-milestones).

![Usage](./docs/img/usage.gif)

> By default status is only set when the milestone is/was missing.

To use this bot with [GitHub Actions](https://github.com/features/actions), the following workflow can be defined as `.github/workflows/pr-milestone-checker.yml` in your repository.

```
name: PR milestone

on:
issues:
types: ['milestoned', 'demilestoned']
pull_request:
types: ['opened', 'edited', 'synchronize']

jobs:
check_pr_milestone:
runs-on: ubuntu-latest
steps:
- uses: zengularity/pr-milestone-checker@ghaction-1.0.x
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```

## Setup

```sh
# Install dependencies
npm install

# Run typescript
npm run build

# Run the bot
npm start
```

[![CircleCI](https://circleci.com/gh/zengularity/probot-pr-milestone.svg?style=svg)](https://circleci.com/gh/zengularity/probot-pr-milestone)

## Contributing

If you have suggestions for how this application 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](CONTRIBUTING.md).

## License

[ISC](LICENSE) © 2019 Zengularity (https://github.com/zengularity/probot-pr-milestone)