Skip to content

Commit

Permalink
docs: add note about permissive GITHUB_TOKEN
Browse files Browse the repository at this point in the history
  • Loading branch information
GeekyEggo authored Dec 24, 2023
1 parent ba6a508 commit 94e3ae5
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ A GitHub Action for deleting artifacts within the workflow run. This can be usef
See [action.yml](action.yml)

> [!IMPORTANT]
> Support for `actions/upload-artifact@v4` utilizes GitHub's REST API, and requires a token with read and write access to actions.
> Support for `actions/upload-artifact@v4` utilizes the GitHub REST API, and requires a permissive [`GITHUB_TOKEN`](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token), or a PAT with read and write access to actions.
### Delete an individual artifact

Expand All @@ -36,7 +36,7 @@ steps:

- uses: geekyeggo/delete-artifact@v4
with:
token: ${{ secrets.TOKEN }}
token: ${{ secrets.GITHUB_TOKEN }}
name: my-artifact
```
Expand All @@ -46,7 +46,7 @@ steps:
steps:
- uses: geekyeggo/delete-artifact@v4
with:
token: ${{ secrets.TOKEN }}
token: ${{ secrets.GITHUB_TOKEN }}
name: |
artifact-*
binary-file
Expand All @@ -61,7 +61,7 @@ By default, the action will fail when it was not possible to delete an artifact
steps:
- uses: geekyeggo/delete-artifact@v4
with:
token: ${{ secrets.TOKEN }}
token: ${{ secrets.GITHUB_TOKEN }}
name: okay-to-keep
failOnError: false
```
Expand Down

0 comments on commit 94e3ae5

Please sign in to comment.