Awesome
About
GitHub Action to manage labels on GitHub (create/rename/update/delete) as code.
Usage
YAML configuration
In the repository where you want to perform this action, create the YAML file
.github/labels.yml
(you can also set a custom filename) that
looks like:
- name: "bug"
color: "d73a4a"
description: "Something isn't working"
- name: "documentation"
color: "0075ca"
description: "Improvements or additions to documentation"
- name: "duplicate"
color: "cfd8d7"
description: "This issue or pull request already exists"
- name: "enhancement"
color: "a22eef"
- name: "wontfix_it"
color: "000000"
description: "This will not be worked on"
from_name: "wontfix"
name
,color
anddescription
are the main GitHub label fieldsdescription
can be omit if your want to keep the current onefrom_name
allow to rename a label from one currently available on your repository
Note: You can use hex codes for the color
field, as that helps previewing the colors in some code editors. The leading "#" will be automatically removed.
Workflow
name: github
on:
push:
branches:
- 'main'
paths:
- '.github/labels.yml'
- '.github/workflows/labels.yml'
pull_request:
paths:
- '.github/labels.yml'
- '.github/workflows/labels.yml'
jobs:
labeler:
runs-on: ubuntu-latest
steps:
-
name: Checkout
uses: actions/checkout@v3
-
name: Run Labeler
uses: crazy-max/ghaction-github-labeler@v5
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
yaml-file: .github/labels.yml
dry-run: ${{ github.event_name == 'pull_request' }}
exclude: |
help*
*issue
With this workflow, the YAML configuration above on a fresh repository, this will:
- Skip
bug
(because samecolor
anddescription
) - Skip
documentation
(because samecolor
anddescription
) - Update
duplicate
(color
is different) - Update
enhancement
(color
is different, keep currentdescription
) - Leave
good first issue
alone (because it matches anexclude
pattern) - Leave
help wanted
alone (because it matches anexclude
pattern) - Delete
invalid
- Delete
question
- Rename
wontfix
towontfix_it
and setcolor
anddescription
Customizing
inputs
Following inputs can be used as step.with
keys
Name | Type | Description |
---|---|---|
yaml-file | String | Path to YAML file containing labels definitions. (default .github/labels.yml ) |
skip-delete | Bool | If enabled, labels will not be deleted if not found in YAML file. (default false ) |
dry-run | Bool | If enabled, changes will not be applied. (default false ) |
exclude | List | Newline delimited list of labels pattern(s)/matcher to exclude |
Contributing
Want to contribute? Awesome! The most basic way to show your support is to star the project, or to raise issues. You can also support this project by becoming a sponsor on GitHub or by making a PayPal donation to ensure this journey continues indefinitely!
Thanks again for your support, it is much appreciated! :pray:
License
MIT. See LICENSE
for more details.