Skip to content

カスタムワークフロー

ワークフローは、VJSP向けにステップ・バイ・ステップの手順を定義することで、繰り返し発生するタスクを自動化します。会話中に /[workflow_name.md] と入力するだけで、任意のワークフローを呼び出すことができます。

ワークフローの作成

ワークフローは .vjsp/workflows/ ディレクトリに保存されるMarkdownファイルであり、以下の2つのカテゴリに分類されます:

  • グローバルワークフロー~/.vjsp/workflows/ に配置(すべてのプロジェクトで利用可能)

  • プロジェクト固有のワークフロー[project]/.vjsp/workflows/ に配置(現在のプロジェクトでのみ適用)

基本的な設定手順

  1. ステップ・バイ・ステップの実行手順を含むMarkdownファイルを作成
  2. 上記いずれかのワークフローディレクトリにファイルを保存
  3. チャットで /filename.md と入力して実行をトリガー

ワークフローの機能

ワークフローは以下の機能を統合できます:

よく使われるワークフローテンプレート

バージョンリリース管理

markdown
1. 前回のリリース以降にマージされたプルリクエスト(PR)を要約

2. コミットメッセージに基づいて自動的にチェンジログを生成

3. プロジェクトのバージョン番号を更新

4. リリースブランチを作成し、タグ付け

5. ステージング環境にデプロイ

プロジェクト初期セットアップ

markdown
1. プロジェクトテンプレートリポジトリをクローン

2. プロジェクトの依存関係をインストール(`npm install` または `pip install -r requirements.txt` を実行)

3. 環境変数ファイルを設定

4. データベースおよび関連サービスを初期化

5. 初期テストケースを実行

コードレビュー準備

markdown
1. コミットすべきでない `TODO` コメントやデバッグ用の `console.log` 文がコード内に残っていないかをスキャン

2. 静的解析ツールおよびコードフォーマッタを実行

3. 全テストスイートを実行

4. 最近のコミットに基づいてPR説明文書を自動生成

例:PR提出ワークフロー

以下は、コードレビューからデプロイ通知までの一連のプロセスを自動化するPR提出ワークフローの完全な例です。

.vjsp/workflows ディレクトリ内に submit_pr.md という名前の新しいファイルを作成し、以下の内容を記述します:

markdown
# PR提出ワークフロー

あなたは以下の手順に従って、プルリクエスト(PR)の提出プロセスを支援してください:

1. まず、`search_files` ツールを使用して、コミットすべきでない `TODO` コメントや `console.log` デバッグ文が残っていないかをチェック

2. `execute_command` ツールを使用してテストを実行(例:`npm test` またはプロジェクトに適したテストコマンド)

3. テストが成功した場合、コード変更をステージングし、明確なコミットメッセージとともにコミット

4. ブランチをリモートリポジトリにプッシュし、`gh pr create` コマンドでプルリクエストを作成

5. `ask_followup_question` 関数を使用して、ユーザーにPRのタイトルと説明を依頼

(以下のパラメータがユーザーによって提供されていない場合は、積極的に問い合わせてください)

- 提出するブランチ名  
- 指定されたコードレビュアー

会話中に /submit_pr.md と入力するとこのワークフローがトリガーされ、VJSPは自動的に以下の処理を行います:

  • 提出前に一般的な問題をスキャン
  • 早期に潜在的なバグを検出するために事前にテストスイートを実行
  • Git操作およびPR作成を自動処理
  • チームメンバーへの自動通知を送信
  • 後続のデプロイタスク用のチェックリストを生成

このワークフローにより、手動で行っていた7ステップの提出プロセスが置き換えられ、コードレビューおよび提出の効率が大幅に向上します。