actions/labeler
1
0
Fork 0
mirror of https://github.com/actions/labeler.git synced 2025-12-13 04:57:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updating readme for more guidance (#21)

Browse Source 
* updating readme

* updating file path
This commit is contained in:
Paige Bystrom
2019-09-12 10:42:28 -07:00
committed by Danny McCormick
parent 44767181ec
commit df04112348
1 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -2,8 +2,8 @@
Pull request labeler triages PRs based on the paths that are modified in the PR. Pull request labeler triages PRs based on the paths that are modified in the PR.
To use, create a `.github/labeler.yml` file with a list of labels and [minimatch](https://github.com/isaacs/minimatch) To use, 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. globs to match to apply the label.
Example: Example:
``` ```
@@ -16,10 +16,13 @@ label3:
- example3/* - example3/*
- example3/**/*.yml - example3/**/*.yml
``` ```
Then create a workflow utilizing the labeler action, granting access to the GITHUB_TOKEN so the action can make calls to GitHub's rest API: Where `"label1"` is the name of the label on your repository that you want to add (eg: "merge conflict", "needs-updating") and `"example1/**/*"` is the path of the changed files.
Then create a workflow (eg: `.github/workflows/label.yml` see [Creating a Workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file)) utilizing the labeler action, granting access to the GITHUB_TOKEN so the action can make calls to GitHub's rest API:
``` ```
name: "Pull Request Labeler" name: "Pull Request Labeler"
on: on:
- pull_request - pull_request
jobs: jobs: