https://github.com/offensive-vk/auto-label
Github Action to Automatically Apply Labels on Both PRs and Issues.
https://github.com/offensive-vk/auto-label
actions automated github-action label
Last synced: about 1 month ago
JSON representation
Github Action to Automatically Apply Labels on Both PRs and Issues.
- Host: GitHub
- URL: https://github.com/offensive-vk/auto-label
- Owner: offensive-vk
- License: mit
- Created: 2024-09-11T02:37:38.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-06-28T16:23:21.000Z (12 months ago)
- Last Synced: 2025-07-04T20:50:12.440Z (12 months ago)
- Topics: actions, automated, github-action, label
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/auto-label-stuff
- Size: 3.48 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Auto-Label
The **auto-label** GitHub Action simplifies the process of adding labels to issues and pull requests in your repository. Powered by the GitHub Octokit API, this Action can match specific keywords or file patterns to apply labels automatically.
For a complete example, have a look at our [workflow](.github/workflows/test.yml). 🙌
## Features
- **Automatic Labeling**: Apply labels to issues and pull requests based on custom rules.
- **Keyword Matching**: Match specific keywords in issues to apply relevant labels.
- **File Pattern Matching**: Automatically label pull requests based on modified file patterns.
- **Optional Label Creation**: Create missing labels automatically with suitable descriptions.
- **Both PR and Issues**: Works on both issues and pull request using separate files.
---
## Usage Examples
### Apply Labels on Issues
```yaml
steps:
- name: Apply Labels on Issues
if: github.event_name == 'issues'
uses: offensive-vk/auto-label@v8
with:
create-labels: true # Optional, defaults to true
auth-token: ${{ github.token }} # Optional, defaults to ${{ secrets.GITHUB_TOKEN }}
issue-config: .github/issues.yml # Required, path to the issue configuration file.
```
### Apply Labels on Pull Requests
```yaml
steps:
- name: Apply Labels on Pull Requests
if: github.event_name == 'pull_request'
uses: offensive-vk/auto-label@v8
with:
create-labels: true # Optional, defaults to true
auth-token: ${{ github.token }} # Optional, defaults to ${{ secrets.GITHUB_TOKEN }}
pr-config: .github/pr.yml # Required, path to the pull request configuration file.
```
---
## Input Configuration
Configure inputs through the `with:` section of the Action. Below is the list of available options:
| Input | Default Value | Description |
|----------------|-------------------------------|-------------|
| `auth-token` | `${{ github.token }}` | The GitHub token for authenticating requests. You can use `${{ secrets.GITHUB_TOKEN }}` or a personal access token (PAT) stored in your secrets. |
| `issue-config` | `.github/issues.yml` | Path to the YAML configuration file for labeling issues. |
| `pr-config` | `.github/pr.yml` | Path to the YAML configuration file for labeling pull requests. |
| `create-labels`| `true` | Whether to create missing labels in the repository. |
| `debug` | `false` | Whether to enable debug mode or not. |
| `number` | `0` | Valid only at workflow_dispatch event. |
---
## Configuration Files
### Issue Configuration
Define rules to apply labels on issues based on keywords. Below is an example:
```yaml
# .github/issues.yml
bug:
match:
- "error"
- "fail"
- "bug"
- "crash"
description: "Indicates a bug or error in the system."
feat:
match:
- "feature"
- "enhancement"
- "improvement"
description: "Suggests a new feature or improvement."
documentation:
match:
- "doc"
- "documentation"
- "readme"
description: "Related to documentation updates or changes."
```
### Pull Request Configuration
Define rules to apply labels on pull requests based on file patterns. Below is an example:
```yaml
# .github/pr.yml
area/release:
match:
- 'release/**/*'
- 'release_assets/**/*'
- '**/*.assets'
description: "Related to releases."
area/build:
match:
- 'build/**/*'
- 'resources/**'
description: "Related to build"
area/ci-cd:
match:
- '**/*.yml'
- '**/*.yaml'
description: "Related to ci/cd"
```
## How It Works
1. The Action triggers based on GitHub events (`issues` or `pull_request`).
2. Matches keywords (for issues) or file patterns (for pull requests) against the configuration file.
3. Applies labels to issues or pull requests that match the criteria.
4. Optionally creates missing labels in the repository.
5. Works both on issue and pull requests.
## License
This repository is licensed under the [MIT License](https://github.com/offensive-vk/auto-issue?tab=MIT-1-ov-file).
---
© Vedansh 2020 - Present
Licensed under MIT
Thanks for visiting :)