https://chaya2z.hatenablog.jp/entry/2024/12/22/110000

この記事ははてなエンジニア Advent Calendar 2024 の22日目の記事です。昨日は id:deflis55 さんの「【SwiftUI】UIViewRepresentable の使い方とライフサイクルを理解する」でした。

はじめに

Renovate が作る PR の説明 (description) に任意のメッセージを挿入する方法を紹介します。

次のページを参考にしました。

docs.renovatebot.com

前提

Renovate をリポジトリにインストールしていることが前提です。

docs.renovatebot.com

使ってみる

renovate.json に次のように prHeader、prFooter、prBodyNotes を設定します。

{
  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
  "prHeader": "> [!NOTE]\n> ここが prHeader",
  "prFooter": "> [!NOTE]\n> ここが prFooter",
  "prBodyNotes": "> [!NOTE]\n> ここが prBodyNotes"
}

すると、Renovate が作る PR は次の画像のようになります。赤枠で囲った部分がそれぞれ今回挿入したメッセージです。

prHeader: 説明の冒頭にメッセージを挿入します
prFooter: 説明の末尾にメッセージを挿入します
prBodyNotes: テーブルの下にメッセージを挿入します

おわりに

私のチームでは prHeader にレビューのポリシーを書いています。例えば、「リリースノートを読んで破壊的変更があるか確認する」とメッセージを入れておけばレビューがスムーズになると思うのでおすすめです。

はてなエンジニア Advent Calendar 2024 の22日目の記事でした。明日の担当は id:fxwx23 さんです。