Visualize and optionally limit the size of your Pull Requests
Create a file named labeler.yml
inside the .github/workflows
directory and paste the following configuration.
βοΈ Here you can see the default values of all available configuration parameters, however, the only required parameter is the GITHUB_TOKEN
one.
name: labeler
on: [pull_request]
jobs:
labeler:
runs-on: ubuntu-latest
name: Label the PR size
steps:
- uses: codelytv/pr-size-labeler@v1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
xs_label: 'size/xs'
xs_max_size: '10'
s_label: 'size/s'
s_max_size: '100'
m_label: 'size/m'
m_max_size: '500'
l_label: 'size/l'
l_max_size: '1000'
xl_label: 'size/xl'
fail_if_xl: 'false'
message_if_xl: >
This PR exceeds the recommended size of 1000 lines.
Please make sure you are NOT addressing multiple issues with one PR.
Note this PR might be rejected due to its size.
github_api_url: 'api.github.com'
files_to_ignore: ''
*_label
(xs_label
,s_label
β¦): Adjust size label names*_max_size
(xs_max_size
,s_max_size
β¦): Adjust which amount of changes you consider appropriate for each size based on your project contextfail_if_xl
: Set to'true'
will report GitHub Workflow failure if the PR size is xl allowing to forbid PR mergemessage_if_xl
: Let the user(s) know that the PR exceeds the recommended size and what the consequences aregithub_api_url
: Override this parameter in order to use with your own GitHub Enterprise Server. Example:'https://github.example.com/api/v3'
files_to_ignore
: Whitespace separated list of files to ignore when calculating the PR size. Example:'package-lock.json Pipfile.lock'
- PR size labeler consider as a change any kind of line addition, deletion, or modification
- A PR will be labeled as
xl
if it exceeds the amount of changes defined asl_max_size