Skip to content

Latest commit

 

History

History
75 lines (61 loc) · 4.04 KB

commenting-on-an-issue-when-a-label-is-added.md

File metadata and controls

75 lines (61 loc) · 4.04 KB
title intro redirect_from versions type topics shortTitle
Commenting on an issue when a label is added
You can use {% data variables.product.prodname_actions %} to automatically comment on issues when a specific label is applied.
/actions/guides/commenting-on-an-issue-when-a-label-is-added
/actions/managing-issues-and-pull-requests/commenting-on-an-issue-when-a-label-is-added
fpt ghes ghec
*
*
*
tutorial
Workflows
Project management
Add label to comment on issue

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

Introduction

This tutorial demonstrates how to use the {% data variables.product.prodname_cli %} to comment on an issue when a specific label is applied. For example, when the help wanted label is added to an issue, you can add a comment to encourage contributors to work on the issue. For more information about {% data variables.product.prodname_cli %}, see AUTOTITLE.

In the tutorial, you will first make a workflow file that uses the gh issue comment command to comment on an issue. 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: Add comment
on:
  issues:
    types:
      - labeled
jobs:
  add-comment:
    if: github.event.label.name == 'help wanted'
    runs-on: ubuntu-latest
    permissions:
      issues: write
    steps:
      - name: Add comment
        run: gh issue comment "$NUMBER" --body "$BODY"
        env:
          GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %}
          GH_REPO: {% raw %}${{ github.repository }}{% endraw %}
          NUMBER: {% raw %}${{ github.event.issue.number }}{% endraw %}
          BODY: >
            This issue is available for anyone to work on.
            **Make sure to reference this issue in your pull request.**
            :sparkles: Thank you for your contribution! :sparkles:

  4. Customize the parameters in your workflow file:

    • Replace help wanted in if: github.event.label.name == 'help wanted' with the label that you want to act on. If you want to act on more than one label, separate the conditions with ||. For example, if: github.event.label.name == 'bug' || github.event.label.name == 'fix me' will comment whenever the bug or fix me labels are added to an issue.
    • Change the value for BODY to the comment that you want to add. GitHub flavored markdown is supported. For more information about markdown, see AUTOTITLE.

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

Testing the workflow

Every time an issue in your repository is labeled, this workflow will run. If the label that was added is one of the labels that you specified in your workflow file, the gh issue comment command will add the comment that you specified to the issue.

Test your workflow by applying your specified label to an issue.

  1. Open an issue in your repository. For more information, see AUTOTITLE.
  2. Label the issue with the specified label in your workflow file. For more information, see AUTOTITLE.
  3. To see the workflow run triggered by labeling the issue, view the history of your workflow runs. For more information, see AUTOTITLE.
  4. When the workflow completes, the issue that you labeled should have a comment added.

Next steps

  • To learn more about additional things you can do with the GitHub CLI, like editing existing comments, visit the GitHub CLI Manual.