Skip to content

GitHub Action that label PR's based on their size

License

Notifications You must be signed in to change notification settings

FTAPI-Software/actions-pr-labeler

Repository files navigation

Table of Contents

Usage

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

name: actions-pr-labeler

on: [pull_request]

jobs:
  actions-pr-labeler:
    runs-on: ubuntu-latest
    name: Label the PR size
    steps:
      - uses: FTAPI-Software/[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