GitHub Actions を使用して Gradle で Spring Boot の自動テストを実行する方法

GitHub Actions を活用すると、Spring Boot プロジェクトの自動テストを簡単に実行できます。本記事では、Gradle を使用した Spring Boot プロジェクトの自動テストを実行するための GitHub Actions の設定方法を紹介します。

ワークフローファイルの作成
1. gradle-test.yml の内容
設定の説明
まとめ

ワークフローファイルの作成

GitHub Actions で自動テストを実行するには、.github/workflows/gradle-test.yml というワークフローファイルを作成し、プロジェクトのルートディレクトリに配置します。

gradle-test.yml の内容

name: Gradle Spring Boot Test

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up JDK 11
        uses: actions/setup-java@v3
        with:
          distribution: 'corretto'
          java-version: '11'

      - name: Cache Gradle packages
        uses: actions/cache@v3
        with:
          path: ~/.gradle/caches
          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
          restore-keys: ${{ runner.os }}-gradle-

      - name: Grant execute permission for gradlew
        run: chmod +x gradlew

      - name: Build with Gradle
        run: ./gradlew build --no-daemon

      - name: Run tests
        run: ./gradlew test --no-daemon

設定の説明

設定項目	説明
`name`	ワークフローの名前を設定します。任意の名前に変更可能です。
`on`	ワークフローの実行トリガーを設定します。この例では `main` ブランチへの `push` や `pull_request` の際に実行されます。
`jobs`	実行するジョブを定義します。
`runs-on`	実行環境を指定します。この例では `ubuntu-latest` を使用しています。
`steps`	ジョブ内で実行するステップを定義します。
`actions/checkout@v4`	リポジトリのコードをチェックアウトします。
`actions/setup-java@v3`	JDK 11 をセットアップします。`corretto` ディストリビューションを使用しています。
`actions/cache@v3`	Gradle の依存関係をキャッシュし、ビルド時間を短縮します。
`chmod +x gradlew`	Gradle のラッパースクリプトに実行権限を付与します。
`./gradlew build --no-daemon`	Gradle でプロジェクトをビルドします。
`./gradlew test --no-daemon`	Gradle でテストを実行します。