Skip to content

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

License

Notifications You must be signed in to change notification settings

faberNovel/probot-pr-milestone

Repository files navigation

pr-milestone-checker

A GitHub App built with 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.

Usage

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

To use this bot with GitHub 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/[email protected]
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Setup

# Install dependencies
npm install

# Run typescript
npm run build

# Run the bot
npm start

CircleCI

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.

License

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