A GitHub Action for labelling Pull Requests
Add the following GitHub workflow to your repository.
name: PR Auto Label Action
on:
pull_request:
types:
- opened
- edited
- synchronize
- labeled
- unlabeled
jobs:
pr-auto-label-action:
runs-on: ubuntu-latest
permissions:
pull-requests: write
steps:
- uses: tobytheghost/pr-auto-label-action@main
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
IGNORED_FILES: file-to-ignore.js another-file-to-ignore.jsThe following labels will be put on your Pull Requests depending on the size of them:
| Label | # of changed lines |
|---|---|
| size/XS | 1 - 50 |
| size/S | 51 - 100 |
| size/M | 101 - 250 |
| size/L | 251 - 500 |
| size/XL | 501 - 1000 |
| size/XXL | 1001+ |
You can ignore files from being counted towards the size of the Pull Request by adding IGNORED_FILES: file-name-to-ignore.js to the action env.
Files are ignored by their name, not their path. To add multiple files to ignore, separate them with a space.
steps:
- uses: tobytheghost/pr-auto-label-action@main
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
IGNORED_FILES: file-name-to-ignore.js