issues-remove-labels.md

Remove labels from issue

A composite action for removing labels from a github issues. This requires issues: write permissions in order to work correctly.

Inputs

Name	Description	Default
labels (*)	A list of labels to add, separated by either newlines or commas.	N/A
github-token	The default token to use for this Git operation. If unspecified, this will default to github.token.	"${{ github.token }}"
issue-number	The issue number to comment on	"0"
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/remove-labels does not have any outputs at this time

Example

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

run:
  example-job:
    # ... 
    steps:
      # ... 
      - name: Remove labels from issue
        uses: bitwizeshift/actions-github/issues/remove-labels@v1
        with:
          # Required inputs
          labels: LABELS

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