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

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

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

この機能を使うと、PR をマージする前の最終チェックを行うことができ、同期されたブランチにマージする前に本番環境以外で変更を確認できます。

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

この動作はそのまま利用可能で、あなたが以下に対して GitBook GitHub アプリ PR に対する必要な読み取り専用権限を付与している場合に動作します。

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

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

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

セキュリティ上の理由から、デフォルトでは GitBook は現在、リポジトリのフォークから開かれた PR に対するプレビューを生成しません。PR プレビューのコンテンツはあなたのドメイン配下でアクセス可能になるため、 .gitbook.io またはカスタムドメイン上であれ、ユーザーが公開リポジトリのフォークで悪意のあるコンテンツを生成し、それをあなたの名前で提供させる可能性があるためです。

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

よくある質問

なぜプルリクエストで GitBook ドキュメントのプレビューが見えないのですか？

一般的な原因：

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

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