Skip to content

sta-szek/pr-size-labeler

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🏷 Pull Request size labeler

codely.tv CodelyTV Courses GitHub Action version

Visualize and optionally limit the size of your Pull Requests

🚀 Usage

Create a file named labeler.yml inside the .github/workflows directory and paste:

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_max_size: '10'
          s_max_size: '100'
          m_max_size: '500'
          l_max_size: '1000'
          fail_if_xl: 'false'
          message_if_xl: 'This PR is so big! Please, split it 😊'

If you want, you can customize all *_max_size with the size that fits in your project.

Setting fail_if_xl to 'true' will make fail all pull requests bigger than l_max_size.

Github Enterprise Server

You can override the public Github API by setting github_api_url.

- uses: codelytv/pr-size-labeler@v1
  with:
    ...
    github_api_url: 'github.mycompany.net/api/v3'

⚖️ License

MIT

About

🏷 Visualize and optionally limit the size of your Pull Requests

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Shell 97.3%
  • Dockerfile 2.7%