バージョン管理
バージョン管理
Agentriaのアビリティ・エージェントは、デプロイバージョン(Version)単位で変更履歴を管理します。ワークフローをAPIとしてデプロイするには、まずこのデプロイバージョンを作成する必要があるため、バージョン管理はAPIデプロイのための必須の事前準備でもあります。
バージョン管理がしっかりできていると、次のようなメリットがあります。
変更履歴を明確に追跡できます。
共同作業時にチームメンバー間の混乱を減らせます。
問題が発生した際に、安定した以前のバージョンに戻せます。
ユーザーに信頼性の高いアップデートを提供できます。
このガイドでは、バージョン番号を上げる基準、実際にバージョンを作成する方法、バージョン履歴を確認する方法、以前のバージョンにロールバックする方法をご案内します。
バージョン管理の基準
Agentriaのプロジェクトは、セマンティックバージョニング(Semantic Versioning)に従います。(参考:🔗semver.org)
バージョン番号はメジャーバージョン(Major).マイナーバージョン(Minor).パッチバージョン(Patch)の形式で構成され、それぞれ以下の基準に従って上げます。
区分 | 上げる基準 | 例 |
|---|---|---|
メジャーバージョン(Major) | 後方互換性が崩れる変更がある場合 | API応答形式が変わる、既存機能が削除されるなど |
マイナーバージョン(Minor) | 後方互換性を保ちながら新機能が追加される場合 | 既存APIに新しいパラメーターが追加される、オプション機能ができるなど |
パッチバージョン(Patch) | バグ修正・セキュリティパッチ・パフォーマンス最適化など小さな変更がある場合 | 誤った計算ロジックの修正、UIエラーの解消など |
例えば、次のようにバージョンが上がります。
1.4.2→1.4.3(バグ修正)1.4.2→1.5.0(機能追加)1.4.2→2.0.0(後方互換性が崩れる変更)
ステップ1:バージョンの作成
キャンバス右上のバージョン(Version)ボタンをクリックし、+アイコン(バージョン保存、Create Version)をクリックします。
バージョン作成ポップアップ
ポップアップでデプロイバージョンを作成します。上記のバージョン管理の基準に従ってバージョン番号と説明を入力し、作成(Create)ボタンをクリックします。
ステップ2:バージョン履歴の確認
作成した各バージョンは履歴(History)タブで確認できます。
ステップ3:ロールバック(Rollback)
履歴でバージョンを選択すると、そのバージョン時点のノード構成を一目で確認できます。このバージョンにロールバック(Rollback to this version)ボタンをクリックすると、そのバージョンに戻ります。
現在作業中の内容についてバージョンを作成しないままロールバックすると、作業中だったすべての変更内容とテスト履歴が消え、元に戻せません。ロールバックする前に、必ず現在の状態のバージョンを先に作成しておいてください。
次のステップ
バージョンの作成が終わったら、このバージョンをAPIとしてデプロイできます。
🔗APIデプロイガイド — 作成したバージョンをAPIサービスとしてデプロイする方法をご確認ください。
よくある質問
バージョンはいつ新しく作成すればいいですか?
ワークフローのノード構成やロジックを変更した後、その時点の状態をAPIとしてデプロイしたい場合や、後で戻れる地点として残しておきたい場合に新しいバージョンを作成します。特にロールバックする前には、必ず現在の状態のバージョンを先に作成しておくことで、作業内容を失わずに済みます。
メジャー・マイナー・パッチのどれを上げればいいか迷ったらどうすればいいですか?
まず、変更内容が既存ユーザーのワークフローやAPI呼び出しを壊すかどうかを確認します。壊す場合はメジャーバージョンを、機能が追加されるだけで既存の動作はそのままの場合はマイナーバージョンを、動作方法はそのままでバグだけを修正した場合はパッチバージョンを上げます。
ロールバックすると何が消えますか?
ロールバック時点以降、つまり最後に作成したバージョン以降にキャンバスで変更した内容と、その間のテスト履歴がすべて消え、復元できません。ロールバック前に現在の状態をバージョンとして保存しておくと、この問題を防げます。
バージョンの説明はどのように書けばいいですか?
何がなぜ変わったのか、チームメンバーや未来の自分が一目で分かるように簡潔に書きます。例えば「決済失敗時のリトライロジックを追加」「要約生成プロンプトを改善」のように変更内容を具体的に書くと、履歴で目的のバージョンをすばやく見つけられます。