actions/labeler
1
0
Fork 0
mirror of https://github.com/actions/labeler.git synced 2025-12-11 12:07:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Markdown: backticks

Browse Source
This commit is contained in:
Josh Soref
2023-06-13 13:21:58 -04:00
committed by GitHub
parent 1a5defcb60
commit 3240e3059a
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -10,7 +10,7 @@ Automatically label new pull requests based on the paths of files being changed.
Create a `.github/labeler.yml` file with a list of labels and [minimatch](https://github.com/isaacs/minimatch) globs to match to apply the label. Create a `.github/labeler.yml` file with a list of labels and [minimatch](https://github.com/isaacs/minimatch) globs to match to apply the label.
The key is the name of the label in your repository that you want to add (e.g. "merge conflict", "needs-updating") and the value is the path (glob) of the changed files (e.g. `src/**`, `tests/*.spec.js`) or a match object. The key is the name of the label in your repository that you want to add (e.g. `merge conflict`, `needs-updating`) and the value is the path (glob) of the changed files (e.g. `src/**`, `tests/*.spec.js`) or a match object.
#### Match Object #### Match Object
@@ -111,7 +111,7 @@ Various inputs are defined in [`action.yml`](action.yml) to let you configure th
| Name | Description | Default | | 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 | `github.token` | | `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` | | `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` | | `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` | | `dot` | Whether or not to auto-include paths starting with dot (e.g. `.github`) | `false` |
@@ -136,12 +136,12 @@ label1:
In order to add labels to pull requests, the GitHub labeler action requires In order to add labels to pull requests, the GitHub labeler action requires
write permissions on the pull-request. However, when the action runs on a pull write permissions on the pull-request. However, when the action runs on a pull
request from a forked repository, GitHub only grants read access tokens for request from a forked repository, GitHub only grants read access tokens for
pull_request events, at most. If you encounter an Error: HttpError: Resource `pull_request` events, at most. If you encounter an `Error: HttpError: Resource
not accessible by integration, it's likely due to these permission constraints. not accessible by integration`, it's likely due to these permission constraints.
To resolve this issue, you can modify the `on:` section of your workflow to use To resolve this issue, you can modify the `on:` section of your workflow to use
[pull_request_target](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target) [`pull_request_target`](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target)
instead of `pull_request` (see example [above](#create-workflow)). This change instead of `pull_request` (see example [above](#create-workflow)). This change
allows the action to have write access, because pull_request_target alters the allows the action to have write access, because `pull_request_target` alters the
[context of the [context of the
action](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target) action](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target)
and safely grants additional permissions. Refer to the [GitHub token and safely grants additional permissions. Refer to the [GitHub token