octocovで実現できる3つのレポートコメントの方法

octocovはコードメトリクスを取得してPull Requestにレポートをコメントしたり、設定したデータストアに記録することができます*1。

今回はoctocovで実現できる3つのレポートコメントの方法を紹介します。

Pull Requestへのレポートコメント

Pull Requestへレポートをコメントします。複数回レポートされる場合は過去レポートコメントを隠すようにしています。

octocov init で生成される .octocov.yml にも設定されるデフォルトのレポートコメントです。

設定は以下のような感じです。

comment:
  if: is_pull_request
  # hideFooterLink: false # レポートのフッタのリンクを消す
  # deletePrevious: true # 前回のレポートコメントを隠すのではなくて消す

GitHub ActionsのJob Summariesにレポートを追加します。

設定は以下のような感じです。

summary:
  if: true # 毎回Job Summariesにレポートを追加する

Pull Requestのコメントではなくボディに差し込む（随時差し込んだ内容を更新する）ようなレポートも可能です。

GtiHubとSlackを連動させているときにPull RequestコメントによるSlack通知がなくなるのがメリットかもしれません。

body:
  if: is_pull_request

以上、ちょっとしたTipsでした。

*1:設定上はデータストアへの記録を report: と表現しますが今回はコードメトリクスのレポートコメントの方を指します