> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/documentation/ja-gitbook-documentation/collaborate/merge-rules.md).

# マージルール

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

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

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

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

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

## マージルールの使用

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

### 組織レベルの設定

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

組織のマージルールを設定するには、組織の **ホーム** に戻り、 **設定** <picture><source srcset="broken://files/CG9bVSmdbJnQxrYiNbRI" media="(prefers-color-scheme: dark)"><img src="https://4217681718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-5b92a51c6dfeecba3e53103f6e8d553bf798e57b%2F25_01_10_settings_icon_light.svg?alt=media" alt=""></picture>をクリックして、サイドバーの **管理** を選択します。設定画面で、 **マージルール** を **組織** グループの下でクリックします。ここで、組織全体に適用するマージルールを指定できます。

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

### セクションレベルの設定

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

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

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

* **継承** 組織のマージルールを
* **カスタムルールを定義** して、そのセクションにのみ適用する
* **マージルールを無効化** する

{% hint style="info" %}
組織のルールを継承すると、組織のマージルールを変更した際に、その変更がセクションにも自動的に適用されます。
{% endhint %}

セクションのマージルールを設定するには、エディターの左上にある **アクションメニュー** <i class="fa-ellipsis">:ellipsis:</i> を開き、 **マージルール**をクリックします。ここでは、組織のマージルールを継承するか、そのセクション専用の新しいルールを設定するかを指定できます。

## ルールの評価

### ルールの仕組み

変更リクエストをマージしようとすると、GitBookは設定済みのすべてのルールを順番に評価します。

* マージを許可するには、設定内のすべてのルールを満たす必要があります
* ルールは設定内に表示されている順に評価されます
* いずれかのルールを満たせない場合、適切なエラーメッセージとともにマージがブロックされます
* バイパス機能を持つルールは、それ以前のルールの失敗を覆せます

### バイパスルール

一部のルールには、（次のような）バイパス機能があります。 **指定したアクターによる要件のバイパスを許可**）。このような特別なルールは、ほかのルールの失敗を覆せます。バイパスルールの評価がtrueの場合、ほかのルールを満たしていなくてもマージが許可されます。

## ベストプラクティス

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

* **シンプルに始める**：まずは、少なくとも1件のレビューを必須にするなど、基本的なルールから始めましょう。
* **段階的に拡張する**：チームの成長やワークフローの成熟に合わせて、より具体的な要件を追加します。
* **バイパスは慎重に使用する**：バイパス権限は、信頼できる管理者にのみ付与します。
* **定期的に見直す**：チームの実際のワークフローに合わせてルールを調整します。
* **まずテストする**：可能であれば、本番セクションに適用する前にテストセクションでルールの変更を試します。

## 利用可能なルールの種類

### レビュー要件

<table><thead><tr><th width="279.703125">ルール</th><th>説明</th></tr></thead><tbody><tr><td><strong>少なくとも1件のレビューを必須にする</strong></td><td>変更リクエストをマージする前に、少なくとも1人のチームメンバーがレビュー済みであることを必須にします。</td></tr><tr><td><strong>すべてのレビューの承認を必須にする</strong></td><td>すべての <strong>完了した</strong> （依頼されていないレビューを除く）が承認であることを必須にします。レビュー担当者が変更をリクエストした場合、または変更リクエストを却下した場合、マージはブロックされます。</td></tr><tr><td><strong>指定した担当者によるレビューを必須にする</strong></td><td>指定したすべてのユーザーによる承認を必須にします。変更リクエストをマージする前にレビューと承認を行う必要があるチームメンバーを指定できます。</td></tr><tr><td><strong>指定した担当者のうち1人によるレビューを必須にする</strong></td><td>指定したユーザーのうち少なくとも1人による承認を必須にします。複数の適任者がレビューを担当できるものの、グループ内の1人からの承認で十分な場合に便利です。</td></tr><tr><td><strong>Docs Agent によるレビューを必須にする（近日公開）</strong></td><td>GitBook AI エージェントによるレビューを必須にします。これにより、マージ前にコンテンツの変更に対する自動品質チェックが行われます。</td></tr></tbody></table>

### 変更リクエストの要件

<table><thead><tr><th width="279.703125">ルール</th><th>説明</th></tr></thead><tbody><tr><td><strong>変更リクエストを最新の状態に保つ</strong></td><td>変更リクエストは、プライマリコンテンツブランチの最新状態と一致している必要があります。変更リクエストの作成後にプライマリコンテンツが更新された場合、マージする前にリベースまたは更新する必要があります。</td></tr><tr><td><strong>件名を必須にする</strong></td><td>変更リクエストには、内容がわかる件名／タイトルが必要です。件名が空の場合、マージはブロックされます。</td></tr><tr><td><strong>説明を必須にする</strong></td><td>変更リクエストには、どのような変更を行ったか、その理由を説明する内容が必要です。</td></tr></tbody></table>

### 詳細オプション

<table><thead><tr><th width="279.703125">ルール</th><th>説明</th></tr></thead><tbody><tr><td><strong>指定した担当者による要件のバイパスを許可する</strong></td><td>他のすべてのマージルール要件をバイパスできるユーザーを指定できます。管理者や、ルールを例外的に無効にする必要がある緊急時に便利です。</td></tr><tr><td><strong>カスタム式</strong></td><td>カスタムの JavaScript 式を使用して、高度なマージルールを作成できます。評価コンテキストに基づく複雑なロジックを定義でき、変更リクエスト、レビュー、マージを試みるユーザーのプロパティにアクセスできます。</td></tr></tbody></table>

#### カスタム式

カスタム式は、変更リクエストのマージが試みられるたびに評価されます。式が `true`を返す場合、マージが許可されます。式が `false`を返す場合、マージはブロックされます。

{% hint style="info" %}
カスタム式では標準的な JavaScript 構文（ES2022）を使用でき、最大文字数は1024文字です。
{% endhint %}

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

* `changeRequest.subject` - 変更リクエストの件名／タイトル
* `changeRequest.description` - 変更リクエストの説明
* `changeRequest.outdated` - 変更リクエストが最新でないかどうか（ブール値）
* `changeRequest.createdBy.id` - 変更リクエストを作成したユーザーの ID
* `reviews` - 各レビューオブジェクトを含む配列。各オブジェクトには次の情報が含まれます。
  * `reviews[].status` - レビューのステータス（`"approved"` または `"changes_requested"`)
  * `reviews[].reviewer.id` - レビュアーの ID
* `actor.id` - マージを試みているユーザーの ID

**一般的な式の例：**

{% code title="複数の承認済みレビューを必須にする" %}

```javascript
reviews.filter(r => r.status === "approved").length >= 2
```

{% endcode %}

{% code title="特定のユーザーによる承認を必須にする" %}

```javascript
reviews.some(r => r.reviewer.id === "harry" && r.status === "approved")
```

{% endcode %}

{% code title="緊急の変更には説明を必須にする" %}

```javascript
!changeRequest.subject.includes("[URGENT]") || !!changeRequest.description
```

{% endcode %}

{% code title="軽微な変更に限り、作成者自身によるマージを許可する" %}

```javascript
changeRequest.createdBy.id === actor.id ? changeRequest.subject.startsWith("[minor]") : true
```

{% endcode %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://gitbook.com/docs/documentation/ja-gitbook-documentation/collaborate/merge-rules.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
