はじめに：CI/CDとGitHub Actions

現代のソフトウェア開発において、CI/CDは不可欠なプラクティスです。CI（継続的インテグレーション）はコード変更を頻繁にメインブランチにマージし、自動でビルドとテストを実行するプロセスです。CD（継続的デリバリー/デプロイメント）は、その先にある本番環境へのリリースを自動化します。これにより、開発サイクルの高速化と品質向上が期待できます。

GitHub Actionsは、GitHubにネイティブに統合されたCI/CDツールです。リポジトリ内で直接ワークフローを定義でき、公開リポジトリであれば無料で利用できる枠も大きいことから、多くの開発者に支持されています。この記事では、GitHub Actionsを使い、簡単なNode.jsプロジェクトのテストを自動化するCIパイプラインを構築する手順を初学者向けに解説します。

GitHub Actionsの基本コンポーネント

GitHub Actionsのワークフローは、いくつかの主要なコンポーネントで構成されています。これらを理解することが、パイプライン構築の第一歩です。

  • Workflow（ワークフロー）: CI/CDプロセス全体を定義したものです。リポジトリの .github/workflows/ ディレクトリにYAMLファイルとして配置します。
  • Event（イベント）: ワークフローを開始するきっかけとなるアクションです。push、pull_request、schedule（定時実行）など、様々なイベントを指定できます。
  • Job（ジョブ）: ワークフローは1つ以上のジョブで構成されます。ジョブは独立した実行環境（Runner）で実行される一連のステップです。デフォルトでは並列に実行されます。
  • Step（ステップ）: ジョブを構成する個々のタスクです。シェルコマンドを実行したり、特定のアクション（後述）を実行したりします。
  • Action（アクション）: ワークフローで利用できる再利用可能なコードの単位です。コミュニティによって作成された多くのアクションがMarketplaceで公開されており、複雑なタスクを簡単に実装できます。

これらのコンポーネントが連携し、コードのプッシュをトリガーに、テストやビルドといった一連の処理が自動的に実行される仕組みが作られます。

最初のCIパイプラインを作成する

それでは、実際にNode.jsプロジェクトのテストを自動化するCIパイプラインを作成してみましょう。ここでは、リポジトリにコードがプッシュされるたびに、npm test を実行するワークフローを定義します。

まず、リポジトリのルートに .github/workflows/ というディレクトリを作成し、その中に ci.yml という名前で以下の内容のファイルを作成します。

# ワークフローの名前
name: Node.js CI

# ワークフローが実行されるイベントを定義
on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]

# 実行するジョブを定義
jobs:
  # ジョブID（任意の名前）
  build:
    # ジョブを実行するOS
    runs-on: ubuntu-latest

    # 実行するステップを定義
    steps:
      # 1. リポジトリのコードをチェックアウトする
      - name: Checkout repository
        uses: actions/checkout@v4

      # 2. Node.js環境をセットアップする
      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '20'

      # 3. 依存関係をインストールする
      - name: Install dependencies
        run: npm install

      # 4. テストを実行する
      - name: Run tests
        run: npm test

このYAMLファイルは、mainブランチへのpushまたはpull requestをトリガーに、Ubuntu環境でNode.js v20をセットアップし、依存関係をインストールした後にテストを実行する、という一連の流れを定義しています。

ワークフローの実行と確認

ci.yml ファイルをリポジトリにコミットしてプッシュすると、自動的に最初のワークフローが実行されます。実行状況は、GitHubリポジトリの「Actions」タブから確認できます。

「Actions」タブを開くと、実行されたワークフローの一覧が表示されます。特定のワークフローをクリックすると、その中のジョブ（この例では build ジョブ）が表示され、さらにジョブをクリックすると、各ステップの実行ログをリアルタイムで確認できます。

すべてのステップが正常に完了すると、ワークフロー名の横に緑色のチェックマークが表示されます。もしテストが失敗するなど、いずれかのステップでエラーが発生した場合は、赤色のバツ印が表示されます。その際は、失敗したステップのログを展開することで、エラーメッセージを確認でき、デバッグの助けになります。このように、CIの実行結果が視覚的にわかるため、問題の早期発見に繋がります。

まとめ：CI/CDへの第一歩

この記事では、GitHub Actionsの基本的な概念を学び、簡単なNode.jsプロジェクトでテストを自動化するCIパイプラインを構築しました。YAMLファイルを数行書くだけで、コードの品質を担保する仕組みを簡単に導入できることを実感いただけたかと思います。

これはCI/CDへの第一歩にすぎません。ここからさらに、以下のような発展的な使い方が考えられます。

  • テストカバレッジのレポート作成
  • Linterによるコード静的解析の追加
  • ビルドした成果物（例: Dockerイメージ）をレジストリにプッシュ
  • テストが成功したPull Requestを自動でマージ
  • 本番環境やステージング環境への自動デプロイ（CD）

GitHub Actionsを使いこなすことで、開発プロセスを大幅に効率化し、より高品質なソフトウェアを迅速に提供できるようになります。ぜひ、ご自身のプロジェクトにも導入してみてください。

記事一覧に戻る