mirror of
https://github.com/actions/labeler.git
synced 2025-12-10 11:41:56 +00:00
Merge branch 'main' into dot-option
This commit is contained in:
19
README.md
19
README.md
@@ -1,13 +1,6 @@
|
||||
# Pull Request Labeler
|
||||
|
||||
<p align="left">
|
||||
<a href="https://github.com/actions/labeler/actions/workflows/basic-validation.yml">
|
||||
<img alt="basic validation status" src="https://github.com/actions/labeler/actions/workflows/basic-validation.yml/badge.svg">
|
||||
</a>
|
||||
<a href="https://libraries.io/github/actions/labeler">
|
||||
<img alt="dependencies" src="https://img.shields.io/librariesio/github/actions/labeler">
|
||||
</a>
|
||||
</p>
|
||||
[](https://github.com/actions/labeler/actions/workflows/basic-validation.yml)
|
||||
|
||||
Automatically label new pull requests based on the paths of files being changed.
|
||||
|
||||
@@ -110,22 +103,18 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/labeler@v4
|
||||
with:
|
||||
repo-token: "${{ secrets.GITHUB_TOKEN }}"
|
||||
```
|
||||
|
||||
_Note: This grants access to the `GITHUB_TOKEN` so the action can make calls to GitHub's rest API_
|
||||
|
||||
#### Inputs
|
||||
|
||||
Various inputs are defined in [`action.yml`](action.yml) to let you configure the labeler:
|
||||
|
||||
| Name | Description | Default |
|
||||
| - | - | - |
|
||||
| `repo-token` | Token to use to authorize label changes. Typically the GITHUB_TOKEN secret, with `contents:read` and `pull-requests:write` access | N/A |
|
||||
| `repo-token` | Token to use to authorize label changes. Typically the GITHUB_TOKEN secret, with `contents:read` and `pull-requests:write` access | `github.token` |
|
||||
| `configuration-path` | The path to the label configuration file | `.github/labeler.yml` |
|
||||
| `sync-labels` | Whether or not to remove labels when matching files are reverted or no longer changed by the PR | `false`
|
||||
| `dot` | Whether or not to auto-include paths starting with dot (e.g. `.github`) | `false`
|
||||
| `sync-labels` | Whether or not to remove labels when matching files are reverted or no longer changed by the PR | `false` |
|
||||
| `dot` | Whether or not to auto-include paths starting with dot (e.g. `.github`) | `false` |
|
||||
|
||||
When `dot` is disabled and you want to include _all_ files in a folder:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user