Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/offensive-vk/auto-label

Automated Label PRs and Issues Action.
https://github.com/offensive-vk/auto-label

actions automated label

Last synced: about 1 month ago
JSON representation

Automated Label PRs and Issues Action.

Host: GitHub
URL: https://github.com/offensive-vk/auto-label
Owner: offensive-vk
License: mit
Created: 2024-09-11T02:37:38.000Z (4 months ago)
Default Branch: master
Last Pushed: 2024-11-16T06:31:37.000Z (about 2 months ago)
Last Synced: 2024-11-16T07:26:18.268Z (about 2 months ago)
Topics: actions, automated, label
Language: TypeScript
Homepage: https://github.com/marketplace/actions/auto-label-stuff
Size: 1.32 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

This GitHub Action allows you to add or apply labels on issues and pull requests in a github repository. Please click [here](.github/workflows/test.yml) to see a complete working workflow that uses this action.

## Example Usage

```yml
steps:
- name: Apply Labels on PRs and Issues
if: github.event_name == 'issues'
uses: offensive-vk/auto-label@v7
with:
create-labels: true # Not Required, defaults to true
github-token: ${{ secrets.GITHUB_TOKEN }} # Not Required uses ${{ secrets.GITHUB_TOKEN }}
issue-config: .github/issues.yml # Required config file.
```

## Inputs Configuration

Configure the inputs through the `with:` section of the Action. Below is a list of configurable options:

| Option | Default Value | Description |
|-----------|-------------------------------|-------------|
| github-token | `${{ github.token }}` / `required` | The GitHub token used to authenticate requests. Use `${{ github.token }}` or create a PAT and store it in secrets. |
| issue-config | `.github/issues.yml` / `required` | The Issues Config File that will label issues. |
| pr-config | `.github/pr.yml` / `required` | The Pull Request Labeler Config. (Similiar to `labeler.yml`) |
| create-labels | `true` | Whether to create labels in base repo or not. |

## Issue Config

This is a sample description of how can you write your rules to apply labels on Issues by matching specific keywords.

```yaml
actual_label:
- label: actual_label
description: 'Short description'
match:
- 'Match1'
- 'Match2'
- '...so on.'
```

For Example:

```yaml
hamster:
- label: hamster
description: sorry its my hamster
match:
- automated
- hamster
- hamsters
- Hamster

bug:
- label: bug
description: its a issue
match:
- issue
- issues
- bug
- bugs
- fix
```

## PR Config

This is a sample description of how can you write your rules to apply labels on Pull Requests by matching specific keywords.

```yaml
actual_label:
- 'file_pattern1'
- 'file_pattern2'
- '...'
```

Example:

```yml
area/release:
- 'release/'
- 'release_assets/'
- '**/*.assets'

area/build:
- 'build/**/*'
- 'resources'
- 'xyz'

```

Thank you for using this action.

***