pr-naming

A GitHub App built with Probot that check the naming of pull requests

Setup

# Install dependencies
npm install

# Run typescript
npm run build

# Run the bot
npm start

Configuration

On repository for which the application is installed, a file named pr-naming.json can be defined on the base (release) branches, in a .github directory at root. Default:

{
  "mustMatch": "(.+)"
}

• mustMatch: one or more regular expression
• mustNotMatch: one or more regular expression

GitHub Actions

To use this bot with GitHub Actions, the following workflow can be defined as .github/workflows/pr-naming.yml in your repository.

name: PR naming
on: [pull_request]

jobs:
  check_pr_naming:
    runs-on: ubuntu-latest
    steps:
      - uses: faberNovel/[email protected]
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Alternatives

• probot-app-pr-title
• li-boxuan/Regex-Checker

Contributing

If you have suggestions for how pr-naming 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 Fabernovel (https://github.com/faberNovel/probot-pr-naming)