Skip to content

Commit

Permalink
Clarify needed permissions for post-artifact action (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
dylanhmorris authored Nov 16, 2024
1 parent 99477c1 commit b297c2e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions post-artifact/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
| `message` | Message template to be posted in the PR, as Github-flavored Markdown (GFM). Use the placeholder `{ artifact-url }` to reference the URL of the uploaded artifact, either raw or as GFM formatted link. Use the `{ artifact-name }` placeholder to include the artifact name in the message | false | `'Thank you for your contribution ${{ github.actor }} :rocket:! Your { artifact-name } is ready for download :point_right: [here]({ artifact-url }) :point_left:!'` |
| `python` | The path to the Python executable. | false | `'python'` |

This action only runs in PRs and requires the `pull-requests: write` permission.
This action only runs in PRs and requires the `pull-requests: write` and `actions: read` permissions.

## Example: Post artifact created within a job

Expand Down Expand Up @@ -79,7 +79,7 @@ jobs:

# Required permissions
permissions:
contents: read
actions: read
pull-requests: write

steps:
Expand Down

0 comments on commit b297c2e

Please sign in to comment.