Bitbucket のプルリクのテンプレート
プルリクのテンプレートは、新しいプルリクの説明に Bitbucket が最初から入れておく文です。短いチェックリストや、チームが埋めてほしい見出しを置きます。Bitbucket Cloud と Bitbucket Data Center のどちらにもありますが、置き場所が違います。Cloud はリポジトリの中のファイル(またはリポジトリの設定)、Data Center はプロジェクトかリポジトリの設定です。以下は Atlassian のページにある決まりと、テンプレートが出ない時に見る所です。
Bitbucket Cloud:テンプレートのファイル
Markdown のファイルを、ちょうどこのパスにコミットします。
.bitbucket/pull_request_template.md
- Bitbucket はプルリクの元のブランチからこのファイルを読みます。元と宛先の両方にあるときは、元のブランチの方が使われます(Atlassian の Pull Request templates in Bitbucket Cloud)。
- 説明と同じく Markdown が使えます。
- 説明の中の
{{commit_messages}}は、プルリクを作った時にそのコミットのメッセージの一覧になります(Atlassian の Create a pull request)。
Bitbucket Cloud:Default description の設定
リポジトリの管理者は、Repository settings > Default description にも文を置けます。そのリポジトリの新しいプルリクには、この文が入ります(2019年1月の Save time with default pull request descriptions で発表)。リポジトリごとの設定で、ワークスペース全体の既定はありません。設定とファイルの両方があるリポジトリでどちらが勝つかは、Atlassian のページには書かれていません。
どちらも無いときは、コミットが2つ以上あるプルリクの説明は、そのコミットの一覧から始まります。
Bitbucket Data Center:Description template
Bitbucket Data Center 7.13 から、プロジェクトとリポジトリの管理者が Project settings > Description template または Repository settings > Description template で設定します(Atlassian の Create a pull request)。
- リポジトリは、自分の設定の Project settings inheritance で Use custom settings を選ばない限り、プロジェクトのテンプレートを受け継ぎます。
- テンプレートは Create pull request の画面の説明の欄に入ります。
- テンプレートが無いときは、説明はコミット履歴から始まります。Template behavior の Use the commit history as the default description で、この動きのままにもできます。
- テンプレートはサーバーの設定に置かれ、リポジトリの中のファイルではありません。
テンプレートが出ない時
- Cloud:元のブランチにファイルが無い。元のブランチから読むので、テンプレートが
mainに入る前に切ったブランチには入っていません。そのブランチにmainをマージかリベースします。 - Cloud:パスが違う。
.github/pull_request_template.mdは GitHub、.azuredevops/は Azure Repos の置き場所です。Bitbucket Cloud が読むのは.bitbucket/pull_request_template.mdだけです。 - Data Center:リポジトリが受け継いでいない。自分の設定を持つリポジトリは、プロジェクトのではなく自分のテンプレート(または無し)を使います。
- Data Center:サーバーが 7.13 より古い。7.13 より前には Description template がありません。
- Web の画面で作っていない。ここまでの決まりは Create pull request の画面のものです。REST API やほかの道具で作ったプルリクの説明は、その道具が送った文になります。
IntelliJ IDEA でテンプレートを使う
Pull Request Inbox for Bitbucket は、Lesstep が作っている JetBrains IDE(2024.1 以降)のプラグインです。自分のレビューを待っている Bitbucket Cloud と Bitbucket Data Center のプルリクを IDE のツールウィンドウに並べ、いまのブランチからプルリクを作れます。1.0.45 から、Bitbucket Cloud では作成の画面が、Web の画面と同じく元のブランチの .bitbucket/pull_request_template.md を説明に入れ、どのファイルを使ったかを画面に出します。Cloud の Default description の設定と Data Center の Description template には公開された REST API が無いので、プラグインからは読めず、その場合の説明は空から始まります。作成・承認・コメント・マージは Pro(30日間の無料試用つき)、レビューの受信箱・差分・マージチェックは無料です。画面は日本語です。
Bitbucket は Atlassian Pty Ltd の商標、IntelliJ IDEA は JetBrains s.r.o. の商標です。このページは Atlassian・JetBrains のいずれとも提携しておらず、承認も受けていません。
ほかに:既定のレビュアー · 下書きのプルリク · タスクと既定のタスク · English