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

はじめに

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

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

ワークフローの作成

1. このプロジェクト管理ワークフローを適用したいリポジトリを選択してください。 書き込みアクセス権を持つ既存のリポジトリを利用することも、新しいリポジトリを作成することもできます。 リポジトリの作成に関する詳細は「新しいリポジトリの作成」を参照してください。

2. リポジトリに、.github/workflows/YOUR_WORKFLOW.ymlというファイルをYOUR_WORKFLOWの部分を選択した名前で置き換えて作成してください。 これがワークフローファイルです。 GitHub上での新しいファイルの作成に関する詳しい情報については「新しいファイルの作成」を参照してください。

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

   YAML

   # このワークフローはGitHubによって認定されていないアクションを使用します。
   # それらはサードパーティによって提供され、
   # 別個の利用規約、プライバシーポリシー、
   # サポートドキュメンテーションが適用されます。
   
   name: Add comment
   on:
     issues:
       types:
         - labeled
   jobs:
     add-comment:
       if: github.event.label.name == 'help-wanted'
       runs-on: ubuntu-latest
       steps:
         - name: Add comment
           uses: peter-evans/create-or-update-comment@a35cf36e5301d70b76f316e867e7788a55a31dae
           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:

4. ワークフローファイルのパラメータをカスタマイズします。

   • 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 がサポートされています。 マークダウンの詳細については、「基本的な書き込みとフォーマットの構文」を参照してください。

5. ワークフローファイルを、リポジトリのデフォルトブランチにコミットしてください。 詳細は「新しいファイルを作成する」を参照してください。

ワークフローのテスト

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

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

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

次のステップ

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