For the complete documentation index, see llms.txt. This page is also available as Markdown.

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

最終更新

役に立ちましたか?