注: GitHub ホステッド ランナーは、現在 GitHub Enterprise Server でサポートされていません。 GitHub public roadmap で、今後の計画的なサポートの詳細を確認できます。
はじめに
このチュートリアルでは、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@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:
-
ワークフローファイルのパラメータをカスタマイズします。
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 がサポートされています。 マークダウンの詳細については、「基本的な書き方とフォーマットの構文」を参照してく� さい。
-
ワークフローファイルを、リポジトリのデフォルトブランチにコミットしてく� さい。 詳細については、「新しいファイルの作成」を参照してく� さい。
ワークフローのテスト
リポジトリ内の 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
アクションのドキュメントにアクセスしてく� さい。