Github Workflow - Remove label at the end?

Question

I have a workflow that is triggered when the pull request is labeled (via pull_request_target).

I would to automatically remove the label that triggered the analysis as the last step of that workflow.

How can I do that?

Answer 1

On Github: every pull request is an issue (but not every issue is a pull request).

You can find more informations about this on this stackoverflow answer.

Therefore, you could use the Github API to remove a (specific) label from an issue (or an action doing the same thing) as the last step of your workflow, using the PR number.

Here is the API on Github to remove label from issue (Official Documentation)

If you want to call it directly from the shell in your workflow with curl, it will looks like this:

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/repos/<owner>/<repo>/issues/<pr_number>/labels/<label_name>

Answer 2

GuiFalourd does indeed have the correct answer, but I did have to improve on it a bit.

If you want to use the workflow on a private repo, you do need to add an authorization token. Here's an example that uses GitHub context to populate everything besides the label name you want to delete:

curl --silent --fail-with-body \
  -X DELETE \
  -H 'Accept: application/vnd.github.v3+json' \
  -H 'Authorization: token ${{ github.token }}' \
  'https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.number }}/labels/YOUR-LABEL'

Also if your label has spaces, use %20 for the whitespace.