add-labels-to-issues.md

title	Adding labels to issues
shortTitle	Add labels to issues
intro	You can use {% data variables.product.prodname_actions %} to automatically label issues.
redirect_from	/actions/guides/adding-labels-to-issues /actions/managing-issues-and-pull-requests/adding-labels-to-issues /actions/use-cases-and-examples/project-management/adding-labels-to-issues /actions/how-tos/use-cases-and-examples/project-management/adding-labels-to-issues /actions/tutorials/project-management/adding-labels-to-issues
versions	fpt ghes ghec * * *
contentType	tutorials
category	Reuse and share automations

{% data reusables.actions.enterprise-github-hosted-runners %}

Introduction

This tutorial demonstrates how to use the {% data variables.product.prodname_cli %} in a workflow to label newly opened or reopened issues. For example, you can add the triage label every time an issue is opened or reopened. Then, you can see all issues that need to be triaged by filtering for issues with the triage label.

The {% data variables.product.prodname_cli %} allows you to easily use the {% data variables.product.prodname_dotcom %} API in a workflow.

In the tutorial, you will first make a workflow file that uses the {% data variables.product.prodname_cli %}. Then, you will customize the workflow to suit your needs.

Creating the workflow

1. {% data reusables.actions.choose-repo %}

2. {% data reusables.actions.make-workflow-file %}

3. Copy the following YAML contents into your workflow file.

   name: Label issues
   on:
     issues:
       types:
         - reopened
         - opened
   jobs:
     label_issues:
       runs-on: ubuntu-latest
       permissions:
         issues: write
       steps:
         - run: gh issue edit "$NUMBER" --add-label "$LABELS"
           env:
             GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %}
             GH_REPO: {% raw %}${{ github.repository }}{% endraw %}
             NUMBER: {% raw %}${{ github.event.issue.number }}{% endraw %}
             LABELS: triage

4. Customize the env values in your workflow file:

   • The GH_TOKEN, GH_REPO, and NUMBER values are automatically set using the github and secrets contexts. You do not need to change these.
   • Change the value for LABELS to the list of labels that you want to add to the issue. The label(s) must exist for your repository. Separate multiple labels with commas. For example, help wanted,good first issue. For more information about labels, see AUTOTITLE.

5. {% data reusables.actions.commit-workflow %}

Testing the workflow

Every time an issue in your repository is opened or reopened, this workflow will add the labels that you specified to the issue.

Test out your workflow by creating an issue in your repository.

1. Create an issue in your repository. For more information, see AUTOTITLE.
2. To see the workflow run that was triggered by creating the issue, view the history of your workflow runs. For more information, see AUTOTITLE.
3. When the workflow completes, the issue that you created should have the specified labels added.

Next steps

• To learn more about additional things you can do with the {% data variables.product.prodname_cli %}, see the GitHub CLI manual.
• To learn more about different events that can trigger your workflow, see AUTOTITLE.
• Search GitHub for examples of workflows using gh issue edit.