カスタム マージ チェックを設定して使用する

カスタム マージ チェックとは、Forge アプリとして記述されたルールと条件のことです。ワークスペース管理者は、サードパーティ ベンダーなどの他社が作成した既存のチェック アプリをベースにカスタム マージ チェックの作成や実装を行うことで、一貫性のある安全で品質重視のワークフローを構築できます。 こうしたカスタム チェックによって、プル リクエストの検証のカスタマイズや、開発ワークフローのきめ細かいコントロールが可能になります。 ワークフローの一貫性を保つために、リポジトリ管理者はカスタム マージ チェックを有効にして、コードがマージされる前に条件やチェックが満たされていることを確認できます。

カスタム マージ チェックを設定する

カスタム マージ チェックを設定およびセットアップできるのはワークスペース管理者だけです。

カスタム マージ チェックをセットアップする手順は以下のとおりです。

1. 次の 2 つのオプションのいずれかを使用して、カスタム マージ チェック アプリをワークスペースにインストールします。

   1. アプリのソース コードがあれば、ご自身やチームが Forge CLI forge install コマンドで作成したアプリをインストールします。 カスタム マージ チェック アプリの作成の詳細については、開発者向けドキュメンテーションを参照してください。 Install コマンドの詳細については、Install コマンドを参照してください。

   2. アプリ開発者から提供された直接配布リンクを介して他の誰かが作成したアプリをインストールする。 詳細については、「アプリの配布」開発者向けドキュメントを参照してください。

2. 上部のナビゲーション バーの右上隅にある [設定] を選択し、[ワークスペースの設定] を選択します。

3. 左側のナビゲーション バーの [ワークフロー] で [カスタム マージ チェック] を選択します。

4. ワークスペースでカスタム マージ チェック機能を有効にするには、[Allow custom merge checks for my workspace (自分のワークスペースでカスタム マージ チェックを許可する)] トグルを選択します。

5. この機能を有効にすると、インストールされているアプリから利用できるすべてのカスタム マージ チェックが [リポジトリの設定] の [カスタム マージ チェック] ページに表示されるようになります。

カスタム マージ チェックを有効にして使用する

カスタム マージ チェックの有効/無効の切り替えと使用が可能なのはリポジトリ管理者だけです。

リポジトリ管理者はカスタム マージ チェックを有効にすることで、コードがマージされる前に条件やチェックが満たされていることを確認できます。 既定では、すべてのカスタム マージ チェックが無効 (オフ) になっています。

リポジトリに関連するカスタム マージ チェックの表示や有効/無効の切り替えを行う方法は以下のとおりです。

1. リポジトリの左側のサイドバーで [リポジトリの設定] を選択します。

2. 左側のサイドバーにある [ワークフロー] で [カスタム マージ チェック] を選択します。

• カスタム マージ チェック ページでは、ビューを [Main branch (メイン ブランチ)] から [すべてのブランチ] に変更することで 、カスタム マージ チェックが作成され、任意のブランチに割り当てられていることを確認できます。

• 対象のカスタム マージ チェックに関連するドロップダウンから [オフ] か [推奨] を選択することで、リポジトリ管理者はこれらのチェックの有効/無効を切り替えることができます。

• 有効になっているカスタム マージ チェックは、有効になっている他のブランチ制限やマージ設定とともに、プル リクエストの右側のサイドバーにある [詳細] タブに表示されます。

[リポジトリの設定] でいくつかのカスタム チェックを有効にすると、プル リクエストには有効にしたチェックが含まれるようになります。

マージ前チェックとマージ時チェックの違い

マージ前にオープン PR でさまざまなイベントが発生するとマージ前チェックがトリガーされます。 たとえば、コードがプル リクエストのソース ブランチにプッシュされた場合などです。 これらのチェックには「pre-merge」というラベルが付けられます。

マージ時チェックはマージプロセス自体に統合されており、[マージ] ボタンを選択した後にのみトリガーされます。 必須のマージ時チェックに失敗すると、プル リクエストのマージに失敗します。

カスタム チェックは、マージ前、マージ時、またはその両方のいずれかです。 チェックのタイプは Forge アプリの定義でサブスクライブしているトリガーによって異なります。 マージ チェックのタイプはカスタム マージ チェックのリストの [タイプ] 列に表示されます (例については上の画像を参照)。

Forge の使用とカスタム マージ チェックの作成についての情報

Forge 関連リソース

• Forge (はじめに) チュートリアル

• Bitbucket コミュニティに参加して、カスタム チェックに関する最新情報を入手したり、会話に参加したりする: Forge for Bitbucket Cloud コミュニティ

カスタム マージ チェックの作成に関するリソース

• ステップバイステップのチュートリアル

• プル リクエストのタイトル検証ツールとシークレット スキャナーの適用に関するサンプル リポジトリ