始め方

コード管理を始めるための手順を説明します。

前提条件

• 開発環境が設定済みであること
• 企業アカウントの管理者の権限を持っていること

1. コード管理の開始とOIDC信頼ポリシーの設定

コード管理でのCLIやCI/CDからの認証は、OIDC信頼ポリシーを使用します。OIDC信頼ポリシーは、GitHub Actionsなどの外部サービスが発行したOIDC ID Tokenを、ベースマキナのサービスアカウントと紐づけるためのポリシーです。

1. 右上のメニューから「設定」を選択します。
2. サイドバーのメニューから「開発設定」を選択します。
3. 「コード管理」セクションの「コード管理を開始する」ボタンをクリックします。これにより、コード管理用のサービスアカウントがプロジェクトに自動作成されます。
4. サービスアカウント作成後に表示される「OIDC信頼ポリシー」のフォームから、「ポリシーを追加」→「GitHub Actions」または「カスタム」を選択して、ポリシーを追加します。

サービスアカウントはプロジェクト管理者の権限を持ち、アクションの作成・更新などの操作が可能です。サービスアカウントはベースマキナの画面上のユーザー一覧には表示されず、課金の対象にもなりません。

OIDC信頼ポリシーの設定項目

GitHub Actionsから利用する場合は、「ポリシーを追加」ドロップダウンリストで「GitHub Actions」を選択すると、Issuerなどがあらかじめ入力された状態でポリシーを追加できます。Bound Claimsには、例えばkey: sub、pattern: repo:<org>/<repo>:ref:refs/heads/mainのように、受け付けるブランチ・リポジトリの条件を指定します。

2. プロジェクトのダウンロード

「開発設定」画面の「コード管理」セクション上部にある「設定のダウンロード」ボタンをクリックすると、プロジェクトの設定ファイル一式（oac-project.zip）をダウンロードできます。

ダウンロードされるファイルの構成は、設定ファイルをご参照ください。

3. リポジトリの作成とセットアップ

ダウンロードしたファイルをGitリポジトリとして管理します。

# リポジトリを作成
git init
git remote add origin <リモートリポジトリのURL>
 
# 依存関係をインストール
npm install
 
# 初回コミットとプッシュ
git add .
git commit -m "Initial commit"
git push -u origin main

4. CI/CDからの認証の準備

CI/CDからCLIを実行する際は、CI/CDが発行したOIDC ID Tokenを環境変数 BM_OIDC_TOKEN に設定します。

GitHub Actionsの場合は、ワークフローでid-token: writeのパーミッションを付与します。actions/github-scriptなどからcore.getIDToken()で取得したトークンをBM_OIDC_TOKENに設定します。

具体的なワークフローの書き方は、CI/CDの設定と運用例をご参照ください。

5. 初回の反映

セットアップが完了したら、PRを作成してコード管理を開始します。

1. PRを作成すると、CIでbm sync --dryが実行され、設定の差分がPRにコメントされます。
2. 初回は各アクションの管理方法が「Web管理」から「コード管理」に移行する差分が表示されます。
3. PRをマージすると、bm syncが実行されて管理方法が更新されます。

これで、以降はコード管理の運用に沿って開発を進められます。詳しくは運用例をご参照ください。