Zenn
💬

冪等性をもったGithubのIssue/PRコメント投稿Actions作ったよ

2023/06/01に公開
GitHub
CI
actions
CI/CD
tech

TL;DR

Actions再実行時にコメントを複製しないで､どんどん上書きされていきます｡
CIの実行結果を投稿すると､再実行時のHidden処理が不要です

- name: rewritable-issue-comment
  uses: nakamuloud/actions-rewritable-comment@v1.0.0
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    VALUE: 'Hello World'

https://github.com/marketplace/actions/rewritable-issue-comment

使い方

on.pull_requestをトリガーにした場合

- name: rewritable-issue-comment
 uses: nakamuloud/actions-rewritable-comment@v1.0.0
 env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   VALUE: 'Hello World'

PR以外をトリガーにした場合

- name: rewritable-issue-comment
  uses: nakamuloud/actions-rewritable-comment@v1.0.0
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    VALUE: 'Hello World'
    ISSUE_NUMBER: 1 // Issue番号の指定が必要

１つのIssue/PRに複数のコメントを再編集したいとき

- name: rewritable-issue-comment
  uses: nakamuloud/actions-rewritable-comment@v1.0.0
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    VALUE: 'Hello World'
    COMMENT_ID: comment_id // コメントごとの識別子(冪等性コメントを複数投稿する場合必要,任意のキーワード)

全オプション

- name: rewritable-issue-comment
  uses: nakamuloud/actions-rewritable-comment@v1.0.0
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    VALUE: 'Hello World'
    ISSUE_NUMBER: 1
    OWNER: example
    REPOSITORY: dotfiles
    KEY: key // メッセージ識別子のキー(基本不要)
    COMMENT_ID: comment_id // メッセージ識別子(冪等性コメントを複数投稿する場合必要)

Discussion