# Java GitLab CIのYAMLファイルの書き方を理解する

## 目次

1. はじめに

2. GitLab CI/CDとは？

3. YAMLファイルの基本構成

   1. YAMLの記述ルール

   2. GitLab CI用YAMLの基本要素

4. JavaプロジェクトにおけるGitLab CIの設定

   1. ビルドステージの設定

   2. テストステージの設定

   3. デプロイステージの設定

5. 具体例：Javaプロジェクト用GitLab CI/CD YAMLファイル

6. よくある質問

7. まとめ

## 1. はじめに

Continuous Integration/Continuous Deployment (CI/CD) は、ソフトウェア開発プロセスを効率化するための重要なコンポーネントです。GitLabは、そのCI/CDツールであるGitLab CIを提供しており、YAMLファイルを用いてパイプラインを記述します。本稿では、JavaプロジェクトにおけるGitLab CIのYAMLファイルの書き方について詳しく解説します。

## 2. GitLab CI/CDとは？

GitLab CI/CDは、コードのバージョン管理とともに、コードのビルド、テスト、デプロイを自動化するツールです。GitLabのリポジトリにクローンしたプロジェクトに対して、YAML形式の設定ファイルを用いてCIパイプラインを定義し、スタイルの検証、ビルド、テスト、自動デプロイを行うことができます。

## 3. YAMLファイルの基本構成

### 1-1. YAMLの記述ルール

YAML（Yet Another Markup Language）は、データをシンプルに表現できる軽量マークアップ言語です。以下は、YAML記述の基本ルールです。

- インデントはスペースを用いる（タブは禁止）

- コメントは`#`で始める

- 配列はハイフン `-` を用いて表現

### 1-2. GitLab CI用YAMLの基本要素

GitLab CI/CD用のYAMLファイルは通常、プロジェクトのルートに`.gitlab-ci.yml`という名前で配置します。このファイルは以下の要素で構成されます。

- `stages`: 実行するステージ（ビルド、テスト、デプロイなど）

- `jobs`: 各ステージで実行される実際の作業

- `scripts`: 各ジョブで実行するスクリプトコマンド

- `artifacts`: 各ステージの出力で、次のステージで利用される

## 4. JavaプロジェクトにおけるGitLab CIの設定

Javaプロジェクトでは、MavenやGradleを使ったビルド、JUnitを使ったテストが一般的です。

### 1-1. ビルドステージの設定

ビルドステージでは、Javaコードをコンパイルしてアーティファクトを生成します。

```yaml

stages:

  - build

build:

  stage: build

  script:

    - 'mvn clean install'

  artifacts:

    paths:

      - target/*.jar

```

#### ポイント

- `script`には、Mavenを利用したビルドコマンドを記述

- ビルド後に生成されるjarファイルを`artifacts`として次のステージに渡す設定

### 1-2. テストステージの設定

テストステージでは、ビルドされたアプリケーションのユニットテストを実行します。

```yaml

stages:

  - build

  - test

test:

  stage: test

  script:

    - 'mvn test'

  dependencies:

    - build

  artifacts:

    reports:

      junit: 'target/surefire-reports/*.xml'

```

#### ポイント

- `script`では、プロジェクトの単体テストを実行するコマンドを記述

- `artifacts.reports`を用いてJUnitのテスト結果を保存

### 1-3. デプロイステージの設定

デプロイメントでは、テストに合格したコードを実際の環境にデプロイします。

```yaml

stages:

  - build

  - test

  - deploy

deploy_production:

  stage: deploy

  script:

    - 'scp target/*.jar user@remote.host:/path/to/production'

  only:

    - master

```

#### ポイント

- `script`で、安全性のため`scp`を用いてリモートサーバへ転送

- `only`を用いてデプロイを特定のブランチ(master)のみに限定

## 5. 具体例：Javaプロジェクト用GitLab CI/CD YAMLファイル

```yaml

# 全体のジェネリックな構成

stages:

  - build

  - test

  - deploy

build:

  stage: build

  script:

    - 'mvn clean install'

  artifacts:

    paths:

      - target/*.jar

test:

  stage: test

  script:

    - 'mvn test'

  dependencies:

    - build

  artifacts:

    reports:

      junit: 'target/surefire-reports/*.xml'

deploy_production:

  stage: deploy

  script:

    - 'scp target/*.jar user@remote.host:/path/to/production'

  only:

    - master

```

## 6. よくある質問

### ダウンサイドはありますか？

CI/CDの導入には、セットアップのための初期の労力が必要です。特に、複数の環境をまたいでデプロイするには、より精密なステージ設計が求められます。

### GitLab Runnerはどのように設定しますか？

GitLab Runnerは、ジョブを実行するためのプロセスです。適切に設定することで、パフォーマンスの効率化が可能です。

## 7. まとめ

GitLab CI/CDを利用すれば、Javaプロジェクトのビルド、テスト、デプロイを自動化し、開発の効率を飛躍的に向上させることができます。本稿を参考に、自分のプロジェクトに適したパイプラインをぜひ構築してみてください。正確に設定されたパイプラインは、コードの労力を著しく削減し、迅速な開発サイクルを実現します。

Java GitLab CIのYAMLファイルの書き方を理解する

目次

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