GitHubプルリクエストのプレビュー

GitHubでプルリクエストを作成するときに、コンテンツのプレビューを確認できます

GitBook スペースに同期されている GitHub ブランチにプルリクエスト（PR）を送信すると、マージ前にコンテンツをプレビューできます。これにより、変更をマージする前にその影響を確認できます。

この機能を使うと、PR をマージする前に最終的な確認レイヤーとしてチェックを行え、同期済みブランチに取り込む前に、変更を本番環境ではない環境で確認できます。

プレビューリンクへのアクセス方法

この動作は、次の権限を付与していれば、追加設定なしで機能します。 GitBook GitHub アプリ PR に必要な読み取り専用権限。

GitBook スペースと同期されたターゲットブランチを使用して PR を作成するたびに、PR に固有のプレビュー URL を含むステータスが追加されます。ステータスの 詳細 リンクをクリックすると、コンテンツのプレビュー URL に移動します。その後、PR をマージする前に、コンテンツが期待どおりであることを確認できます。

プレビューリンクにアクセスできるのは、GitBook アカウントを持つユーザーのみです。

セキュリティ上の考慮事項

セキュリティ上の理由から、デフォルトでは GitBook は現在、リポジトリのフォークから開かれた PR のプレビューを生成しません。PR プレビューのコンテンツは、自分のドメイン下でアクセス可能であり、 .gitbook.io でもカスタムドメインでも同様に、公開リポジトリのフォーク内で悪意のあるコンテンツを生成し、それをあなたの名前で配信させることが可能になってしまうためです。

Git Sync の設定オプションを通じて、ユーザーがこれを明示的に設定できるようにしています。

FAQ

プルリクエストで GitBook のドキュメントのプレビューが表示されないのはなぜですか？

よくある原因:

• サイトが公開されていません。 PR プレビューの URL は、公開済みのドキュメントサイト（ .gitbook.io またはカスタムドメイン）から提供されます。

• サイトが認証されたアクセスの背後にあります。 Git Sync の PR プレビューは、次の背後で公開されているサイトでは利用できません 認証済みアクセス.