ラベルが追加されたときに Issue にコメントする

はじめに

このチュートリアルでは、peter-evans/create-or-update-comment アクションを使用して、特定のラベルが適用されたときに Issue にコメントする方法を示します。たとえば、help-wanted ラベルが Issue に追加されたときに、コメントを追加して、共同作成者に Issue への対応を促すことができます。

チュートリアルでは、peter-evans/create-or-update-comment アクションを使用するワークフローファイルをまず作成します。次に、ニーズに合わせてワークフローをカスタマイズします。

ワークフローの作成

このプロジェクト管理ワークフローを適用したいリポジトリを選択してください。書き込みアクセス権を持つ既存のリポジトリを利用することも、新しいリポジトリを作成することもできます。リポジトリの作成について詳しくは、「新しいリポジトリの作成」をご覧ください。
リポジトリに .github/workflows/YOUR_WORKFLOW.yml というファイルを作成します (YOUR_WORKFLOW は任意の名前に置き換えます)。これがワークフローファイルです。 GitHub で新しいファイルを作成する方法について詳しくは、「新しいファイルの作成」を参照してください。

次の YAML コンテンツをワークフローファイルにコピーします。

YAML

# このワークフローはGitHubによって認定されていないアクションを使用します。
# それらはサードパーティによって提供され、
# 別個の利用規約、プライバシーポリシー、
# ドキュメントを参照してください。

# GitHub では、コミット SHA にアクションをピン留めすることが推奨されます。
# 新しいバージョンを取得するには、SHA を更新する必要があります。
# タグまたはブランチを参照することもできますが、アクションは警告なしに変更される可能性があります。

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
        uses: peter-evans/create-or-update-comment@5f728c3dae25f329afbe34ee4d08eef25569d79f
        with:
          issue-number: ${{ github.event.issue.number }}
          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:

# このワークフローはGitHubによって認定されていないアクションを使用します。
# それらはサードパーティによって提供され、
# 別個の利用規約、プライバシーポリシー、
# ドキュメントを参照してください。

# GitHub では、コミット SHA にアクションをピン留めすることが推奨されます。
# 新しいバージョンを取得するには、SHA を更新する必要があります。
# タグまたはブランチを参照することもできますが、アクションは警告なしに変更される可能性があります。

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
        uses: peter-evans/create-or-update-comment@5f728c3dae25f329afbe34ee4d08eef25569d79f
        with:
          issue-number: ${{ github.event.issue.number }}
          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:

ワークフローファイルのパラメータをカスタマイズします。
- if: github.event.label.name == 'help-wanted' の help-wanted を操作するラベルに置き換えます。複数のラベルを操作する場合、条件を || で区切ります。たとえば、if: github.event.label.name == 'bug' || github.event.label.name == 'fix me' は、bug または fix me のラベルが Issue に追加されるたびにコメントします。
- body の値を追加するコメントの値に変更します。 GitHub Flavored Markdown がサポートされています。 Markdown について詳しくは、「基本的な書き方とフォーマットの構文」をご覧ください。
ワークフローファイルを、リポジトリのデフォルトブランチにコミットしてください。詳しくは、「新しいファイルの作成」を参照してください。

ワークフローのテスト

リポジトリ内の Issue にラベルが付けられるたびに、このワークフローが実行されます。追加されたラベルがワークフローファイルで指定したラベルの 1 つである場合、peter-evans/create-or-update-comment アクションによって Issue に指定したコメントが追加されます。

指定したラベルを Issue に適用して、ワークフローをテストします。

リポジトリで Issue をオープンします。詳しくは、「Issue の作成」を参照してください。
ワークフローファイル内の指定されたラベルで Issue にラベルを付けます。詳しくは、「ラベルを管理する」を参照してください。
Issue のラベル付けによってトリガーされたワークフローの実行を確認するには、ワークフローの実行履歴を表示します。詳しくは、「ワークフロー実行の履歴を表示する」を参照してください。
ワークフローが完了すると、ラベルを付けた Issue にコメントが追加されます。

次の手順

反応の追加など、peter-evans/create-or-update-comment アクションで実行できる追加の機能の詳細については、peter-evans/create-or-update-comment アクションのドキュメントにアクセスしてください。

ラベルが追加されたときに Issue にコメントする

この記事の内容

はじめに

ワークフローの作成

ワークフローのテスト

次の手順