Skip to content

Commit

Permalink
docs: update docs for v4.1
Browse files Browse the repository at this point in the history
  • Loading branch information
GeekyEggo committed Jan 13, 2024
1 parent 83886d4 commit 6504143
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 8 deletions.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@

# Change Log

## v4.1

- Add default token.
- Fix over-arching `catch` output; errors now correctly result in a failed run ([@TheMrMilchmann ](https://github.com/TheMrMilchmann)).

## v4.0

- Add support for artifacts uploaded with `actions/upload-artifact@v4`.
Expand All @@ -25,4 +30,3 @@
## v1.0

- Initial release.

6 changes: 1 addition & 5 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 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.
> 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,6 @@ steps:

- uses: geekyeggo/delete-artifact@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
name: my-artifact
```

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

3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "delete-artifact",
"description": "Deletes artifacts from a workflow run",
"version": "3.0.0",
"version": "4.1.0",
"main": "src/index.ts",
"scripts": {
"build": "ncc build",
Expand Down Expand Up @@ -31,4 +31,3 @@
"typescript": "^5.3.3"
}
}

0 comments on commit 6504143

Please sign in to comment.