開発運用

GitHub ActionsでCI/CD実現

最終更新： 2月 21, 2025
1 分の読み

GitHub Actionsを使用した継続的インテグレーション（CI）と継続的デリバリー（CD）の実現について、以下に詳しく解説します。この技術は、ソフトウェア開発の効率を大幅に向上させるために重要な役割を果たします。特に、開発者がコードを変更した際に自動でビルドやテスト、デプロイが行われるため、品質の向上とデプロイのスピードを加速させることができます。

1. GitHub Actionsの概要

GitHub Actionsは、GitHub上で自動化されたワークフローを作成し、CI/CDパイプラインを構築するためのツールです。これにより、リポジトリ内でコードをプッシュしたり、プルリクエストを作成したりする際に、自動でビルド、テスト、デプロイなどの作業を実行できます。

関連記事

GitHub Actionsは、YAMLファイルを使用して設定を行い、さまざまなイベントに基づいてジョブを実行します。例えば、コードがリモートリポジトリにプッシュされたときや、プルリクエストが作成されたときに自動的にワークフローをトリガーできます。

2. GitHub Actionsの基本的な構成

GitHub Actionsでは、ワークフロー、ジョブ、ステップという3つの主要な要素があります。

  • ワークフロー (Workflow): 自動化された一連のタスクを定義します。GitHubリポジトリ内の.github/workflowsディレクトリにYAML形式のファイルとして保存されます。

  • ジョブ (Job): ワークフロー内で実行される一連の作業を定義します。各ジョブは、他のジョブと並列または順次に実行されることがあります。

  • ステップ (Step): ジョブ内で実行される単一の命令を定義します。通常は、コマンドラインで実行するスクリプトやGitHubが提供するアクションを呼び出す形になります。

3. GitHub Actionsの設定方法

GitHub Actionsを使用するためには、リポジトリ内にワークフローファイルを作成する必要があります。以下に、CI/CDパイプラインを構築するための基本的な手順を示します。

ステップ1: リポジトリにワークフローファイルを作成

リポジトリ内の.github/workflowsディレクトリに新しいYAMLファイルを作成します。例えば、ci-cd.ymlという名前のファイルを作成します。

yaml
name: CI/CD Pipeline

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Set up Node.js
        uses: actions/setup-node@v2
        with:
          node-version: '14'

      - name: Install dependencies
        run: npm install

      - name: Run tests
        run: npm test

  deploy:
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Deploy to server
        run: |
          scp -r * user@server:/path/to/deploy

ステップ2: ワークフローのトリガーを設定

上記の例では、pushイベントとpull_requestイベントに基づいてワークフローが実行されるように設定されています。これにより、mainブランチに変更がプッシュされるか、プルリクエストが作成されると自動でワークフローが実行されます。

ステップ3: ジョブの定義

上記のYAMLファイルでは、2つのジョブを定義しています。

  • buildジョブ: コードをチェックアウトし、Node.jsをセットアップし、依存関係をインストールし、テストを実行します。
  • deployジョブ: ビルドが成功した後、サーバーにコードをデプロイします。このジョブはbuildジョブに依存しているため、buildが成功した場合にのみ実行されます。

ステップ4: アクションの使用

GitHub Actionsでは、コミュニティによって提供されるアクションを使用して、さまざまなタスクを簡単に実行できます。例えば、actions/checkoutはコードをチェックアウトするアクションであり、actions/setup-nodeはNode.jsのセットアップを簡単に行います。

4. 継続的インテグレーション（CI）の実装

CIは、コードがリポジトリにプッシュされるたびに自動でビルドとテストを行うプロセスです。GitHub Actionsでは、以下のように簡単にCIパイプラインを実装できます。

yaml
name: CI Pipeline

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Set up Node.js
        uses: actions/setup-node@v2
        with:
          node-version: '14'

      - name: Install dependencies
        run: npm install

      - name: Run tests
        run: npm test

このワークフローでは、コードがmainブランチにプッシュされるか、プルリクエストが作成されると、ビルドが実行され、依存関係のインストールとテストが自動で行われます。

5. 継続的デリバリー（CD）の実装

CDは、CIの後に自動的にコードをステージング環境や本番環境にデプロイするプロセスです。GitHub Actionsでは、以下のようにデプロイの自動化も行うことができます。

yaml
name: CI/CD Pipeline

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Set up Node.js
        uses: actions/setup-node@v2
        with:
          node-version: '14'

      - name: Install dependencies
        run: npm install

      - name: Run tests
        run: npm test

  deploy:
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Deploy to server
        run: |
          scp -r * user@server:/path/to/deploy

この例では、buildジョブが成功した場合にのみ、deployジョブが実行されます。scpコマンドを使用して、サーバーへのデプロイが行われます。

6. GitHub Actionsを利用した利点

GitHub Actionsを使用することによって得られる主な利点は以下の通りです。

  • 自動化: 手動で行う必要のあるビルド、テスト、デプロイの作業を自動化することができ、人的ミスを減らし、開発の効率を高めます。
  • 迅速なフィードバック: コードをプッシュした後すぐにビルドとテストが実行されるため、エラーを早期に発見できます。
  • 環境設定の簡略化: GitHub Actionsは、環境設定をコードで管理できるため、再現性のあるビルド環境を簡単に作成できます。

7. まとめ

GitHub Actionsは、CI/CDパイプラインの自動化を通じて、開発ワークフローを効率化し、品質を保ちながら迅速にコードをデプロイするための強力なツールです。GitHubリポジトリと連携して、手軽にビルド、テスト、デプロイを自動化できるため、開発者にとって非常に有

最終更新： 2月 21, 2025
1 分の読み
Back to top button