始め方

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

前提条件

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

1. トークンの発行

コード管理では、CLIやCI/CDからベースマキナのAPIにアクセスするためのトークンが必要です。

トークンはプロジェクトごとに発行します。

1. 企業アカウントの設定画面を開きます。
2. プロジェクト一覧から、コード管理するプロジェクトを選択します。
3. トークンを発行します。

トークンには有効期限はありません。トークンを再発行すると、古いトークンは無効になります。

トークンで認証された操作は、プロジェクトごとに自動作成されるサービスアカウントとして実行されます。サービスアカウントはプロジェクト管理者の権限を持ち、アクションの作成・更新などの操作が可能です。サービスアカウントはベースマキナの画面上には表示されず、課金の対象にもなりません。

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

トークン発行と同じ画面から、プロジェクトの設定ファイル一式をダウンロードできます。

ダウンロードされるファイルには、以下が含まれます。

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

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

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

4. GitHub Secretsの設定

CI/CDでCLIを実行するために、発行したトークンをGitHubリポジトリのSecretsに設定します。

1. GitHubリポジトリのSettingsからSecrets and variables、Actionsを開きます。
2. 「New repository secret」でトークンを登録します。

5. 初回の反映

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

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

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