actions/pr-size-labeler
1
0
Fork 0
mirror of https://github.com/CodelyTV/pr-size-labeler.git synced 2025-02-18 19:12:50 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
🏷 Visualize and optionally limit the size of your Pull Requests
25 commits 2 branches 19 tags 287 KiB
Shell 96.3%
Dockerfile 3.7%
Find a file
Javier Ferrer 4b80a92212 More explicit and self-explanatory message_if_xl default parameter value 
- New value based on what an AWS team suggest: https://github.com/awslabs/fhir-works-on-aws-authz-rbac/pull/24
2021-03-04 12:08:58 +01:00
.github/workflows More explicit and self-explanatory message_if_xl default parameter value 2021-03-04 12:08:58 +01:00
src Add GHES support (#22) 2021-03-03 12:54:34 +01:00
action.yml More explicit and self-explanatory message_if_xl default parameter value 2021-03-04 12:08:58 +01:00
Dockerfile Use arithmetic operators built in Bash (#6) 2020-03-08 20:41:17 +01:00
entrypoint.sh Add GHES support (#22) 2021-03-03 12:54:34 +01:00
LICENSE Use MIT license 2020-03-03 10:00:17 +01:00
README.md More explicit and self-explanatory message_if_xl default parameter value 2021-03-04 12:08:58 +01:00

README.md

🏷 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 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'

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