Riebeckite
Menu
Color mode

Deployment Guides

Riebeckite で作成した Site を Cloudflare Workers へ公開するための Guide です。

基本的な流れは次のとおりです。

Diagram source
text
flowchart LR
    Source["Content / Config"]
    Build["riebeckite build"]
    Dist["dist/"]
    Workers["Cloudflare Workers"]
    Site["Public Site"]
 
    Source --> Build
    Build --> Dist
    Dist --> Workers
    Workers --> Site
sh
npm exec riebeckite build

を実行すると、公開用の Site が dist/ に生成されます。

通常の静的 Site では、この dist/ を Cloudflare Workers の Static Assets として配信します。

どの Guide を読めばいい？

やりたいこと Guide
手元から Cloudflare Workers へ公開したい Cloudflare Workers
GitHub への Push から自動公開したい GitHub Actions
Content と Site を別 Repository で運用したい Separate Content Repository

初めて公開する場合は、まず Cloudflare Workers を読むのがおすすめです。create-riebeckite で Cloudflare Workers を選ぶと Wrangler の依存と wrangler.jsonc が生成され、npm exec riebeckite deploy で手元から公開できます。deploy は build を行わないため、先に npm exec riebeckite build で dist/ を作ります。すでに手元から公開している Site は、npm exec riebeckite deploy setup で GitHub Actions の継続デプロイを準備できます。

Diagram source
text
flowchart TD
    Start["Siteを公開したい"]
    Auto{"自動Deployする？"}
    Separate{"Contentを<br/>別Repositoryにする？"}
 
    Start --> Auto
    Auto -->|"No"| Workers["Cloudflare Workers"]
    Auto -->|"Yes"| Separate
    Separate -->|"No"| Actions["GitHub Actions"]
    Separate -->|"Yes"| Content["Separate Content Repository"]

Build と Deploy

Riebeckite では、Build と Deploy は別の処理です。

text
Build
  → Contentや設定から dist/ を生成する
 
Deploy
  → dist/ をCloudflare Workersから配信する

公開対象は dist/ です。

.riebeckite/ や Plugin Cache は Build 時に利用する状態であり、公開 Asset ではありません。

text
dist/
  → 公開する
 
.riebeckite/
Plugin Cache
  → 公開しない

通常の静的 Site では Runtime の main も必要ありません。Riebeckite の Build 処理を Workers 上で実行するのではなく、Build 済みの dist/ を配信します。

公開前の確認

Deploy 前には、次の順で確認できます。

sh
npm exec riebeckite check
npm exec riebeckite doctor
npm exec riebeckite build

build が成功したら、生成された dist/ を Deploy します。

Deployment Guides

Cloudflare Workers

Cloudflare Workers

dist/ を Cloudflare Workers へ手元から公開する方法を説明します。npm exec riebeckite deploy がログインと wrangler.jsonc の生成を行います。

GitHub Actions

GitHub Actions

Site Repository への Push から、Build と Cloudflare Workers への Deploy を自動化します。

Separate Content Repository

Separate Content Repository

Obsidian Vault などの Content と Site を別 Repository で管理する方法を説明します。

Private Content Repository の認証や、Content 更新から Site の Deployment を起動する方法もこちらで扱います。

まとめ

Riebeckite の Deployment は、

text
Content
  ↓
riebeckite build
  ↓
dist/
  ↓
Cloudflare Workers

と考えれば十分です。

History

