Skip to content

Commit 24928e7

Browse files
committed
docs: update docs for v5
1 parent ff19d56 commit 24928e7

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

CHANGELOG.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,14 @@
1111

1212
# Change Log
1313

14+
## v5.0
15+
16+
- Switch to [@actions/artifact](https://www.npmjs.com/package/@actions/artifact), removing the need for a `token` parameter (Sebastian Weigand) [#24](https://github.com/GeekyEggo/delete-artifact/pull/24)
17+
1418
## v4.1
1519

1620
- Add default token.
17-
- Fix over-arching `catch` output; errors now correctly result in a failed run ([@TheMrMilchmann ](https://github.com/TheMrMilchmann)).
21+
- Fix over-arching `catch` output; errors now correctly result in a failed run (Leon Linhart) [#18](https://github.com/GeekyEggo/delete-artifact/pull/18)
1822

1923
## v4.0
2024

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ A GitHub Action for deleting artifacts within the workflow run. This can be usef
1010
| `actions/upload-artifact` | `geekyeggo/delete-artifact` |
1111
| ------------------------- | --------------------------- |
1212
| `@v1`, `@v2`, `@v3` | `@v1`, `@v2` |
13-
| `@v4` | `@v4` |
13+
| `@v4` | ~~@v4~~, `@v5` |
14+
15+
> [!NOTE]
16+
> `geekyeggo/delete-artifact@v4` has been deprecated in favour of `geekyeggo/delete-artifact@v5` which removes the requirement of the `token` parameter.
1417
1518
## ⚡ Usage
1619

1720
See [action.yml](action.yml)
1821

19-
> [!IMPORTANT]
20-
> 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`.
21-
2222
### Delete an individual artifact
2323

2424
```yml
@@ -34,7 +34,7 @@ steps:
3434
name: my-artifact
3535
path: test.txt
3636

37-
- uses: geekyeggo/delete-artifact@v4
37+
- uses: geekyeggo/delete-artifact@v5
3838
with:
3939
name: my-artifact
4040
```
@@ -43,7 +43,7 @@ steps:
4343
4444
```yml
4545
steps:
46-
- uses: geekyeggo/delete-artifact@v4
46+
- uses: geekyeggo/delete-artifact@v5
4747
with:
4848
name: |
4949
artifact-*
@@ -57,7 +57,7 @@ By default, the action will fail when it was not possible to delete an artifact
5757
5858
```yml
5959
steps:
60-
- uses: geekyeggo/delete-artifact@v4
60+
- uses: geekyeggo/delete-artifact@v5
6161
with:
6262
name: okay-to-keep
6363
failOnError: false

0 commit comments

Comments
 (0)