docs: update docs for v5

GeekyEggo · Mar 18, 2024 · 24928e7 · 24928e7
1 parent ff19d56
commit 24928e7
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,10 +11,14 @@
 
 # Change Log
 
+## v5.0
+
+-   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)
+
 ## v4.1
 
 -   Add default token.
--   Fix over-arching `catch` output; errors now correctly result in a failed run ([@TheMrMilchmann ](https://github.com/TheMrMilchmann)).
+-   Fix over-arching `catch` output; errors now correctly result in a failed run (Leon Linhart) [#18](https://github.com/GeekyEggo/delete-artifact/pull/18)
 
 ## v4.0
 

diff --git a/README.md b/README.md
@@ -10,15 +10,15 @@ A GitHub Action for deleting artifacts within the workflow run. This can be usef
 | `actions/upload-artifact` | `geekyeggo/delete-artifact` |
 | ------------------------- | --------------------------- |
 | `@v1`, `@v2`, `@v3`       | `@v1`, `@v2`                |
-| `@v4`                     | `@v4`                       |
+| `@v4`                     | ~~@v4~~, `@v5`              |
+
+> [!NOTE]
+> `geekyeggo/delete-artifact@v4` has been deprecated in favour of `geekyeggo/delete-artifact@v5` which removes the requirement of the `token` parameter.
 
 ## ⚡ Usage
 
 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`.
-
 ### Delete an individual artifact
 
 ```yml
@@ -34,7 +34,7 @@ steps:
           name: my-artifact
           path: test.txt
 
-    - uses: geekyeggo/delete-artifact@v4
+    - uses: geekyeggo/delete-artifact@v5
       with:
           name: my-artifact
 ```
@@ -43,7 +43,7 @@ steps:
 
 ```yml
 steps:
-    - uses: geekyeggo/delete-artifact@v4
+    - uses: geekyeggo/delete-artifact@v5
       with:
           name: |
               artifact-*
@@ -57,7 +57,7 @@ By default, the action will fail when it was not possible to delete an artifact
 
 ```yml
 steps:
-    - uses: geekyeggo/delete-artifact@v4
+    - uses: geekyeggo/delete-artifact@v5
       with:
           name: okay-to-keep
           failOnError: false