1 changesCollapseExpand
1 + # Deployment Guides
2 +
3 + Riebeckite で作成した Site を Cloudflare Workers へ公開するための Guide です。
4 +
5 + 基本的な流れは次のとおりです。
6 +
7 + ```mermaid
8 + flowchart LR
9 + Source["Content / Config"]
10 + Build["riebeckite build"]
11 + Dist["dist/"]
12 + Workers["Cloudflare Workers"]
13 + Site["Public Site"]
14 +
15 + Source --> Build
16 + Build --> Dist
17 + Dist --> Workers
18 + Workers --> Site
19 + ```
20 +
21 + ```sh
22 + npm exec riebeckite build
23 + ```
24 +
25 + を実行すると、公開用の Site が `dist/` に生成されます。
26 +
27 + 通常の静的 Site では、この `dist/` を Cloudflare Workers の Static Assets として配信します。
28 +
29 + ## どの Guide を読めばいい？
30 +
31 + | やりたいこと | Guide |
32 + | --- | --- |
33 + | 手元から Cloudflare Workers へ公開したい | [Cloudflare Workers](./cloudflare-workers.md) |
34 + | GitHub への Push から自動公開したい | [GitHub Actions](./github-actions.md) |
35 + | Content と Site を別 Repository で運用したい | [Separate Content Repository](./separate-content-repository.md) |
36 +
37 + 初めて公開する場合は、まず [Cloudflare Workers](./cloudflare-workers.md) を読むのがおすすめです。`create-riebeckite` で `Cloudflare Workers` を選ぶと Wrangler の依存と `wrangler.jsonc` が生成され、`npm exec riebeckite deploy` で手元から公開できます。`deploy` は build を行わないため、先に `npm exec riebeckite build` で `dist/` を作ります。すでに手元から公開している Site は、`npm exec riebeckite deploy setup` で GitHub Actions の継続デプロイを準備できます。
38 +
39 + ```mermaid
40 + flowchart TD
41 + Start["Siteを公開したい"]
42 + Auto{"自動Deployする？"}
43 + Separate{"Contentを<br/>別Repositoryにする？"}
44 +
45 + Start --> Auto
46 + Auto -->|"No"| Workers["Cloudflare Workers"]
47 + Auto -->|"Yes"| Separate
48 + Separate -->|"No"| Actions["GitHub Actions"]
49 + Separate -->|"Yes"| Content["Separate Content Repository"]
50 + ```
51 +
52 + ## Build と Deploy
53 +
54 + Riebeckite では、Build と Deploy は別の処理です。
55 +
56 + ```text
57 + Build
58 + → Contentや設定から dist/ を生成する
59 +
60 + Deploy
61 + → dist/ をCloudflare Workersから配信する
62 + ```
63 +
64 + 公開対象は `dist/` です。
65 +
66 + `.riebeckite/` や Plugin Cache は Build 時に利用する状態であり、公開 Asset ではありません。
67 +
68 + ```text
69 + dist/
70 + → 公開する
71 +
72 + .riebeckite/
73 + Plugin Cache
74 + → 公開しない
75 + ```
76 +
77 + 通常の静的 Site では Runtime の `main` も必要ありません。Riebeckite の Build 処理を Workers 上で実行するのではなく、Build 済みの `dist/` を配信します。
78 +
79 + ## 公開前の確認
80 +
81 + Deploy 前には、次の順で確認できます。
82 +
83 + ```sh
84 + npm exec riebeckite check
85 + npm exec riebeckite doctor
86 + npm exec riebeckite build
87 + ```
88 +
89 + `build` が成功したら、生成された `dist/` を Deploy します。
90 +
91 + ## Deployment Guides
92 +
93 + ### Cloudflare Workers
94 +
95 + [Cloudflare Workers](./cloudflare-workers.md)
96 +
97 + `dist/` を Cloudflare Workers へ手元から公開する方法を説明します。`npm exec riebeckite deploy` がログインと `wrangler.jsonc` の生成を行います。
98 +
99 + ### GitHub Actions
100 +
101 + [GitHub Actions](./github-actions.md)
102 +
103 + Site Repository への Push から、Build と Cloudflare Workers への Deploy を自動化します。
104 +
105 + ### Separate Content Repository
106 +
107 + [Separate Content Repository](./separate-content-repository.md)
108 +
109 + Obsidian Vault などの Content と Site を別 Repository で管理する方法を説明します。
110 +
111 + Private Content Repository の認証や、Content 更新から Site の Deployment を起動する方法もこちらで扱います。
112 +
113 + ## まとめ
114 +
115 + Riebeckite の Deployment は、
116 +
117 + ```text
118 + Content
119 + ↓
120 + riebeckite build
121 + ↓
122 + dist/
123 + ↓
124 + Cloudflare Workers
125 + ```
126 +
127 + と考えれば十分です。
128 +
129 + - 手動で公開する → [Cloudflare Workers](./cloudflare-workers.md)
130 + - Push から自動公開する → [GitHub Actions](./github-actions.md)
131 + - Content Repository を分離する → [Separate Content Repository](./separate-content-repository.md)
132 +