# PrismaのマイグレーションをGitHub Actionsで自動実行する方法

## 目次
1. はじめに
2. GitHub Actionsの概要
   2-1. ワークフローとは？
   2-2. GitHub Actionsの基本構造
3. Prismaを使ったマイグレーションの流れ
   3-1. Prismaとは？
   3-2. マイグレーションの基本的な流れ
4. GitHub ActionsでPrismaマイグレーションを設定する
   4-1. 必要な設定ファイル
   4-2. ワークフローの作成手順
5. .envファイルとSecretsの管理
6. CI/CDでの実際の設定
   6-1. Prismaの自動マイグレーション設定例
   6-2. 成功バッジの確認
7. まとめ

## 1. はじめに

データベースのスキーマを管理する際には、PrismaのようなORMツールを使ってマイグレーションを効率的に行うことが非常に重要です。そこで、本記事では、GitHub Actionsを活用して、Prismaのマイグレーションを自動化する方法を解説します。これにより、デプロイ時の人手を削減し、スムーズな開発体制を実現することが可能となります。

## 2. GitHub Actionsの概要

### 2-1. ワークフローとは？

GitHub Actionsは、リポジトリ上でCI/CDワークフローを自動化するための機能です。ワークフローと呼ばれるアクションの一連の流れを定義することで、テスト、ビルド、デプロイなどを自動化できます。

### 2-2. GitHub Actionsの基本構造

GitHub Actionsでは、`.github/workflows`ディレクトリにYAML形式でワークフローを定義します。各ワークフローでは、イベントトリガーを指定し、ジョブやステップを定義することで、任意のアクションを実行させることができます。

## 3. Prismaを使ったマイグレーションの流れ

### 3-1. Prismaとは？

Prismaは、JavaScriptやTypeScript向けのORM（Object-Relational Mapping）ツールです。Prismaを使うことで、データベーススキーマの定義、マイグレーション、データクエリを型安全に行うことができます。

### 3-2. マイグレーションの基本的な流れ

1. スキーマファイル（`schema.prisma`）の編集。
2. `prisma migrate dev`コマンドでローカルDBにマイグレーション適用。
3. `prisma migrate deploy`コマンドで本番DBにマイグレーション適用。

## 4. GitHub ActionsでPrismaマイグレーションを設定する

### 4-1. 必要な設定ファイル

まず、Prisma CLIを使うために、リポジトリルートの`package.json`にPrismaの依存パッケージを追加します。

![img](/mosaic-code.jpg)

### 4-2. ワークフローの作成手順

次に、`.github/workflows/`ディレクトリにYAMLファイルを作成し、Prismaマイグレーション用のワークフローを定義します。

![img](/mosaic-code.jpg)

## 5. .envファイルとSecretsの管理

GitHub Actionsはセキュリティの観点から、環境変数を暗号化された設定として登録できます。`.env`ファイルの代わりに、GitHubリポジトリのSettingsの「Secrets」に秘密情報を保存し、YAMLファイルでこれを参照します。

![img](/mosaic-code.jpg)

GitHubリポジトリのSettings > Secrets > Actionsから上記の情報を登録しておきましょう。

## 6. CI/CDでの実際の設定

### 6-1. Prismaの自動マイグレーション設定例

上記のワークフローを設定することで、`main`ブランチに変更がプッシュされるたびに、Prismaのマイグレーションが自動でデプロイされます。

### 6-2. 成功バッジの確認

GitHubリポジトリのREADMEに以下のようにバッジを追加することで、ワークフローの状態を視覚的に管理できます。

![img](/mosaic-code.jpg)

## 7. まとめ

PrismaをGitHub Actionsで自動化することで、CI/CDプロセスを効率化できることはお分かりいただけたでしょうか。この仕組みを活用することで、データベーススキーマの変更をよりスムーズに行うだけでなく、プロジェクト全体の開発速度や信頼性が向上します。事前にPrismaスキーマを適切に設計し、セキュアな設定を行うことが成功の鍵となるでしょう。 [cv:issue_marketplace_engineer]

# PrismaのマイグレーションをGitHub Actionsで自動実行する方法

## 目次
1. はじめに
2. GitHub Actionsの概要
   2-1. ワークフローとは？
   2-2. GitHub Actionsの基本構造
3. Prismaを使ったマイグレーションの流れ
   3-1. Prismaとは？
   3-2. マイグレーションの基本的な流れ
