1
0
mirror of synced 2026-01-03 06:04:16 -05:00
Files
docs/content/actions/managing-issues-and-pull-requests/adding-labels-to-issues.md
Grace Park 1dfa5c251e Fix ordered lists to only use 1. (#38283)
Co-authored-by: Rachael Sewell <rachmari@github.com>
2023-06-26 16:25:04 -07:00

3.6 KiB

title, shortTitle, intro, redirect_from, versions, type, topics
title shortTitle intro redirect_from versions type topics
Adding labels to issues Add labels to issues You can use {% data variables.product.prodname_actions %} to automatically label issues.
/actions/guides/adding-labels-to-issues
fpt ghes ghae ghec
* * * *
tutorial
Workflows
Project management

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

Introduction

This tutorial demonstrates how to use the actions/github-script action 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 actions/github-script action 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 actions/github-script action. 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:
          - uses: {% data reusables.actions.action-github-script %}
            with:
              script: |
                github.rest.issues.addLabels({
                  issue_number: context.issue.number,
                  owner: context.repo.owner,
                  repo: context.repo.repo,
                  labels: ["triage"]
                })
    
  4. Customize the script parameter in your workflow file:

    • The issue_number, owner, and repo values are automatically set using the context object. 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. 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