はじめに
このガイドは、Antビルドシステムを使ってJavaのプロジェクトのための継続的インテグレーション(CI)を実行するワークフローを作成する方法を紹介します。 作成するワークフローによって、プルリクエストに対するコミットがデフォルトブランチに対してビルドあるいはテストの失敗を引き起こしたことを見ることができるようになります。このアプローチは、コードが常に健全であることを保証するための役に立ちます。 CIワークフローを拡張して、ワークフローの実行による成果物をアップロードするようにもできます。
GitHub ホスト型ランナーにはツール キャッシュとプレインストールされたソフトウェアがあり、それには Java Development Kit (JDK) と Ant が含まれます。 JDK と Ant に関するソフトウェアとプレインストールされたバージョンの一覧については、「Using GitHub-hosted runners」を参照してください。
前提条件
YAMLとGitHub Actionsの構文に馴染んでいる必要があります。 詳細については、次を参照してください。
Java及びAntフレームワークの基本的な理解をしておくことをおすすめします。 詳細については、Apache Ant マニュアルを参照してください。
Ant スターター ワークフローの使用
GitHub からはほとんどの Ant ベース Java プロジェクトで機能する Ant スターター ワークフローが提供されます。 詳細については、「Ant スターター ワークフロー」を参照してください。 既定のスターター ワークフローは、ビルドとテストのワークフローを構築するときに適した出発点であり、プロジェクトの要求に合わせてこのスターター ワークフローをカスタマイズできます。
素早く始めるには、新しいワークフローを作成するときに事前構成済みの Ant スターター ワークフローを選択できます。 詳しくは、「GitHub Actions のクイックスタート」をご覧ください。
リポジトリの .github/workflows
ディレクトリに新しいファイルを作成することにより、手作業でこのワークフローを追加することもできます。
# ワークフローの名前です。 GitHub では、ワークフローの名前がリポジトリの [アクション] タブに表示されます。`name` を省略すると、GitHub は、リポジトリのルートに対して相対的なワークフロー ファイル パスを表示します。 name: Java CI # on: [push] # jobs: build: # <!-- This is a YAML comment for use in annotated code examples. --> # このワークフローは、別のオペレーティング システムを使用して実行できます。 # # スターター ワークフローは、GitHub ホスト `ubuntu-latest` ランナーを使って Linux 上で実行するジョブを設定します。 `runs-on` キーを変更すると、別のオペレーティング システムでジョブを実行するようにできます。 # # たとえば、`runs-on: windows-latest` を指定すると、GitHub がホストする Windows ランナーを使うことができます。 あるいは、`runs-on: macos-latest` を使用すると、GitHub がホストする macOS ランナーで実行させることもできます。 # # Dockerコンテナ上でジョブを実行させたり、独自のインフラストラクチャ上で動作するセルフホストランナーを提供したりすることもできます。 詳しくは、「[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on)」を参照してください。 runs-on: ubuntu-latest # steps: # このステップでは、`actions/checkout` アクションで、ランナーにリポジトリのコピーをダウンロードします。 - uses: actions/checkout@v4 # このステップでは、`actions/setup-java` アクションで、Eclipse Adoptium による Eclipse Temurin (Java) 17 JDK を構成します。 - name: Set up JDK 17 uses: actions/setup-java@v3 with: java-version: '17' distribution: 'temurin' # This step runs the default target in your `build.xml` file in non-interactive mode. - name: Build with Ant run: ant -noinput -buildfile build.xml
name: Java CI
ワークフローの名前です。 GitHub では、ワークフローの名前がリポジトリの [アクション] タブに表示されます。name
を省略すると、GitHub は、リポジトリのルートに対して相対的なワークフロー ファイル パスを表示します。
on: [push]
jobs:
build:
runs-on: ubuntu-latest
このワークフローは、別のオペレーティング システムを使用して実行できます。
スターター ワークフローは、GitHub ホスト ubuntu-latest
ランナーを使って Linux 上で実行するジョブを設定します。 runs-on
キーを変更すると、別のオペレーティング システムでジョブを実行するようにできます。
たとえば、runs-on: windows-latest
を指定すると、GitHub がホストする Windows ランナーを使うことができます。 あるいは、runs-on: macos-latest
を使用すると、GitHub がホストする macOS ランナーで実行させることもできます。
Dockerコンテナ上でジョブを実行させたり、独自のインフラストラクチャ上で動作するセルフホストランナーを提供したりすることもできます。 詳しくは、「GitHub Actions のワークフロー構文」を参照してください。
steps:
- uses: actions/checkout@v4
このステップでは、actions/checkout
アクションで、ランナーにリポジトリのコピーをダウンロードします。
- name: Set up JDK 17
uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'temurin'
このステップでは、actions/setup-java
アクションで、Eclipse Adoptium による Eclipse Temurin (Java) 17 JDK を構成します。
- name: Build with Ant
run: ant -noinput -buildfile build.xml
This step runs the default target in your build.xml
file in non-interactive mode.
# ワークフローの名前です。 GitHub では、ワークフローの名前がリポジトリの [アクション] タブに表示されます。`name` を省略すると、GitHub は、リポジトリのルートに対して相対的なワークフロー ファイル パスを表示します。
name: Java CI
#
on: [push]
#
jobs:
build:
# <!-- This is a YAML comment for use in annotated code examples. -->
# このワークフローは、別のオペレーティング システムを使用して実行できます。
#
# スターター ワークフローは、GitHub ホスト `ubuntu-latest` ランナーを使って Linux 上で実行するジョブを設定します。 `runs-on` キーを変更すると、別のオペレーティング システムでジョブを実行するようにできます。
#
# たとえば、`runs-on: windows-latest` を指定すると、GitHub がホストする Windows ランナーを使うことができます。 あるいは、`runs-on: macos-latest` を使用すると、GitHub がホストする macOS ランナーで実行させることもできます。
#
# Dockerコンテナ上でジョブを実行させたり、独自のインフラストラクチャ上で動作するセルフホストランナーを提供したりすることもできます。 詳しくは、「[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on)」を参照してください。
runs-on: ubuntu-latest
#
steps:
# このステップでは、`actions/checkout` アクションで、ランナーにリポジトリのコピーをダウンロードします。
- uses: actions/checkout@v4
# このステップでは、`actions/setup-java` アクションで、Eclipse Adoptium による Eclipse Temurin (Java) 17 JDK を構成します。
- name: Set up JDK 17
uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'temurin'
# This step runs the default target in your `build.xml` file in non-interactive mode.
- name: Build with Ant
run: ant -noinput -buildfile build.xml
JVMのバージョンとアーキテクチャの指定
スターター ワークフローで x64 プラットフォーム用の OpenJDK 8 を含むように PATH
を設定します。 異なるバージョンの Java を使用する場合、あるいは異なるアーキテクチャ (x64
または x86
) をターゲットとする場合、setup-java
アクションを使って異なる Java ランタイム環境を選択できます。
たとえば、x64 プラットフォームに対して Adoptium によって提供される JDK のバージョン 11 を使用するには、setup-java
アクションを使用して、java-version
、distribution
、architecture
パラメーターを '11'
、'temurin'
、x64
に設定します。
steps: - uses: actions/checkout@v4 - name: Set up JDK 11 for x64 uses: actions/setup-java@v3 with: java-version: '11' distribution: 'temurin' architecture: x64
steps:
- uses: actions/checkout@v4
- name: Set up JDK 11 for x64
uses: actions/setup-java@v3
with:
java-version: '11'
distribution: 'temurin'
architecture: x64
詳細については、「setup-java
アクション」を参照してください。
コードのビルドとテスト
ローカルで使うのと同じコマンドを、コードのビルドとテストに使えます。
このスターター ワークフローは、build.xml ファイルで指定されたデフォルトのターゲットを実行します。 デフォルトのターゲットは、一般的にクラスをビルドし、テストを実行し、たとえばJARファイルのような配布可能なフォーマットにクラスをパッケージするように設定されるでしょう。
プロジェクトのビルドに異なるコマンドを使ったり、異なるターゲットを実行したいのであれば、それらを指定できます。 たとえば、_build-ci.xml_
ファイルで構成されている jar
ターゲットを実行できます。
steps: - uses: actions/checkout@v4 - uses: actions/setup-java@v3 with: java-version: '17' distribution: 'temurin' - name: Run the Ant jar target run: ant -noinput -buildfile build-ci.xml jar
steps:
- uses: actions/checkout@v4
- uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'temurin'
- name: Run the Ant jar target
run: ant -noinput -buildfile build-ci.xml jar
成果物としてのワークフローのデータのパッケージ化
ビルドが成功し、テストがパスした後には、結果のJavaのパッケージをビルドの成果物としてアップロードすることになるかもしれません。 そうすれば、ビルドされたパッケージをワークフローの実行の一部として保存することになり、それらをダウンロードできるようになります。 成果物によって、Pull Requestをマージする前にローカルの環境でテスト及びデバッグしやすくなります。 詳しくは、「ワークフロー データを成果物として保存する」を参照してください。
Ant では、通常、JAR、EAR、WAR のような出力ファイルが build/jar
ディレクトリに作成されます。 upload-artifact
アクションを使用してそのディレクトリの内容をアップロードできます。
steps: - uses: actions/checkout@v4 - uses: actions/setup-java@v3 with: java-version: '17' distribution: 'temurin' - run: ant -noinput -buildfile build.xml - uses: actions/upload-artifact@v3 with: name: Package path: build/jar
steps:
- uses: actions/checkout@v4
- uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'temurin'
- run: ant -noinput -buildfile build.xml
- uses: actions/upload-artifact@v3
with:
name: Package
path: build/jar