Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/actions-ecosystem/action-add-labels
🏷️ GitHub Action to add labels
https://github.com/actions-ecosystem/action-add-labels
actions github labels
Last synced: about 1 month ago
JSON representation
🏷️ GitHub Action to add labels
- Host: GitHub
- URL: https://github.com/actions-ecosystem/action-add-labels
- Owner: actions-ecosystem
- License: apache-2.0
- Created: 2020-05-02T22:26:54.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-16T07:30:55.000Z (6 months ago)
- Last Synced: 2024-10-09T19:37:27.388Z (about 1 month ago)
- Topics: actions, github, labels
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/actions-ecosystem-add-labels
- Size: 720 KB
- Stars: 119
- Watchers: 4
- Forks: 41
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Action Add Labels
[![actions-workflow-test][actions-workflow-test-badge]][actions-workflow-test]
[![release][release-badge]][release]
[![license][license-badge]][license]
This is a GitHub Action to add GitHub labels to an issue or a pull request.
This action extract the number from an issue or a pull request which has triggered this by default.
It means you don't need to care about something annoying like whether you should use `${{ github.event.issue.number }}` or `${{ github.event.pull_request.number }}`.
It would be more useful to use this with other GitHub Actions' outputs.
## Inputs
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
| -------------- | ----------------------------------------------------------------------------------------------- | -------- | -------- | ------------------------------------------------------------------------------- |
| `github_token` | A GitHub token. | `string` | `false` | `${{ github.token }}` |
| `labels` | The labels' name to be added. Must be separated with line breaks if there're multiple labels. | `string` | `true` | `N/A` |
| `number` | The number of the issue or pull request. | `number` | `false` | `N/A` |
| `repo` | The owner and repository name. e.g.) `Codertocat/Hello-World` | `string` | `false` | `${{ github.event.issue.number }}` or `${{ github.event.pull_request.number }}` |
## Example
### Add a single label with a comment
```yaml
name: Add Label
on:
issues:
types: opened
jobs:
add_label:
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v2
- name: add label
uses: actions-ecosystem/action-add-labels@v1
if: ${{ startsWith(github.event.comment.body, '/add-labels') }}
with:
labels: bug
```
### Add multiple labels with a comment
```yaml
name: Add Labels
on:
pull_request:
types: opened
jobs:
add_labels:
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v2
- name: add labels
uses: actions-ecosystem/action-add-labels@v1
if: ${{ startsWith(github.event.comment.body, '/add-labels') }}
with:
labels: |
documentation
changelog
```
## License
Copyright 2020 The Actions Ecosystem Authors.
Action Add Labels is released under the [Apache License 2.0](./LICENSE).
[actions-workflow-test]: https://github.com/actions-ecosystem/action-add-labels/actions?query=workflow%3ATest
[actions-workflow-test-badge]: https://img.shields.io/github/workflow/status/actions-ecosystem/action-add-labels/Test?label=Test&style=for-the-badge&logo=github
[release]: https://github.com/actions-ecosystem/action-add-labels/releases
[release-badge]: https://img.shields.io/github/v/release/actions-ecosystem/action-add-labels?style=for-the-badge&logo=github
[license]: LICENSE
[license-badge]: https://img.shields.io/github/license/actions-ecosystem/action-add-labels?style=for-the-badge