コード管理とは
⚠️
この機能は現在開発中であり、まだ公開されていません。記載内容は今後変更される可能性があります。
コード管理は、ベースマキナのアクションやビューの設定をTypeScriptのコードとしてGitリポジトリで管理できる機能です。
設定内容をコードとして管理することで、以下のメリットがあります。
- コードレビュー: 設定変更をPull Requestでレビューできる
- 差分検出: 設定変更の差分をCI上で自動検出し、PRにコメントとして表示できる
- 環境別デプロイ: 開発環境から検証環境、本番環境へ段階的にデプロイできる
- 型安全な設定: TypeScriptの型システムにより、設定ミスをコードの記述時に検出できる
- 変更履歴: Gitの履歴で設定変更の経緯を追跡できる
対応する管理対象
現在、以下のアクション種別のコード管理に対応しています。
- gRPCアクション
- JavaScriptアクション
今後、対応するアクション種別は拡大予定です。
全体像
コード管理では、以下のツールを使用します。
| ツール | 説明 |
|---|---|
@basemachina/sdk | アクションやビューの設定をTypeScriptで記述するためのSDK |
@basemachina/cli | 設定の差分検出や反映を行なうCLIツール |
設定はTypeScriptファイル（basemachina.config.ts）に記述し、CLIコマンドを使って設定の差分検出（bm push）や環境間のデプロイ（bm deploy）を行ないます。GitHub Actionsと組み合わせることで、PRのマージをトリガーに自動で設定を反映できます。