create-github-action-workflow-specification は何をしますか?
既存のGitHub Actions CI/CDワークフローから、AIによる解析とワークフロー保守に最適化された正式な仕様書を作成します。
概要
このツールは、.github/workflows/ ディレクトリ内の既存のワークフローファイルを解析し、以下の情報を構造化された仕様書として出力します。
- ワークフローの名前と説明(存在する場合)
- トリガーイベントとその条件(
on:セクション) - ジョブ名、ランナー、コンテナイメージ、サービスコンテナ
- 各ステップの名前、実行されるアクションまたはコマンド、条件(
if:など) - 使用される環境変数とシークレット
- ジョブ間の依存関係と並列実行
使用例
# 特定のワークフローファイルを指定
npx create-github-action-workflow-specification .github/workflows/ci.yml
# カレントディレクトリ内のすべてのワークフローを対象
npx create-github-action-workflow-specification .
オプション
| オプション | 説明 | デフォルト値 |
|---|---|---|
--output | 出力先ディレクトリ | .github/workflows/specs |
--format | 出力形式(markdown または yaml) | markdown |
--include-env | 環境変数を含めるか(true/false) | true |
--include-secrets | シークレットを含めるか(true/false) | false |
出力例(Markdown)
# Workflow: CI
## トリガー
- `push`: ブランチ `main`、`develop`
- `pull_request`: すべてのブランチ
## ジョブ: build
- **ランナー**: ubuntu-latest
- **ステップ**:
1. `checkout`: actions/checkout@v4
2. `setup-node`: actions/setup-node@v4(Node.js 18)
3. `install`: `npm ci`
4. `test`: `npm test`
5. `lint`: `npm run lint`
制限事項
- 動的に生成されるアクションや複雑な式は完全に解析できない場合があります。
- 外部アクションの内部実装は仕様に含まれません。
互換性
- GitHub Actions ワークフロー構文 v2 以上に対応。
- テスト済みのプラットフォーム: Claude Code、Cursor、GitHub Codespaces。