Skip to main content

このバージョンの GitHub Enterprise はこの日付をもって終了となります: 2023-01-18. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの向上、新機能の向上を図るために、最新バージョンの GitHub Enterprise にアップグレードします。 アップグレードに関するヘルプについては、GitHub Enterprise サポートにお問い合わせください

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

GitHub Actions を使用して、特定のラベルが適用されたときに Issue に自動的にコメントすることができます。

注: GitHub ホステッド ランナーは、現在 GitHub Enterprise Server でサポートされていません。 GitHub public roadmap で、今後の計画的なサポートの詳細を確認できます。

はじめに

このチュートリアルでは、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によって認定されていないアクションを使用します。
    # それらはサードパーティによって提供され、
    # 別個の利用規約、プライバシーポリシー、
    # ドキュメントを参照してください。
    
    # 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@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 にコメントが追加されます。

次の手順