Skip to content

Commit

Permalink
Add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
andreaswilli committed Oct 9, 2021
1 parent b718c9b commit 0a9ceab
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,31 @@
# delete-release-assets-action
A simple GitHub action which deletes all assets attached to a release. It is mainly designed to make sure electron-builder doesn't fail in case an asset already exists..

A simple GitHub action which deletes all assets attached to a release. It is mainly designed to make sure electron-builder doesn't fail in case an asset already exists.

## Inputs

| name | required? | description |
| -------------- | --------- | ------------------------------------------------------------------------------------------- |
| `github_token` | yes | GitHub Access Token (usually `secrets.GITHUB_TOKEN`) |
| `tag` | no | Tag name that identifies the release (version is read from `package.json` if not specified) |

## Example usage

```yml
name: Delete Release Assets

on: push

jobs:
deleteReleaseAssets:
runs-on: ubuntu-latest

steps:
- name: Check out Git repository
uses: actions/checkout@v1

- name: Delete current release assets
uses: andreaswilli/delete-release-assets-action@<version>
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
```

0 comments on commit 0a9ceab

Please sign in to comment.