トリガー
サイトとコンテンツが同じリポジトリにある場合
これが最も単純な構成です。
my-site/
├─ content/
├─ app/
├─ riebeckite.config.ts
└─ .github/
└─ workflows/
└─ publish.yml記事とサイトが同じリポジトリにあるため、流れは次のようになります。
Diagram source
flowchart LR
Push["main へプッシュ"]
Workflow["publish.yml"]
Build["ビルド"]
Deploy["Cloudflare"]
Push --> Workflow
Workflow --> Build
Build --> Deploy記事を変更して main へプッシュすれば、そのプッシュ自体がワークフローを起動します。
サイトとコンテンツが別リポジトリにある場合
コンテンツリポジトリを分離している場合は、流れが少し変わります。
コンテンツリポジトリ
→ Markdown / Obsidian Vault
サイトリポジトリ
→ Riebeckite / 設定 / テーマ / プラグインコンテンツリポジトリへプッシュしても、それだけではサイトリポジトリのワークフローは起動しません。GitHub Actions のワークフローは、それぞれのリポジトリに属しているからです。
Diagram source
flowchart LR
Content["コンテンツリポジトリ"]
Site["サイトリポジトリ"]
Workflow["サイトの publish.yml"]
Content -.->|"プッシュだけでは起動しない"| Workflow
Site -->|"プッシュ"| Workflowコンテンツの更新をきっかけにサイトを自動デプロイするには、コンテンツリポジトリからサイトリポジトリへ通知します。
repository_dispatch
別リポジトリからサイトのワークフローを起動するには、repository_dispatch を利用します。
Riebeckite が生成するワークフローは、次のイベントを受け取れるように設定されています。
content-updated全体の流れは次のとおりです。
Diagram source
flowchart LR
Push["コンテンツの<br/>main へプッシュ"]
Notify["notify-site.yml"]
Dispatch["repository_dispatch<br/>content-updated"]
Site["サイトリポジトリ"]
Workflow["publish.yml"]
Build["ビルド"]
Deploy["Cloudflare"]
Push --> Notify
Notify --> Dispatch
Dispatch --> Site
Site --> Workflow
Workflow --> Build
Build --> Deploynotify-site.yml
コンテンツリポジトリ側には、次のファイルを置きます。
.github/workflows/notify-site.ymlこのワークフローの役割は、サイトをビルドすることではありません。コンテンツが更新されたことをサイトリポジトリへ通知することです。
コンテンツリポジトリ
↓
サイトリポジトリへ
「コンテンツが更新された」と通知通知を受け取ったサイトリポジトリの publish.yml が、ビルドとデプロイを実行します。
SITE_DISPATCH_TOKEN
コンテンツリポジトリからサイトリポジトリへ repository_dispatch を送るには、SITE_DISPATCH_TOKEN をコンテンツリポジトリ側のシークレットとして設定します。
Diagram source
flowchart LR
Content["コンテンツリポジトリ"]
Token["SITE_DISPATCH_TOKEN"]
Site["サイトリポジトリ"]
Content --> Token
Token -->|"content-updated"| Siteこのトークンは、コンテンツリポジトリからサイトリポジトリのワークフローを起動するためのものです。