プレビューデプロイ
デプロイブランチへのすべてのプルリクエストに、サイトのプレビューがそれぞれ作成され、プルリクエストからリンクされます。Pro および Enterprise で利用できます。
2026年11月19日更新
デプロイブランチにプルリクエストを開くと、Typemark は公開される予定のサイトをビルドし、そのための専用アドレスで提供して、プルリクエストからリンクします。レビュー担当者は、マージ前に読者に見える形で変更を確認でき、公開中のサイトは変わりません。プレビューデプロイは Pro および Enterprise で利用でき、プロジェクトオーナーのプランに従います。GitHub に接続されたプロジェクトで動作します。
仕組み
プルリクエストを開く
リポジトリにブランチをプッシュし、デプロイブランチへのプルリクエストを開きます。
Typemark がリンク付きのコメントを投稿
Typemark がプルリクエストのブランチをビルドし、プレビューのアドレスを記載したコメントをプルリクエストに追加します。
変更をさらにプッシュ
プルリクエストへのプッシュのたびに、同じアドレスでプレビューが再ビルドされます。Typemark は新しいコメントを追加せず、既存のコメントを更新します。
マージまたはクローズ
マージすると、通常どおり変更が公開サイトに公開されます。いずれの場合も、プレビューは削除されます。
プレビューのアドレス
プレビューのアドレスは、プロジェクトのアドレスに --pr- とプルリクエストの番号を付けたものです。
https://acme-docs--pr-12.typemark.dev
サイトにカスタムドメインを設定していても、プレビューは常に typemark.dev 上に作成されます。
プルリクエストのコメント
Typemark は各プルリクエストにコメントを 1 つ残し、状況に応じて内容を編集します。
Typemark preview of 4f2c9e1
Ready: https://acme-docs--pr-12.typemark.dev
The preview follows every push to this pull request, isn't indexed by search engines, and is removed when the pull request is closed.
ビルドに失敗した場合、コメントにはエラーが表示され、直前に正常にビルドされたプレビューはそのまま残ります。コメントが削除された場合、次のビルドで新しいコメントが投稿されます。
プレビューに含まれるもの
プレビューは、プルリクエストのブランチにあるとおりのサイトです。ページ、ナビゲーション、typemark.json、画像、カスタム CSS、翻訳を含み、/fr/ のアドレスと言語切り替えも機能します。手動で公開している場合でも、すべてのページが一度に公開されます。
画面上部のバナーに、どのプルリクエストのプレビューかが表示され、プルリクエストと公開中のサイトへのリンクも表示されるため、本番サイトと間違えられることはありません。
レビュー担当者専用
プレビューは変更を確認するためのものであり、読者や AI ツールのためのものではありません。
- 検索エンジンにはインデックスしないよう指示され、
robots.txtでクローラーをブロックしています。サイトマップはありません。 llms.txt、llms-full.txt、ページの Markdown 版、MCP サーバーは提供されません。- Ask AI、ページアクションメニュー、フィードバックウィジェットはありません。検索はプレビューのページに対して機能します。
- ページビューは Analytics にカウントされず、Google Analytics などの連携も読み込まれません。
- AI 翻訳はプレビューでは実行されません。
アドレスを知っている人は誰でもプレビューを開けるため、公開中のサイトと同様に扱ってください。
プレビューが公開中のサイトより多くを見せることはない
読者を公開中のサイトから遠ざけるものは、そのプレビューからも遠ざけます。サイトにパスワードが設定されている場合、各プレビューはプレビューのアドレスごとに一度パスワードを求めます。サイトがオフラインの間は、プレビューはビルドされますが「coming soon」ページが表示され、コメントにはサイトが公開されたあとにプレビューが提供されると書かれます。
プレビューが削除されるとき
次の場合、プレビューは削除され、コメントに理由が記載されます。
- プルリクエストがマージまたはクローズされた場合。
- プルリクエストのベースが、デプロイブランチ以外のブランチに変更された場合。
- 14 日間プッシュがない場合。再度プッシュすると、プレビューが戻ります。
- プロジェクトの GitHub 接続が解除された場合。
プレビューが作成されないプルリクエスト
- フォークからのプルリクエスト。 フォークの作成者は、チームのメンバーでなくても、プロジェクト名を含むアドレスに何でも公開できてしまうため、フォークからのプルリクエストはビルドされません。プレビューするには、ブランチをリポジトリにプッシュし、そこからプルリクエストを開いてください。
- デプロイブランチ以外へのプルリクエスト。 プレビューが作成されるのは、デプロイブランチへのプルリクエストのみです。
- オーナーが Pro または Enterprise でないプロジェクト。
プロジェクトのスラッグと --pr-12 を合わせた長さは、アドレスとして使える最大長の 63 文字以内に収まる必要があります。スラッグが約 55 文字を超えると、プレビューはビルドされますがアドレスは割り当てられず、コメントにその旨が表示されます。
プラン
プレビューデプロイは、プロジェクトオーナーのプランに従います。オーナーが Free に変更された場合、プレビューの提供は停止し、新しいプルリクエストはビルドされません。再び Pro または Enterprise にアップグレードすると、以前のプレビューが戻ります。
エディターのブランチ
Typemark エディターで作成したブランチにもプレビューが作成され、アドレスはブランチ名から作られます(例: acme-docs--rewrite-quickstart.typemark.dev)。そのブランチから開いたプルリクエストは、このプレビューを使用します。詳しくは エディターのブランチ を参照してください。
プルリクエストにコメントが付かない
プルリクエストがデプロイブランチへのものであること、フォークではなく同じリポジトリのブランチからであること、そしてプロジェクトオーナーが Pro または Enterprise であることを確認してください。Typemark がプレビューをビルドしてコメントするには、プルリクエストへのアクセス権が必要です。アカウントまたは組織のオーナーに対して GitHub から Typemark アプリの新しい権限の承認を求められた場合は、承認してください。