基本（2ブランチ運用）

mainブランチとprdブランチの2つで、開発環境と本番環境を管理する運用例です。

検証環境を使わないシンプルな構成で、小規模なプロジェクトに適しています。

ブランチと環境の対応

ブランチ	ベースマキナの環境	説明
`main`	開発環境	日常的な開発を行なうブランチ
`prd`	本番環境	本番環境用のブランチ

開発環境への変更

1. featureブランチで開発

mainからfeature/xxxブランチを作成し、アクションやビューの設定を編集してPRを作成します。

例えば、「ユーザー一覧ビューのテーブルにユーザーの有効/無効状態を表示する」場合、以下のように変更します。

list-usersアクションのJavaScriptコードを編集して、statusを返すようにする
user-listビューのTSXコードを編集して、テーブルに稼働状態列を追加する
2ファイルを変更したPRを作成する

2. CIで差分を確認

PRが作成されると、CIでbm sync --dryが実行され、設定の差分がPRにコメントされます。開発環境への反映内容なので、コメントのヘッダーは## bm sync 実行後、以下の変更が適用されますです。

3. マージして開発環境に反映

PRをマージすると、CDでbm syncが実行され、アクションの変更がベースマキナの開発環境に反映されます。新しいバージョンが作成され、開発環境では常に最新バージョンが使用されるため即時反映されます。設定ファイルから削除されたアクションは、--with-disable指定時のみ開発環境で無効化されます。

ビューのコードを同じリポジトリで管理している場合は、ワークフローにビューのビルド・アップロード処理を追加します。詳細はコード取得設定との連携をご参照ください。レビュー設定やデータソースなど、コード管理対象外の設定は引き続きベースマキナの画面から設定してください。

本番環境への変更

開発環境で確認が取れたら、本番環境に同期します。

本番環境への変更は、mainブランチをprdブランチへ取り込む昇格PRとして作成します。

1. PRの作成

prdブランチにmainをマージするPRを作成します。

PR作成時にbm sync --dry <本番環境のID>を実行すると、本番環境への同期内容がPRにコメントされます。環境間の同期内容なので、コメントのヘッダーは## bm sync 実行後、以下の変更が同期されますです。

2. マージして本番環境に同期

PRをマージすると、CDでbm sync <本番環境のID>が実行され、本番環境のすべてのアクションのバージョンと有効化設定が開発環境の状態に合わせて同期されます。

ビューのコードも同じリポジトリで管理している場合は、同じワークフローで本番環境用のストレージへのアップロードも行なえます。詳細はコード取得設定との連携をご参照ください。

コード管理した設定のWeb上での変更

コード管理している設定は、引き続きWeb上（ベースマキナの管理画面）からも変更できます。

Web上で変更すると、そのアクションの管理方法は一時的に「Web管理」に戻ります。次回のbm syncで、設定ファイルに差分があれば「コード管理に移行（変更あり）」として設定を上書きし、差分がなければ「コード管理に移行（変更なし）」として管理方法だけを戻します。

Web UIで新しく作成したアクションを設定ファイルに取り込みたい場合は、ローカルでbm pullを実行し、生成されたファイルを通常のPRに含めてレビューします。

コード管理を開始した後は、設定の変更はコードで行なうことを推奨します。

⚠️

Web上での変更時には、コード管理されている設定であることを示す警告が表示されます。

CI/CDの設定例

トリガー	対象ブランチ	実行内容	説明
PR作成時	`main`	`bm sync --dry`	開発環境への適用差分をPRにコメント
PRマージ時	`main`	`bm sync`	設定の差分を開発環境に反映
PR作成時	`prd`	`bm sync --dry <prd環境ID>`	本番への同期差分をPRにコメント
PRマージ時	`prd`	`bm sync <prd環境ID>`	開発環境のバージョンを本番に同期

GitHub Actionsの設定ファイル例

以下は.github/workflows/に配置するワークフローファイルの例です。公式Composite Action basemachina/bm-action (opens in a new tab)を使い、OIDC認証・bm sync実行・PRコメント投稿を一括で扱います。認証の詳細はCI/CDの設定をご参照ください。

開発環境への反映（`.github/workflows/sync-dev.yml`）

name: Sync to dev
on:
  pull_request:
    branches: [main]
  push:
    branches: [main]
 
permissions:
  contents: read
  id-token: write
  pull-requests: write
  packages: read
 
jobs:
  sync:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: actions/setup-node@v6
        with:
          node-version: "22"
      - run: npm ci
      - run: npx tsc --noEmit
      - uses: basemachina/bm-action@v1
        with:
          audience: "https://basemachina.com"
          with-disable: "true"

dryはデフォルトで"auto"です。pull_requestでは自動的にbm sync --dryが実行されてPRに差分がコメントされ、pushではbm syncが実行されて開発環境に反映されます。開発環境への反映時のPRコメントは以下の変更が適用されます、push時のヘッダーは## bm sync が完了しましたです。

本番環境への同期（`.github/workflows/sync-prd.yml`）

name: Sync to prd
on:
  pull_request:
    branches: [prd]
  push:
    branches: [prd]
 
permissions:
  contents: read
  id-token: write
  pull-requests: write
  packages: read
 
jobs:
  sync:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: actions/setup-node@v6
        with:
          node-version: "22"
      - run: npm ci
      - run: npx tsc --noEmit
      - uses: basemachina/bm-action@v1
        with:
          audience: "https://basemachina.com"
          environment-id: "${{ vars.BM_PRD_ENV_ID }}"

環境IDはGitHub Actionsの変数 (opens in a new tab)などで管理することを推奨します。

本番環境への同期時もdryはデフォルトで"auto"です。pull_requestでは以下の変更が同期されます、pushでは## bm sync が完了しましたというヘッダーで結果が出力されます。

CI/CDの設定 3ブランチ運用