@k2works/claude-code-booster 1.10.0 → 1.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -21
- package/README.md +42 -42
- package/bin/claude-code-booster +79 -79
- package/lib/assets/.claude/README.md +162 -162
- package/lib/assets/.claude/SKILLS_TEMPLATE.md +100 -100
- package/lib/assets/.claude/scripts/generate-inception-deck.mjs +911 -911
- package/lib/assets/.claude/settings.json +11 -11
- package/lib/assets/.claude/skills/ai-agent-guidelines/SKILL.md +119 -119
- package/lib/assets/.claude/skills/analyzing-architecture/SKILL.md +87 -87
- package/lib/assets/.claude/skills/analyzing-business/SKILL.md +117 -117
- package/lib/assets/.claude/skills/analyzing-data-model/SKILL.md +80 -80
- package/lib/assets/.claude/skills/analyzing-domain-model/SKILL.md +88 -88
- package/lib/assets/.claude/skills/analyzing-inception-deck/SKILL.md +137 -137
- package/lib/assets/.claude/skills/analyzing-non-functional/SKILL.md +91 -91
- package/lib/assets/.claude/skills/analyzing-operation/SKILL.md +91 -91
- package/lib/assets/.claude/skills/analyzing-requirements/SKILL.md +89 -87
- package/lib/assets/.claude/skills/analyzing-tech-stack/SKILL.md +102 -102
- package/lib/assets/.claude/skills/analyzing-test-strategy/SKILL.md +87 -87
- package/lib/assets/.claude/skills/analyzing-ui-design/SKILL.md +86 -86
- package/lib/assets/.claude/skills/analyzing-usecases/SKILL.md +87 -87
- package/lib/assets/.claude/skills/creating-adr/SKILL.md +115 -115
- package/lib/assets/.claude/skills/developing-backend/SKILL.md +106 -106
- package/lib/assets/.claude/skills/developing-frontend/SKILL.md +96 -96
- package/lib/assets/.claude/skills/developing-release/SKILL.md +154 -154
- package/lib/assets/.claude/skills/generating-slides/SKILL.md +136 -136
- package/lib/assets/.claude/skills/git-commit/SKILL.md +106 -106
- package/lib/assets/.claude/skills/killing-processes/SKILL.md +98 -98
- package/lib/assets/.claude/skills/managing-docs/SKILL.md +200 -200
- package/lib/assets/.claude/skills/managing-operations/DEPLOY.md +77 -77
- package/lib/assets/.claude/skills/managing-operations/SETUP_CSHARP.md +80 -80
- package/lib/assets/.claude/skills/managing-operations/SETUP_FRONTEND.md +84 -84
- package/lib/assets/.claude/skills/managing-operations/SETUP_JAVA.md +75 -75
- package/lib/assets/.claude/skills/managing-operations/SKILL.md +156 -156
- package/lib/assets/.claude/skills/orchestrating-analysis/SKILL.md +134 -134
- package/lib/assets/.claude/skills/orchestrating-development/SKILL.md +243 -243
- package/lib/assets/.claude/skills/orchestrating-project/SKILL.md +193 -193
- package/lib/assets/.claude/skills/planning-releases/SKILL.md +222 -222
- package/lib/assets/.claude/skills/tracking-progress/SKILL.md +164 -164
- package/lib/assets/.devcontainer/devcontainer.json +34 -34
- package/lib/assets/.env.example +17 -17
- package/lib/assets/.gitattributes +4 -4
- package/lib/assets/.github/workflows/docker-publish.yml +77 -77
- package/lib/assets/.github/workflows/mkdocs.yml +39 -39
- package/lib/assets/AGENTS.md +94 -94
- package/lib/assets/CLAUDE.md +162 -162
- package/lib/assets/README.md +285 -269
- package/lib/assets/docker-compose.yml +33 -33
- package/lib/assets/docs/assets/css/extra.css +29 -29
- package/lib/assets/docs/assets/js/extra.js +44 -44
- package/lib/assets/docs/index.md +14 -14
- package/lib/assets/docs/reference/CodexCLIMCP/343/202/242/343/203/227/343/203/252/343/202/261/343/203/274/343/202/267/343/203/247/343/203/263/351/226/213/347/231/272/343/203/225/343/203/255/343/203/274.md +532 -532
- package/lib/assets/docs/reference/CodexCLIMCP/343/202/265/343/203/274/343/203/220/343/203/274/350/250/255/345/256/232/346/211/213/351/240/206.md +341 -341
- package/lib/assets/docs/reference/Java/343/202/242/343/203/227/343/203/252/343/202/261/343/203/274/343/202/267/343/203/247/343/203/263/347/222/260/345/242/203/346/247/213/347/257/211/343/202/254/343/202/244/343/203/211.md +578 -578
- package/lib/assets/docs/reference/TypeScript/343/202/242/343/203/227/343/203/252/343/202/261/343/203/274/343/202/267/343/203/247/343/203/263/347/222/260/345/242/203/346/247/213/347/257/211/343/202/254/343/202/244/343/203/211.md +465 -465
- package/lib/assets/docs/reference/UI/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +448 -448
- package/lib/assets/docs/reference//343/202/210/343/201/204/343/202/275/343/203/225/343/203/210/343/202/246/343/202/247/343/202/242/343/201/250/343/201/257.md +242 -242
- package/lib/assets/docs/reference//343/202/242/343/203/274/343/202/255/343/203/206/343/202/257/343/203/201/343/203/243/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +2216 -2216
- package/lib/assets/docs/reference//343/202/244/343/203/263/343/203/225/343/203/251/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +1878 -1878
- package/lib/assets/docs/reference//343/202/250/343/202/257/343/202/271/343/203/210/343/203/252/343/203/274/343/203/240/343/203/227/343/203/255/343/202/260/343/203/251/343/203/237/343/203/263/343/202/260.md +554 -554
- package/lib/assets/docs/reference//343/202/263/343/203/274/343/203/207/343/202/243/343/203/263/343/202/260/343/201/250/343/203/206/343/202/271/343/203/210/343/202/254/343/202/244/343/203/211.md +705 -705
- package/lib/assets/docs/reference//343/203/206/343/202/271/343/203/210/346/210/246/347/225/245/343/202/254/343/202/244/343/203/211.md +1313 -1313
- package/lib/assets/docs/reference//343/203/207/343/203/274/343/202/277/343/203/242/343/203/207/343/203/253/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +311 -311
- package/lib/assets/docs/reference//343/203/211/343/203/241/343/202/244/343/203/263/343/203/242/343/203/207/343/203/253/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +599 -599
- package/lib/assets/docs/reference//343/203/223/343/202/270/343/203/215/343/202/271/343/202/242/343/203/274/343/202/255/343/203/206/343/202/257/343/203/201/343/203/243/345/210/206/346/236/220/343/202/254/343/202/244/343/203/211.md +528 -528
- package/lib/assets/docs/reference//343/203/246/343/203/274/343/202/271/343/202/261/343/203/274/343/202/271/344/275/234/346/210/220/343/202/254/343/202/244/343/203/211.md +682 -682
- package/lib/assets/docs/reference//343/203/252/343/203/252/343/203/274/343/202/271/343/202/254/343/202/244/343/203/211.md +442 -442
- package/lib/assets/docs/reference//343/203/252/343/203/252/343/203/274/343/202/271/343/203/273/343/202/244/343/203/206/343/203/254/343/203/274/343/202/267/343/203/247/343/203/263/350/250/210/347/224/273/343/202/254/343/202/244/343/203/211.md +558 -558
- package/lib/assets/docs/reference//347/222/260/345/242/203/345/244/211/346/225/260/347/256/241/347/220/206/343/202/254/343/202/244/343/203/211.md +663 -663
- package/lib/assets/docs/reference//350/246/201/344/273/266/345/256/232/347/276/251/343/202/254/343/202/244/343/203/211.md +1248 -1248
- package/lib/assets/docs/reference//351/201/213/347/224/250/350/246/201/344/273/266/345/256/232/347/276/251/343/202/254/343/202/244/343/203/211.md +392 -392
- package/lib/assets/docs/reference//351/226/213/347/231/272/343/202/254/343/202/244/343/203/211.md +235 -235
- package/lib/assets/docs/reference//351/235/236/346/251/237/350/203/275/350/246/201/344/273/266/345/256/232/347/276/251/343/202/254/343/202/244/343/203/211.md +1236 -1236
- package/lib/assets/docs/template/ADR.md +30 -30
- package/lib/assets/docs/template/README.md +50 -50
- package/lib/assets/docs/template//343/201/276/343/201/232/343/201/223/343/202/214/343/202/222/350/252/255/343/202/202/343/201/206/343/203/252/343/202/271/343/203/210.md +12 -12
- package/lib/assets/docs/template//343/202/244/343/203/206/343/203/254/343/203/274/343/202/267/343/203/247/343/203/263/345/256/214/344/272/206/345/240/261/345/221/212/346/233/270.md +58 -58
- package/lib/assets/docs/template//343/202/244/343/203/263/343/202/273/343/203/227/343/202/267/343/203/247/343/203/263/343/203/207/343/203/203/343/202/255.md +13 -13
- package/lib/assets/docs/template//343/203/223/343/202/270/343/203/215/343/202/271/343/202/242/343/203/274/343/202/255/343/203/206/343/202/257/343/203/201/343/203/243.md +379 -379
- package/lib/assets/docs/template//345/256/214/345/205/250/345/275/242/345/274/217/343/201/256/343/203/246/343/203/274/343/202/271/343/202/261/343/203/274/343/202/271.md +68 -68
- package/lib/assets/docs/template//350/246/201/344/273/266/345/256/232/347/276/251.md +669 -669
- package/lib/assets/docs/template//350/250/255/350/250/210.md +163 -163
- package/lib/assets/gulpfile.js +23 -23
- package/lib/assets/mkdocs.yml +65 -65
- package/lib/assets/ops/docker/mkdoc/Dockerfile +19 -19
- package/lib/assets/ops/scripts/journal.js +180 -180
- package/lib/assets/ops/scripts/mkdocs.js +82 -82
- package/lib/assets/ops/scripts/release.js +431 -431
- package/lib/assets/ops/scripts/ssh.js +190 -190
- package/lib/assets/ops/scripts/vault.js +299 -299
- package/lib/assets/package-lock.json +1653 -1653
- package/lib/assets/package.json +40 -40
- package/lib/gulpfile.js +37 -37
- package/package.json +41 -41
package/lib/assets/README.md
CHANGED
|
@@ -1,269 +1,285 @@
|
|
|
1
|
-
# {project-name}
|
|
2
|
-
|
|
3
|
-
## 概要
|
|
4
|
-
|
|
5
|
-
### 目的
|
|
6
|
-
|
|
7
|
-
### 前提
|
|
8
|
-
|
|
9
|
-
| ソフトウェア | バージョン | 備考 |
|
|
10
|
-
| :----------- | :--------- | :--- |
|
|
11
|
-
| nodejs | 22.x | |
|
|
12
|
-
|
|
13
|
-
## 構成
|
|
14
|
-
|
|
15
|
-
- [構築](#構築)
|
|
16
|
-
- [配置](#配置)
|
|
17
|
-
- [運用](#運用)
|
|
18
|
-
- [開発](#開発)
|
|
19
|
-
|
|
20
|
-
## 詳細
|
|
21
|
-
|
|
22
|
-
### Quick Start
|
|
23
|
-
|
|
24
|
-
```bash
|
|
25
|
-
npm install
|
|
26
|
-
npm start
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
### 構築
|
|
30
|
-
|
|
31
|
-
```bash
|
|
32
|
-
claude mcp add -s project memory -- npx @modelcontextprotocol/server-memory
|
|
33
|
-
claude mcp add -s project codex -- npx @openai/codex mcp-server
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
####
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
|
59
|
-
| |
|
|
60
|
-
| | `
|
|
61
|
-
|
|
|
62
|
-
| | `
|
|
63
|
-
| | `
|
|
64
|
-
|
|
|
65
|
-
| | `
|
|
66
|
-
|
|
|
67
|
-
| | `
|
|
68
|
-
| | `
|
|
69
|
-
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
```
|
|
148
|
-
|
|
149
|
-
```
|
|
150
|
-
|
|
151
|
-
```
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
```
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
```
|
|
168
|
-
npx gulp
|
|
169
|
-
```
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
#
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
```
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
```
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
1
|
+
# {project-name}
|
|
2
|
+
|
|
3
|
+
## 概要
|
|
4
|
+
|
|
5
|
+
### 目的
|
|
6
|
+
|
|
7
|
+
### 前提
|
|
8
|
+
|
|
9
|
+
| ソフトウェア | バージョン | 備考 |
|
|
10
|
+
| :----------- | :--------- | :--- |
|
|
11
|
+
| nodejs | 22.x | |
|
|
12
|
+
|
|
13
|
+
## 構成
|
|
14
|
+
|
|
15
|
+
- [構築](#構築)
|
|
16
|
+
- [配置](#配置)
|
|
17
|
+
- [運用](#運用)
|
|
18
|
+
- [開発](#開発)
|
|
19
|
+
|
|
20
|
+
## 詳細
|
|
21
|
+
|
|
22
|
+
### Quick Start
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npm install
|
|
26
|
+
npm start
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### 構築
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
claude mcp add -s project memory -- npx @modelcontextprotocol/server-memory
|
|
33
|
+
claude mcp add -s project codex -- npx @openai/codex mcp-server
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
#### ralph-loopの導入
|
|
37
|
+
|
|
38
|
+
- Claude Code 起動後、/plugin を実行
|
|
39
|
+
|
|
40
|
+
- 検索ボックスで ralph-loop を探して選択
|
|
41
|
+
|
|
42
|
+
- インストールするスコープを選ぶ(ユーザー / プロジェクト / ローカル)
|
|
43
|
+
|
|
44
|
+
- Claude Code を再起動
|
|
45
|
+
|
|
46
|
+
- コマンドで実行
|
|
47
|
+
|
|
48
|
+
```powershell
|
|
49
|
+
/ralph-loop "<プロンプト>" --max-iterations <数値> --completion-promise "<完了テキスト>"
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
#### AI アシスタント(Skills)
|
|
53
|
+
|
|
54
|
+
`.claude/skills/` ディレクトリに定義された Skills により、AI アシスタントがタスクに応じた専門的な指示を自動的に読み込みます。Progressive Disclosure(段階的開示)により、必要なスキルのみがコンテキストに展開されます。
|
|
55
|
+
|
|
56
|
+
##### Skills 一覧
|
|
57
|
+
|
|
58
|
+
| カテゴリ | スキル | 説明 |
|
|
59
|
+
| :--- | :--- | :--- |
|
|
60
|
+
| **オーケストレーション** | `orchestrating-analysis` | 分析フェーズ全体のワークフロー案内 |
|
|
61
|
+
| | `orchestrating-development` | 開発フェーズ全体の TDD ワークフロー案内 |
|
|
62
|
+
| | `orchestrating-project` | 計画・進捗管理フェーズ全体のワークフロー案内 |
|
|
63
|
+
| **分析** | `analyzing-business` | ビジネスアーキテクチャ分析 |
|
|
64
|
+
| | `analyzing-requirements` | RDRA 2.0 に基づく要件定義 |
|
|
65
|
+
| | `analyzing-usecases` | ユースケース・ユーザーストーリー作成 |
|
|
66
|
+
| | `analyzing-architecture` | アーキテクチャ設計 |
|
|
67
|
+
| | `analyzing-data-model` | データモデル設計 |
|
|
68
|
+
| | `analyzing-domain-model` | ドメインモデル設計 |
|
|
69
|
+
| | `analyzing-ui-design` | UI 設計 |
|
|
70
|
+
| | `analyzing-tech-stack` | 技術スタック選定 |
|
|
71
|
+
| | `analyzing-test-strategy` | テスト戦略策定 |
|
|
72
|
+
| | `analyzing-non-functional` | 非機能要件定義 |
|
|
73
|
+
| | `analyzing-operation` | 運用要件定義 |
|
|
74
|
+
| **開発** | `developing-backend` | バックエンド TDD(インサイドアウト) |
|
|
75
|
+
| | `developing-frontend` | フロントエンド TDD(アウトサイドイン) |
|
|
76
|
+
| | `developing-release` | リリースワークフロー(品質ゲート・バージョン管理・CHANGELOG) |
|
|
77
|
+
| **計画・進捗** | `planning-releases` | リリース・イテレーション計画 |
|
|
78
|
+
| | `syncing-github-project` | GitHub Project 同期 |
|
|
79
|
+
| | `tracking-progress` | 進捗分析・レポート生成 |
|
|
80
|
+
| **運用** | `managing-operations` | 環境構築・デプロイ・監視 |
|
|
81
|
+
| | `killing-processes` | 開発プロセス強制終了 |
|
|
82
|
+
| **ドキュメント・Git** | `managing-docs` | ドキュメント管理・Lint |
|
|
83
|
+
| | `git-commit` | Conventional Commits 準拠のコミット |
|
|
84
|
+
| | `creating-adr` | ADR 作成 |
|
|
85
|
+
| **共通** | `ai-agent-guidelines` | AI Agent 実行ガイドライン |
|
|
86
|
+
|
|
87
|
+
##### カスタマイズ
|
|
88
|
+
|
|
89
|
+
新しいスキルを追加するには、`.claude/skills/<skill-name>/SKILL.md` を作成します。テンプレートは `.claude/SKILLS_TEMPLATE.md` を参照してください。
|
|
90
|
+
|
|
91
|
+
**[⬆ back to top](#構成)**
|
|
92
|
+
|
|
93
|
+
### 配置
|
|
94
|
+
|
|
95
|
+
#### GitHub Pages セットアップ
|
|
96
|
+
|
|
97
|
+
1. **GitHub リポジトリの Settings を開く**
|
|
98
|
+
- リポジトリページで `Settings` タブをクリック
|
|
99
|
+
|
|
100
|
+
2. **Pages 設定を開く**
|
|
101
|
+
- 左サイドバーの `Pages` をクリック
|
|
102
|
+
|
|
103
|
+
3. **Source を設定**
|
|
104
|
+
- `Source` で `Deploy from a branch` を選択
|
|
105
|
+
- `Branch` で `gh-pages` を選択し、フォルダは `/ (root)` を選択
|
|
106
|
+
- `Save` をクリック
|
|
107
|
+
|
|
108
|
+
4. **初回デプロイ**
|
|
109
|
+
- main ブランチにプッシュすると GitHub Actions が自動実行
|
|
110
|
+
- Actions タブでデプロイ状況を確認
|
|
111
|
+
|
|
112
|
+
**[⬆ back to top](#構成)**
|
|
113
|
+
|
|
114
|
+
### 運用
|
|
115
|
+
|
|
116
|
+
#### ドキュメントの編集
|
|
117
|
+
|
|
118
|
+
1. ローカル環境でMkDocsサーバーを起動
|
|
119
|
+
```
|
|
120
|
+
docker-compose up mkdocs
|
|
121
|
+
```
|
|
122
|
+
または、Gulpタスクを使用:
|
|
123
|
+
```
|
|
124
|
+
npm run docs:serve
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
2. ブラウザで http://localhost:8000 にアクセスして編集結果をプレビュー
|
|
128
|
+
|
|
129
|
+
3. `docs/`ディレクトリ内のMarkdownファイルを編集
|
|
130
|
+
|
|
131
|
+
4. 変更をコミットしてプッシュ
|
|
132
|
+
```
|
|
133
|
+
git add .
|
|
134
|
+
git commit -m "ドキュメントの更新"
|
|
135
|
+
git push
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
#### Gulpタスクの使用
|
|
139
|
+
|
|
140
|
+
プロジェクトには以下のGulpタスクが用意されています:
|
|
141
|
+
|
|
142
|
+
##### MkDocsタスク
|
|
143
|
+
|
|
144
|
+
- MkDocsサーバーの起動:
|
|
145
|
+
```
|
|
146
|
+
npm run docs:serve
|
|
147
|
+
```
|
|
148
|
+
または
|
|
149
|
+
```
|
|
150
|
+
npx gulp mkdocs:serve
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
- MkDocsサーバーの停止:
|
|
154
|
+
```
|
|
155
|
+
npm run docs:stop
|
|
156
|
+
```
|
|
157
|
+
または
|
|
158
|
+
```
|
|
159
|
+
npx gulp mkdocs:stop
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
- MkDocsドキュメントのビルド:
|
|
163
|
+
```
|
|
164
|
+
npm run docs:build
|
|
165
|
+
```
|
|
166
|
+
または
|
|
167
|
+
```
|
|
168
|
+
npx gulp mkdocs:build
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
##### 作業履歴(ジャーナル)タスク
|
|
172
|
+
|
|
173
|
+
- すべてのコミット日付の作業履歴を生成:
|
|
174
|
+
```
|
|
175
|
+
npm run journal
|
|
176
|
+
```
|
|
177
|
+
または
|
|
178
|
+
```
|
|
179
|
+
npx gulp journal:generate
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
- 特定の日付の作業履歴を生成:
|
|
183
|
+
```
|
|
184
|
+
npx gulp journal:generate:date --date=YYYY-MM-DD
|
|
185
|
+
```
|
|
186
|
+
(例: `npx gulp journal:generate:date --date=2023-04-01`)
|
|
187
|
+
|
|
188
|
+
生成された作業履歴は `docs/journal/` ディレクトリに保存され、各ファイルには指定された日付のコミット情報が含まれます。
|
|
189
|
+
|
|
190
|
+
#### GitHub Container Registry
|
|
191
|
+
|
|
192
|
+
このプロジェクトでは、GitHub Container Registry(GHCR)を使用して開発コンテナイメージを管理しています。
|
|
193
|
+
|
|
194
|
+
##### 自動ビルド・プッシュ
|
|
195
|
+
|
|
196
|
+
タグをプッシュすると、GitHub Actions が自動的にコンテナイメージをビルドし、GHCR にプッシュします。
|
|
197
|
+
|
|
198
|
+
```bash
|
|
199
|
+
# タグを作成してプッシュ
|
|
200
|
+
git tag 0.0.1
|
|
201
|
+
git push origin 0.0.1
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
##### イメージの取得・実行
|
|
205
|
+
|
|
206
|
+
GHCR からイメージを取得して実行するには:
|
|
207
|
+
|
|
208
|
+
```bash
|
|
209
|
+
# イメージをプル
|
|
210
|
+
docker pull ghcr.io/k2works/{project_name}:latest
|
|
211
|
+
|
|
212
|
+
# または特定バージョン
|
|
213
|
+
docker pull ghcr.io/k2works/{project_name}:0.0.1
|
|
214
|
+
|
|
215
|
+
# コンテナを実行
|
|
216
|
+
docker run -it -v $(pwd):/srv ghcr.io/k2works/{project_name}:latest
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
または、docker-compose を使用してローカルでビルド・実行することもできます:
|
|
220
|
+
|
|
221
|
+
```bash
|
|
222
|
+
# 開発環境を起動して中に入る
|
|
223
|
+
docker-compose run --rm dev bash
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
認証が必要な場合は、以下のコマンドでログインします:
|
|
227
|
+
|
|
228
|
+
```bash
|
|
229
|
+
# GitHub Personal Access Token でログイン
|
|
230
|
+
echo $GITHUB_TOKEN | docker login ghcr.io -u <username> --password-stdin
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
##### 権限設定
|
|
234
|
+
|
|
235
|
+
- リポジトリの Settings → Actions → General で `Read and write permissions` を設定
|
|
236
|
+
- `GITHUB_TOKEN` に `packages: write` 権限が付与されています
|
|
237
|
+
|
|
238
|
+
##### Dev Container の使用
|
|
239
|
+
|
|
240
|
+
VS Code で Dev Container を使用する場合:
|
|
241
|
+
|
|
242
|
+
1. VS Code で「Dev Containers: Reopen in Container」を実行
|
|
243
|
+
2. または「Dev Containers: Rebuild and Reopen in Container」で再ビルド
|
|
244
|
+
|
|
245
|
+
**[⬆ back to top](#構成)**
|
|
246
|
+
|
|
247
|
+
### 開発
|
|
248
|
+
|
|
249
|
+
#### Nix による開発環境
|
|
250
|
+
|
|
251
|
+
Nix を使用して、再現可能な開発環境を構築できます。
|
|
252
|
+
|
|
253
|
+
##### 準備
|
|
254
|
+
|
|
255
|
+
1. [Nix をインストール](https://nixos.org/download.html)します。
|
|
256
|
+
2. Flakes を有効にします(`~/.config/nix/nix.conf` に `experimental-features = nix-command flakes` を追加)。
|
|
257
|
+
|
|
258
|
+
##### 環境の利用
|
|
259
|
+
|
|
260
|
+
- **デフォルト環境(共通ツール)に入る:**
|
|
261
|
+
```bash
|
|
262
|
+
nix develop
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
- **Node.js 環境に入る:**
|
|
266
|
+
```bash
|
|
267
|
+
nix develop .#node
|
|
268
|
+
```
|
|
269
|
+
|
|
270
|
+
- **Python/MkDocs 環境に入る:**
|
|
271
|
+
```bash
|
|
272
|
+
nix develop .#python
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
環境から抜けるには `exit` を入力します。
|
|
276
|
+
|
|
277
|
+
##### 依存関係の更新
|
|
278
|
+
|
|
279
|
+
```bash
|
|
280
|
+
nix flake update
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
**[⬆ back to top](#構成)**
|
|
284
|
+
|
|
285
|
+
## 参照
|
|
@@ -1,33 +1,33 @@
|
|
|
1
|
-
services:
|
|
2
|
-
dev:
|
|
3
|
-
build:
|
|
4
|
-
context: .
|
|
5
|
-
dockerfile: Dockerfile
|
|
6
|
-
args:
|
|
7
|
-
NODE_MAJOR: 22
|
|
8
|
-
volumes:
|
|
9
|
-
- .:/srv
|
|
10
|
-
tty: true
|
|
11
|
-
stdin_open: true
|
|
12
|
-
|
|
13
|
-
mkdocs:
|
|
14
|
-
build:
|
|
15
|
-
context: .
|
|
16
|
-
dockerfile: ./ops/docker/mkdoc/Dockerfile
|
|
17
|
-
environment:
|
|
18
|
-
PLANTUML_SERVER_URL: http://plantuml:8080/plantuml
|
|
19
|
-
volumes:
|
|
20
|
-
- ./docs:/docs/docs
|
|
21
|
-
- ./README.md:/docs/README.md
|
|
22
|
-
- ./mkdocs.yml:/docs/mkdocs.yml
|
|
23
|
-
- ./site:/docs/site
|
|
24
|
-
ports:
|
|
25
|
-
- "8000:8000"
|
|
26
|
-
command: mkdocs serve --dev-addr=0.0.0.0:8000 --livereload
|
|
27
|
-
links:
|
|
28
|
-
- plantuml
|
|
29
|
-
|
|
30
|
-
plantuml:
|
|
31
|
-
image: plantuml/plantuml-server:jetty
|
|
32
|
-
environment:
|
|
33
|
-
BASE_URL: plantuml
|
|
1
|
+
services:
|
|
2
|
+
dev:
|
|
3
|
+
build:
|
|
4
|
+
context: .
|
|
5
|
+
dockerfile: Dockerfile
|
|
6
|
+
args:
|
|
7
|
+
NODE_MAJOR: 22
|
|
8
|
+
volumes:
|
|
9
|
+
- .:/srv
|
|
10
|
+
tty: true
|
|
11
|
+
stdin_open: true
|
|
12
|
+
|
|
13
|
+
mkdocs:
|
|
14
|
+
build:
|
|
15
|
+
context: .
|
|
16
|
+
dockerfile: ./ops/docker/mkdoc/Dockerfile
|
|
17
|
+
environment:
|
|
18
|
+
PLANTUML_SERVER_URL: http://plantuml:8080/plantuml
|
|
19
|
+
volumes:
|
|
20
|
+
- ./docs:/docs/docs
|
|
21
|
+
- ./README.md:/docs/README.md
|
|
22
|
+
- ./mkdocs.yml:/docs/mkdocs.yml
|
|
23
|
+
- ./site:/docs/site
|
|
24
|
+
ports:
|
|
25
|
+
- "8000:8000"
|
|
26
|
+
command: mkdocs serve --dev-addr=0.0.0.0:8000 --livereload
|
|
27
|
+
links:
|
|
28
|
+
- plantuml
|
|
29
|
+
|
|
30
|
+
plantuml:
|
|
31
|
+
image: plantuml/plantuml-server:jetty
|
|
32
|
+
environment:
|
|
33
|
+
BASE_URL: plantuml
|