https://github.com/bedrockstreaming/pr-size-labeler

Github action to automatically add label on PR to define size (based on line diff and file modified)
https://github.com/bedrockstreaming/pr-size-labeler

actions

Last synced: 3 months ago
JSON representation

Github action to automatically add label on PR to define size (based on line diff and file modified)

• Host: GitHub
• URL: https://github.com/bedrockstreaming/pr-size-labeler
• Owner: BedrockStreaming
• License: mit
• Created: 2022-04-27T06:05:37.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-19T23:02:30.000Z (11 months ago)
• Last Synced: 2024-10-13T14:47:47.461Z (4 months ago)
• Topics: actions
• Language: TypeScript
• Homepage:
• Size: 2.4 MB
• Stars: 9
• Watchers: 16
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
Welcome to BedrockStreaming/pr-size-labeler 👋



  

    

  

  

  

  



> Github action to automatically add label on PR to define size (based on line diff and file modified)

## Author

- Website: https://tech.bedrockstreaming.com

## How to use ?

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

```yaml

name: 🏷 PR size labeler

on: [pull_request]

jobs:

  pr-labeler:

    runs-on: ubuntu-latest

    name: Label the PR size

    steps:

      - uses: BedrockStreaming/pr-size-labeler@v1

        with:

          token: ${{ secrets.GITHUB_TOKEN }}

          exclude_files: .lock

```

## Inputs

```yaml

xs_label:

  required: false

  default: 'Size/XS'

xs_diff:

  required: false

  default: '50'

xs_files:

  required: false

  default: '5'

s_label:

  required: false

  default: 'Size/S'

s_diff:

  required: false

  default: '100'

s_files:

  required: false

  default: '10'

m_label:

  required: false

  default: 'Size/M'

m_diff:

  required: false

  default: '500'

m_files:

  required: false

  default: '30'

l_label:

  required: false

  default: 'Size/L'

l_diff:

  required: false

  default: '800'

l_files:

  required: false

  default: '50'

xl_label:

  required: false

  default: 'Size/XL'

xl_diff:

  required: false

  default: '1500'

xl_files:

  required: false

  default: '100'

token:

  required: true

exclude_files:

  description: 'Regexp to ignore files from the line diff count (example: yarn.lock)'

  required: true

```

## [✍️ Contributing](./CONTRIBUTING.md)

## 📝 License

This project is [MIT](https://github.com/BedrockStreaming/pr-size-labeler/blob/master/LICENSE) licensed.

---

_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_