4. GitHub ActionsでPrismaマイグレーションを設定する
   4-1. 必要な設定ファイル
   4-2. ワークフローの作成手順
5. .envファイルとSecretsの管理
6. CI/CDでの実際の設定
   6-1. Prismaの自動マイグレーション設定例
   6-2. 成功バッジの確認
7. まとめ

## 1. はじめに

データベースのスキーマを管理する際には、PrismaのようなORMツールを使ってマイグレーションを効率的に行うことが非常に重要です。そこで、本記事では、GitHub Actionsを活用して、Prismaのマイグレーションを自動化する方法を解説します。これにより、デプロイ時の人手を削減し、スムーズな開発体制を実現することが可能となります。

## 2. GitHub Actionsの概要

### 2-1. ワークフローとは？

GitHub Actionsは、リポジトリ上でCI/CDワークフローを自動化するための機能です。ワークフローと呼ばれるアクションの一連の流れを定義することで、テスト、ビルド、デプロイなどを自動化できます。

### 2-2. GitHub Actionsの基本構造

GitHub Actionsでは、`.github/workflows`ディレクトリにYAML形式でワークフローを定義します。各ワークフローでは、イベントトリガーを指定し、ジョブやステップを定義することで、任意のアクションを実行させることができます。

## 3. Prismaを使ったマイグレーションの流れ

### 3-1. Prismaとは？

Prismaは、JavaScriptやTypeScript向けのORM（Object-Relational Mapping）ツールです。Prismaを使うことで、データベーススキーマの定義、マイグレーション、データクエリを型安全に行うことができます。

### 3-2. マイグレーションの基本的な流れ

1. スキーマファイル（`schema.prisma`）の編集。
2. `prisma migrate dev`コマンドでローカルDBにマイグレーション適用。
3. `prisma migrate deploy`コマンドで本番DBにマイグレーション適用。

## 4. GitHub ActionsでPrismaマイグレーションを設定する

### 4-1. 必要な設定ファイル

まず、Prisma CLIを使うために、リポジトリルートの`package.json`にPrismaの依存パッケージを追加します。

```json
{
  "scripts": {
    "migrate": "prisma migrate deploy"
  },
  "dependencies": {
    "prisma": "^4.0.0",
    "@prisma/client": "^4.0.0"
  }
}
```

### 4-2. ワークフローの作成手順

次に、`.github/workflows/`ディレクトリにYAMLファイルを作成し、Prismaマイグレーション用のワークフローを定義します。

```yaml
name: Prisma Migrate
on:
  push:
    branches:
      - main
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: チェックアウト
        uses: actions/checkout@v2

      - name: Node.js セットアップ
        uses: actions/setup-node@v2
        with:
          node-version: '16'

      - name: 依存関係をインストール
        run: npm install

      - name: マイグレーション実行
        run: npm run migrate
        env:
          DATABASE_URL: ${{ secrets.DATABASE_URL }}
```

## 5. .envファイルとSecretsの管理

GitHub Actionsはセキュリティの観点から、環境変数を暗号化された設定として登録できます。`.env`ファイルの代わりに、GitHubリポジトリのSettingsの「Secrets」に秘密情報を保存し、YAMLファイルでこれを参照します。

```plaintext
# DATABASE_URL=<データベース接続情報>
```

GitHubリポジトリのSettings > Secrets > Actionsから上記の情報を登録しておきましょう。

## 6. CI/CDでの実際の設定

### 6-1. Prismaの自動マイグレーション設定例

上記のワークフローを設定することで、`main`ブランチに変更がプッシュされるたびに、Prismaのマイグレーションが自動でデプロイされます。

### 6-2. 成功バッジの確認

GitHubリポジトリのREADMEに以下のようにバッジを追加することで、ワークフローの状態を視覚的に管理できます。

```markdown
![Prisma Migrate](https://github.com/[ユーザ名]/[リポジトリ名]/actions/workflows/prisma.yml/badge.svg)
```

## 7. まとめ

PrismaをGitHub Actionsで自動化することで、CI/CDプロセスを効率化できることはお分かりいただけたでしょうか。この仕組みを活用することで、データベーススキーマの変更をよりスムーズに行うだけでなく、プロジェクト全体の開発速度や信頼性が向上します。事前にPrismaスキーマを適切に設計し、セキュアな設定を行うことが成功の鍵となるでしょう。 

PrismaのマイグレーションをGitHub Actionsで自動実行する方法

目次

続きを読むには単価診断を受けてください（30秒）