GitHub Action
Actions Ecosystem Size
Determine a label to be added based on the number of lines changed in a pull request.
Counts the number of lines changed in a pull request. And buckets this number into a few size classes (S, L, XL, etc).
It would be better to work with other actions which add and remove labels. See the example below for detail.
This action is inspired by Kubernetes Prow's size plugin.
GitHub API implicitly creates a label when it will add the label to an issue or a pull request but the label doesn't exists. The label has the default color and no description.
If you don't prefer the default label, it's better to create labels indicating a pull request size.
All the inputs are optional.
The inputs size_${size}_label indicates what name each label has.
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
|---|---|---|---|---|
size_xs_label |
The name for size XS label. | string |
false |
size/XS |
size_s_label |
The name for size S label. | string |
false |
size/S |
size_m_label |
The name for size M label. | string |
false |
size/M |
size_l_label |
The name for size L label. | string |
false |
size/L |
size_xl_label |
The name for size XL label. | string |
false |
size/XL |
size_xxl_label |
The name for size XXL label. | string |
false |
size/XXL |
The inputs size_${size}_threshold indicates how many lines changed is corresponding to each label.
Must be a minimal number, rather than a range.
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
|---|---|---|---|---|
size_s_threshold |
The threshold for size S. | number |
false |
10 |
size_m_threshold |
The threshold for size M. | number |
false |
30 |
size_l_threshold |
The threshold for size L. | number |
false |
100 |
size_xl_threshold |
The threshold for size XL. | number |
false |
500 |
size_xxl_threshold |
The threshold for size XXL. | number |
false |
1000 |
| NAME | DESCRIPTION | TYPE |
|---|---|---|
new_label |
The new label's name to be added. If there's no label to be added, it the value is ''. |
string |
stale_labels |
The stale labels' name to be removed. If there're multiple labels, they're separated by line breaks. If there's no labels to be removed, it the value is ''. |
string |
This action works well with actions-ecosystem/action-add-labels and actions-ecosystem/action-remove-labels.
name: Size
on:
pull_request:
types: [opened, synchronize]
jobs:
update_labels:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions-ecosystem/action-size@v2
id: size
- uses: actions-ecosystem/action-remove-labels@v1
with:
github_token: ${{ secrets.github_token }}
labels: ${{ steps.size.outputs.stale_labels }}
- uses: actions-ecosystem/action-add-labels@v1
with:
github_token: ${{ secrets.github_token }}
labels: ${{ steps.size.outputs.new_label }}Copyright 2020 The Actions Ecosystem Authors.
Action Size is released under the Apache License 2.0.