issues-delete-comment.md

Delete comment

A composite action for deleting comments. This requires issues: write permissions in order to work correctly.

Inputs

Name	Description	Default
comment-id (*)	The comment 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

issues/delete-comment does not have any outputs at this time

Example

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

run:
  example-job:
    # ... 
    steps:
      # ... 
      - name: Delete comment
        uses: bitwizeshift/actions-github/issues/delete-comment@v1
        with:
          # Required inputs
          comment-id: COMMENT_ID

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