Skip to content

Commit a4001c1

Browse files
Document CI control patterns: commit tags and API trigger variables
[skip-ci] - Add commit message tag behavior table - Add API trigger variable reference table - Add branching pattern matrix with examples - Note future cleanup of control logic
1 parent 7d55e50 commit a4001c1

1 file changed

Lines changed: 51 additions & 5 deletions

File tree

‎README.md‎

Lines changed: 51 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,15 @@ MiyabiC,cross,debug-c,1,1,112,0:10:00
253253
### 実行制御オプション
254254

255255
**コミットメッセージによる制御:**
256+
257+
| タグ | BenchKit | BenchPark | 用途 |
258+
|------|----------|-----------|------|
259+
| (タグなし) | ✅ 実行 | ❌ スキップ | 通常のベンチマーク実行 |
260+
| `[park-only]` | ❌ スキップ | ✅ フル実行 | BenchPark開発・テスト |
261+
| `[park-send]` | ❌ スキップ | ✅ 送信のみ | BenchPark結果再送信 |
262+
| `[benchpark]` | ✅ 実行 | ✅ 実行 | BenchPark設定変更時 |
263+
| `[skip-ci]` | ❌ スキップ | ❌ スキップ | ドキュメント更新等 |
264+
256265
```bash
257266
# 特定システムのみ実行
258267
git commit -m "Fix bug [system:MiyabiG,MiyabiC]"
@@ -263,24 +272,61 @@ git commit -m "Update qws [code:qws,genesis]"
263272
# 組み合わせ可能
264273
git commit -m "Test changes [system:MiyabiG] [code:qws]"
265274

266-
# BenchParkのみ実行
275+
# BenchParkのみ実行(setup/run/convert/send)
267276
git commit -m "Fix BenchPark runner [park-only]"
268277

269-
# BenchPark結果送信のみ
278+
# BenchPark結果送信のみ(convert/send)
270279
git commit -m "Fix result converter [park-send]"
271280

272281
# CI完全スキップ(ドキュメント更新等)
273282
git commit -m "Update docs [skip-ci]"
274283
```
275284

276285
**APIトリガー制御:**
286+
287+
| 変数 | 説明 | 例 |
288+
|------|------|-----|
289+
| `system` | システムフィルタ(BenchKit/BenchPark共通) | `MiyabiG,MiyabiC` |
290+
| `code` | BenchKitプログラムフィルタ | `qws,genesis` |
291+
| `app` | BenchParkアプリフィルタ | `osu-micro-benchmarks` |
292+
| `benchpark` | BenchParkパイプライン有効化 | `true` |
293+
| `park_only` | BenchParkのみ実行(BenchKitスキップ) | `true` |
294+
| `park_send` | BenchPark送信のみ(BenchKitスキップ) | `true` |
295+
296+
分岐パターン:
297+
298+
| 変数指定 | BenchKit | BenchPark | 説明 |
299+
|----------|----------|-----------|------|
300+
| `code=scale-letkf` | ✅ scale-letkfのみ | ❌ スキップ | BenchKit特定コード実行 |
301+
| `park_only=true` | ❌ スキップ | ✅ 全アプリ | BenchParkフル実行 |
302+
| `park_only=true app=osu-micro-benchmarks` | ❌ スキップ | ✅ OSUのみ | BenchPark特定アプリ実行 |
303+
| `park_send=true` | ❌ スキップ | ✅ 全アプリ送信のみ | BenchPark結果再送信 |
304+
| `park_send=true app=osu-micro-benchmarks` | ❌ スキップ | ✅ OSU送信のみ | BenchPark特定アプリ送信 |
305+
| `benchpark=true` | ✅ 全実行 | ✅ 全アプリ | 両方実行 |
306+
| `benchpark=true code=qws app=osu-micro-benchmarks` | ✅ qwsのみ | ✅ OSUのみ | 両方フィルタ付き |
307+
| (変数なし) | ✅ 全実行 | ❌ スキップ | 通常のCI |
308+
309+
> **Note**: `code` のみ指定時にBenchParkが動かないのは、`code` がBenchKit専用のフィルタであるため。BenchParkを動かすには `benchpark=true`、`park_only=true`、`park_send=true` のいずれかを明示的に指定する必要がある。この制御ロジックは将来的に整理予定。
310+
277311
```bash
312+
# BenchKit: 特定コードのみ
278313
curl -X POST --fail \
279-
-F token=$TOKEN \
280-
-F ref=main \
281-
-F "variables[system]=MiyabiG,MiyabiC" \
314+
-F token=$TOKEN -F ref=main \
282315
-F "variables[code]=qws" \
283316
https://gitlab.example.com/api/v4/projects/PROJECT_ID/trigger/pipeline
317+
318+
# BenchPark: OSUのsend-onlyのみ
319+
curl -X POST --fail \
320+
-F token=$TOKEN -F ref=main \
321+
-F "variables[park_send]=true" \
322+
-F "variables[app]=osu-micro-benchmarks" \
323+
https://gitlab.example.com/api/v4/projects/PROJECT_ID/trigger/pipeline
324+
325+
# BenchPark: 全アプリフル実行
326+
curl -X POST --fail \
327+
-F token=$TOKEN -F ref=main \
328+
-F "variables[park_only]=true" \
329+
https://gitlab.example.com/api/v4/projects/PROJECT_ID/trigger/pipeline
284330
```
285331

286332
---

0 commit comments

Comments
 (0)