releases-delete.md

Delete a release

Deletes a previously created release Requires the content: write permission to work.

Inputs

Name	Description	Default
release-id (*)	The ID of the release	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

Name	Description
release-id	The browser URL of the uploaded asset

Example

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

run:
  example-job:
    # ... 
    steps:
      # ... 
      - name: Delete a release
        id: releases-delete # only necessary if using this action's output
        uses: bitwizeshift/actions-github/releases/delete@v1
        with:
          # Required inputs
          release-id: RELEASE_ID

          # Optional inputs
          github-token: GITHUB_TOKEN
          owner: OWNER
          repo: REPO
          retries: RETRIES
          retry-exempt-status-codes: RETRY_EXEMPT_STATUS_CODES
      # ... 
      - name: Uses "Delete a release" Outputs
        uses: example-actions/use-releases-delete@v3 # illustrative
        with:
          use-release-id: ${{ steps.releases-delete.outputs.release-id }}