awendt / action-remove-labels

🏷️ GitHub Action to remove labels

Action Remove Labels

This is a GitHub Action to remove GitHub labels to an issue or a pull request.

This action extract the number from an issue or a pull request which has triggered this by default. It means you don't need to care about something annoying like whether you should use ${{ github.event.issue.number }} or ${{ github.event.pull_request.number }}.

It would be more useful to use this with other GitHub Actions' outputs.

Inputs

NAME	DESCRIPTION	TYPE	REQUIRED	DEFAULT
github_token	A GitHub token.	string	true	N/A
labels	The labels' name to be removed. Must be separated with line breaks if there're multiple labels.	string	true	N/A
number	The number of the issue or pull request.	number	false	N/A
repo	The owner and repository name. e.g.) Codertocat/Hello-World	string	false	${{ github.event.issue.number }} or ${{ github.event.pull_request.number }}
fail_on_error	Whether the action fails or not when getting errors. [true,false]	bool	false	false

Example

Remove a single label with a comment

name: Remove Label

on: [issue_comment]

jobs:
  remove_label:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions-ecosystem/action-remove-labels@v1
        if: ${{ startsWith(github.event.comment.body, '/remove-labels') }}
        with:
          github_token: ${{ secrets.github_token }}
          labels: bug

Remove multiple labels with a comment

name: Remove Labels

on: [issue_comment]

jobs:
  remove_labels:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions-ecosystem/action-remove-labels@v1
        if: ${{ startsWith(github.event.comment.body, '/remove-labels') }}
        with:
          github_token: ${{ secrets.github_token }}
          labels: |
            documentation
            changelog

License

Copyright 2020 The Actions Ecosystem Authors.

Action Remove Labels is released under the Apache License 2.0.