pr-labeler

Add label to the pull request depending on the number of changes and the files excluded from the counting

Table of Contents

• Usage
• Inputs
• Assumptions
• License

Usage

You can create a .github/workflows/pr-labeler.yml file:

name: pr-labeler

on: [pull_request]

jobs:
  pr-labeler:
    runs-on: ubuntu-latest
    name: Label the PR size
    steps:
      - uses: coverwallet/[email protected]
        with:
          xs_max_size: '10'
          s_max_size: '100'
          m_max_size: '500'
          l_max_size: '1000'
          exclude_files: '.txt'
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Inputs

Name	Description	Required
xs_max_size	The maximum number of lines changed for the label named xs	true
s_max_size	The maximum number of lines changed for the label named s	true
m_max_size	The maximum number of lines changed for the label named m	true
l_max_size	The maximum number of lines changed for the label named l	true
exclude_files	The regular expression of the type of file or files that we want to exclude from the counting of changes	true

Assumptions

• 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 as l_max_size

License

MIT