actions/labeler
1
0
Fork 0
mirror of https://github.com/actions/labeler.git synced 2025-12-24 03:23:59 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' into patch-1

Browse Source
This commit is contained in:
Youssef Victor
2023-05-31 18:46:05 +03:00
committed by GitHub
parent b78dba3eb5 0776a67936
commit d07f38b87f
44 changed files with 6181 additions and 3786 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -1,13 +1,6 @@
# Pull Request Labeler
<p align="left">
<a href="https://github.com/actions/labeler/actions?query=workflow%3A%22Build+%26+Test%22++">
<img alt="build and test status" src="https://github.com/actions/labeler/actions/workflows/build_test.yml/badge.svg">
</a>
<a href="https://david-dm.org/actions/labeler">
<img alt="dependencies" src="https://status.david-dm.org/gh/actions/labeler.svg">
</a>
</p>
[![Basic validation](https://github.com/actions/labeler/actions/workflows/basic-validation.yml/badge.svg?branch=main)](https://github.com/actions/labeler/actions/workflows/basic-validation.yml)
Automatically label new pull requests based on the paths of files being changed.
@@ -56,6 +49,11 @@ label1:
# Add 'label2' to any file changes within 'example2' folder
label2: example2/*
# Add label3 to any change to .txt files within the entire repository. Quotation marks are required for the leading asterisk
label3:
- '**/*.txt'
```
#### Common Examples
@@ -100,21 +98,17 @@ 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`
| `sync-labels` | Whether or not to remove labels when matching files are reverted or no longer changed by the PR | `false`|
# Contributions