ブランチ

Guidebook Cloudでは、GitHubリポジトリのブランチごとに独立したドキュメント環境を提供します。これにより、本番環境に影響を与えずに新しいドキュメントをプレビューできます。

ブランチプレビュー

仕組み

GitHubリポジトリにブランチをプッシュすると、Guidebook Cloudは自動的にそのブランチのドキュメントをビルドし、独立したURLで公開します。

https://guidebook.dev/{org}/{repository}/{branch}/

ブランチURL
mainhttps://guidebook.dev/example/docs/main/
develophttps://guidebook.dev/example/docs/develop/
feature/new-apihttps://guidebook.dev/example/docs/feature/new-api/

デフォルトブランチ

概要

デフォルトブランチは、リポジトリの主要なドキュメントブランチです。通常は main または master を設定します。

設定方法

  1. リポジトリの設定ページを開く
  2. 「デフォルトブランチ」を選択
  3. 「保存」をクリック

注意: デフォルトブランチを変更するには、対象のブランチが既にビルドされている必要があります。

ブランチの管理

ブランチ一覧

リポジトリ詳細ページの「ブランチ」タブで、すべてのブランチを確認できます:

  • ブランチ名
  • 最終デプロイ日時
  • ストレージ使用量
  • ドキュメントへのリンク

ブランチの削除

不要なブランチを削除してストレージを解放できます:

  1. リポジトリ詳細ページを開く
  2. 「ブランチ」タブをクリック
  3. 削除したいブランチの「削除」ボタンをクリック
  4. 確認ダイアログで「削除」をクリック

注意:

  • GitHubでブランチを削除しても、Guidebook Cloud上のブランチは自動削除されません
  • デフォルトブランチは削除できません

ブランチとビルド

ビルドの流れ

  1. GitHubにプッシュ
  2. Webhookが送信される
  3. ブランチごとにビルドジョブが作成
  4. ビルド完了後、R2ストレージにデプロイ

同時ビルド

同じブランチに対する複数のプッシュがある場合:

  • 最新のプッシュのみがビルドされます
  • 古いビルドジョブは自動的にスキップされます

ビルドの再実行

ビルドが失敗した場合、手動で再実行できます:

  1. リポジトリ詳細ページを開く
  2. 「ビルドを実行」をクリック
  3. ブランチを選択
  4. 「実行」をクリック

ストレージ

ブランチごとのストレージ

各ブランチのビルド成果物は、独立したストレージ領域に保存されます。ブランチを削除すると、対応するストレージも解放されます。

ストレージ使用量の確認

  1. リポジトリ詳細ページを開く
  2. 「ブランチ」タブで各ブランチのサイズを確認
  3. リポジトリ全体の使用量はリポジトリ一覧で確認可能

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

概要

プルリクエストを作成すると、そのブランチのドキュメントを自動的にプレビューできます。

使い方

  1. GitHubでプルリクエストを作成
  2. 自動的にビルドが実行される
  3. ビルド完了後、プレビューURLが利用可能

プレビューURLはプルリクエストのブランチ名でアクセスできます:

https://guidebook.dev/{org}/{repository}/{pr-branch}/

ベストプラクティス

ブランチ命名規則

  • main または master: 本番ドキュメント
  • develop: 開発版ドキュメント
  • feature/*: 機能ブランチ
  • docs/*: ドキュメント専用ブランチ

定期的なクリーンアップ

マージ済みのブランチは定期的に削除することを推奨します:

  • ストレージ使用量の削減
  • ブランチ一覧の見やすさ向上