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 プレビューは、以下のように公開されているサイトでは利用できません 認証済みアクセス.