From 07044e08a9310b76e2bf356aff3346ea9c2d7d78 Mon Sep 17 00:00:00 2001 From: Peter Evans Date: Tue, 4 Aug 2020 15:52:06 +0900 Subject: [PATCH] Update readme --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1f72a21..da0c58a 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ This action was created to help facilitate a GitHub Actions "ChatOps" solution i | Name | Description | Default | | --- | --- | --- | -| `token` | `GITHUB_TOKEN` or a `repo` scoped [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). | `GITHUB_TOKEN` | +| `token` | `GITHUB_TOKEN` or a `repo` scoped [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). | `GITHUB_TOKEN` | | `repository` | The full name of the repository in which to create or update a comment. | Current repository | | `issue-number` | The number of the issue or pull request in which to create a comment. | | | `comment-id` | The id of the comment to update. | | @@ -58,8 +58,8 @@ This action was created to help facilitate a GitHub Actions "ChatOps" solution i | `edit-mode` | The mode when updating a comment, `replace` or `append`. | `append` | | `reactions` | A comma separated list of reactions to add to the comment. (`+1`, `-1`, `laugh`, `confused`, `heart`, `hooray`, `rocket`, `eyes`) | | -Note: This action does not work in `pull_request` workflows when triggered by a fork opening a pull request in the upstream repository. -This is due to restrictions put in place by GitHub Actions. See [here](https://github.com/peter-evans/create-pull-request/blob/master/docs/concepts-guidelines.md#restrictions-on-forked-repositories) for further explanation. +Note: In *public* repositories this action does not work in `pull_request` workflows when triggered by forks. +This is due to token restrictions put in place by GitHub Actions. Private repositories can be configured to [enable workflows](https://docs.github.com/en/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks) from forks to run without restriction. See [here](https://github.com/peter-evans/create-pull-request/blob/master/docs/concepts-guidelines.md#restrictions-on-repository-forks) for further explanation. Alternatively, use the [`pull_request_target`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target) event to comment on pull requests. #### Outputs @@ -136,7 +136,7 @@ The content must be [escaped to preserve newlines](https://github.community/t/se ### Accessing issues and comments in other repositories -You can create and update comments in another repository by using a [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) instead of `GITHUB_TOKEN`. +You can create and update comments in another repository by using a [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) instead of `GITHUB_TOKEN`. The user associated with the PAT must have write access to the repository. ## License