Skip to content

releases-delete-asset.md

Latest commit

 

History

History
48 lines (37 loc) · 1.59 KB

releases-delete-asset.md

File metadata and controls

48 lines (37 loc) · 1.59 KB

Delete a release asset

A composite action that deletes a previously created release asset. Requires the contents: write permission to work.

Inputs

Name Description Default
asset-id (*) The ID of the asset to delete N/A
github-token The default token to use for this Git operation. If unspecified, this will default to github.token. "${{ github.token }}"
owner The repository owner. If unspecified, this will default to the owner of the current repository. ""
repo The name of the repository. If unspecified, this will default to the current repository. ""
retries The number of times to attempt to retry if this fails. "0"
retry-exempt-status-codes A list of error-codes that are exempt from being retried. "400,401,403,404,422"

Note: (*) marks required inputs

Outputs

releases/delete-asset does not have any outputs at this time

Example

Here is a very basic example of how to use the releases/delete-asset composite action in a project (placeholders are used in place of real inputs):

run:
  example-job:
    # ... 
    steps:
      # ... 
      - name: Delete a release asset
        uses: bitwizeshift/actions-github/releases/delete-asset@v1
        with:
          # Required inputs
          asset-id: ASSET_ID

          # Optional inputs
          github-token: GITHUB_TOKEN
          owner: OWNER
          repo: REPO
          retries: RETRIES
          retry-exempt-status-codes: RETRY_EXEMPT_STATUS_CODES