docs: update docs for v4.1

GeekyEggo · Jan 13, 2024 · 6504143 · 6504143
1 parent 83886d4
commit 6504143
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -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`.
@@ -25,4 +30,3 @@
 ## v1.0
 
 -   Initial release.
-
diff --git a/README.md b/README.md
@@ -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
 
@@ -36,7 +36,6 @@ steps:
 
     - uses: geekyeggo/delete-artifact@v4
       with:
-          token: ${{ secrets.GITHUB_TOKEN }}
           name: my-artifact
 ```
 
@@ -46,7 +45,6 @@ steps:
 steps:
     - uses: geekyeggo/delete-artifact@v4
       with:
-          token: ${{ secrets.GITHUB_TOKEN }}
           name: |
               artifact-*
               binary-file
@@ -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
 ```
-
diff --git a/package.json b/package.json
@@ -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",
@@ -31,4 +31,3 @@
         "typescript": "^5.3.3"
     }
 }
-