New: The GitBook MCP server is here.
Connect your AI agent
Ctrlk
ProductPricingBook a demoLog inSign up
For the complete documentation index, see llms.txt. This page is also available as Markdown.

マージルール

変更リクエストをマージする前に満たす必要がある要件を定義します

マージルールを使うと、変更リクエストをマージする前に満たす必要がある要件を定義できます。たとえば、特定のユーザーによるレビューを必要にしたり、変更リクエストに件名や説明の入力を必須にしたりできます。

これらのルールはコンテンツの品質を維持し、ドキュメントのワークフロー全体で適切なレビュープロセスを確保するのに役立ちます。

マージルールを設定すると、変更リクエストがマージ可能かどうかを自動的に評価します。ルールが満たされていない場合、要件が満たされるまでマージはブロックされます。

これにより、チームのコラボレーション基準とレビュースタンダードを自動的に適用できます。

マージルールの使用

チームのワークフローに合わせて、さまざまなレベルでマージルールを設定できます。

組織レベルの設定

組織では、すべてのセクションが継承する既定のマージルールを設定できます。これにより、複数のセクション間で一貫性を保ちながら、必要に応じて各セクションが個別にルールをカスタマイズすることもできます。

組織のマージルールを設定するには、組織の ホーム に戻って 設定 、 管理 をサイドバーでクリックします。設定画面で マージルール の 組織 グループをクリックします。ここで組織全体のマージルールを指定できます。

制限なしのマージを選ぶか、プリセット一覧から選択して組織全体の変更リクエストに適用できます。

セクションレベルの設定

組織全体のマージルールを有効にしているかどうかにかかわらず、各セクションにはコンテンツやチーム構成に合わせた独自のマージ要件を設定できます。

これにより、重要なドキュメントにはより厳しいルールを、下書きコンテンツにはより緩やかなルールを適用できます。

セクションのマージルールを設定するときは、次のいずれかを選べます。

  • 継承する 組織のマージルールを

  • カスタムルールを定義する そのセクション専用の

  • マージルールを無効にする 完全に

組織のルールを継承すると、組織のマージルールへの変更は自動的にそのセクションに適用されます。

セクションのマージルールを設定するには、エディタ左上の 操作メニュー エディタ左上の マージルール。ここで、組織のマージルールを継承するか、そのセクション専用の新しいルールを設定するかを指定できます。

ルールの評価

ルールの仕組み

誰かが変更リクエストをマージしようとすると、GitBook は設定されたすべてのルールを順に評価します：

  • マージを許可するには、構成内のすべてのルールを通過する必要があります

  • ルールは設定に表示されている順序で評価されます

  • いずれかのルールに失敗すると、適切なエラーメッセージとともにマージはブロックされます

  • バイパス機能のあるルールは、それ以前の失敗を上書きできます

バイパスルール

一部のルールにはバイパス機能があります（たとえば 指定したアクターに要件のバイパスを許可）。これらの特別なルールは他のルールの失敗を上書きできます。バイパスルールが true と評価されると、他のルールが失敗していてもマージは許可されます。

ベストプラクティス

マージルールを設定する際は、次の推奨事項を参考にしてください：

  • シンプルに始める：まずは、少なくとも1件のレビューを必須にするなどの基本的なルールから始めます。

  • 段階的に拡大する：チームの成長とワークフローの成熟に合わせて、より具体的な要件を追加します。

  • バイパスは慎重に使う：バイパス権限は信頼できる管理者にのみ付与してください。

  • 定期的に見直す：チームの実際のワークフローパターンに基づいてルールを調整します。

  • まずテストする：可能な場合は、本番セクションに適用する前にテスト用セクションでルール変更を試してください。

利用可能なルールタイプ

レビュー要件

ルール
説明

少なくとも1件のレビューを必須にする

少なくとも1人のチームメンバーが変更リクエストをレビューしてからでないとマージできないようにします。

すべてのレビューの承認を必須にする

すべて 完了済み （未依頼の）レビューはすべて承認でなければなりません。レビュアーの誰かが変更を要求したり変更リクエストを却下した場合、マージはブロックされます。

指定したアクターによるレビューを必須にする

指定したすべてのユーザーからの承認が必要です。マージされる前に変更リクエストをレビューして承認しなければならない特定のチームメンバーを選択できます。

指定したいずれかのアクターによるレビューを必須にする

指定したユーザーのうち少なくとも1人からの承認が必要です。複数の適格なレビュアーがいるが、グループからは1件の承認だけでよい場合に便利です。

Docs Agent によるレビューを必須にする（近日公開）

GitBook の AI エージェントによるレビューが必要です。これにより、マージ前にコンテンツ変更に対して自動の品質チェックが実行されます。

変更リクエストの要件

ルール
説明

最新の変更リクエストを必須にする

変更リクエストは、プライマリコンテンツブランチの最新状態でなければなりません。変更リクエスト作成後にプライマリコンテンツが更新されている場合は、マージ前に rebase するか更新する必要があります。

件名を必須にする

変更リクエストには説明的な件名/タイトルが必要です。件名が空だとマージはブロックされます。

説明を必須にする

変更リクエストには、どのような変更を行い、なぜ行ったのかを説明する内容を含める必要があります。

詳細オプション

ルール
説明

指定したアクターに要件のバイパスを許可

他のすべてのマージルール要件をバイパスできる特定のユーザーを指定できます。これは、管理者や、ルールを上書きする必要がある緊急時に便利です。

カスタム式

カスタム JavaScript 式を使用して高度なマージルールを作成できます。これにより、変更リクエスト、レビュー、マージしようとしているユーザーのプロパティにアクセスしながら、評価コンテキストに基づく複雑なロジックを定義できます。

カスタム式

カスタム式を作成すると、誰かが変更リクエストをマージしようとするたびに評価されます。式が true、マージは許可されます。返り値が falseの場合、マージはブロックされます。

カスタム式は標準的な JavaScript 構文（ES2022）をサポートしており、最大長は 1024 文字です。

利用可能なコンテキスト変数：

  • changeRequest.subject - 変更リクエストの件名/タイトル

  • changeRequest.description - 変更リクエストの説明

  • changeRequest.outdated - 変更リクエストが古いかどうか（真偽値）

  • changeRequest.createdBy.id - 変更リクエストを作成したユーザーの ID

  • reviews - 以下を含む各レビューオブジェクトの配列：

    • reviews[].status - レビューステータス（"approved" または "changes_requested")

    • reviews[].reviewer.id - レビュアーの ID

  • actor.id - マージを試みているユーザーの ID

よくある式の例：

最終更新

役に立ちましたか？