diff --git a/README.md b/README.md index 593128917..fe9cebea7 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ Pull request labeler triages PRs based on the paths that are modified in the PR. +Note that only pull requests being opened from the same repository can be labeled. This action will not currently work for pull requests from forks -- like is common in open source projects -- because the token for forked pull request workflows does not have write permissions. + ## Usage ### Create `.github/labeler.yml` diff --git a/action.yml b/action.yml index ad68c2876..738dcf141 100644 --- a/action.yml +++ b/action.yml @@ -1,5 +1,5 @@ name: 'Pull Request Labeler' -description: 'Label pull requests by files altered' +description: 'Add labels to new pull requests based on the files that are changed' author: 'GitHub' inputs: repo-token: