Skip to content

ソースリポジトリの追加

新しい private リポジトリの docs/ を docs-hub に載せるときに使う。 いま集約している対象と、push から公開までの流れは 自動更新 を参照する。

手順

  1. そのリポジトリに Zensical 向け docs/ を置く
  2. 既存と同じ .github/workflows/trigger-docs-hub.yml を置く
  3. そのリポジトリの Secrets に、既存の DOCS_HUB_DISPATCH_TOKEN を登録する
    • 追加するリポジトリ → Settings → Secrets and variables → Actions → New repository secret
    • Name は DOCS_HUB_DISPATCH_TOKEN、値は既存ソース（例: finance-manager）の同名 Secret と同じ PAT
    • docs-hub 側の Secrets は触らない
  4. DOCS_READ_TOKEN 用の Fine-grained PAT に、そのリポジトリを足す
    • 自分のアカウント → Settings → Developer settings → Personal access tokens → Fine-grained tokens
    • docs-hub の DOCS_READ_TOKEN に使っているトークンを開き、Repository access にリポジトリを追加する
    • docs-hub の Secrets 画面は触らない。PAT の文字列も差し替えない
  5. docs-hub の scripts/aggregate.sh に copy_docs を足す
  6. docs-hub の .github/workflows/build.yml に checkout と、集約時の環境変数を足す

ナビ一覧を zensical.toml に書く必要はない。 フォルダから自動生成する。

PAT は新規発行しなくてよい

DOCS_HUB_DISPATCH_TOKEN は既存の Fine-grained PAT（対象は docs-hub、Contents: Read and Write）をソース側 Secret に登録する。 DOCS_READ_TOKEN も既存 1 本の PAT の Repository access にリポジトリを足せばよい。 いま読めるソースは finance-manager / pve-infra / home-kitchen である。足すときに既存を外さない。

動作確認

  1. ソースリポジトリで docs/ を main に push する
  2. そのリポジトリの Actions で trigger-docs-hub が成功することを見る
  3. docs-hub の Actions で build が走り、Pages に新しいデプロイが増えることを見る
  4. サイト上に docs/<リポジトリ名>/ が出ることを確認する