GitLab CI/CD Variables [前編]

build:
  stage: build
  image: eclipse-temurin:17-jdk
  variables:
    BUILD_ENV: Release
  script:
    # ./gradlew :base:bundleRelease と同じ
    - ./gradlew bundle$BUILD_ENV
    # ./gradlew assembleRelease と同じ
    - ./gradlew assemble$BUILD_ENV

variables:
  # Gradleデーモンの起動を抑止。
  GRADLE_OPTS: "-Dorg.gradle.daemon=false"
  # ダウンロードするGradleやパッケージの保存先をGitLabでキャッシュするために場所を変更。
  GRADLE_USER_HOME: ${CI_PROJECT_DIR}/build/.gradle

default:
  image: eclipse-temurin:17-jdk
  # CIジョブでGradleやパッケージを毎回ダウンロードしなくてもいいように
  # ダウンロードしたファイルをGitLabでキャッシュします。
  cache:
    key: gradle
    paths:
      - build/.gradle

build:
  stage: build
  script:
    - ./gradlew jar

check:
  stage: test
  script:
    - ./gradlew check

default:
  image: eclipse-temurin:17-jdk

build:
  stage: build
  variables:
    # キャッシュや成果物ZIPでより高速なfastzipを使います。
    FF_USE_FASTZIP: "true"
    # デフォルトの`git fetch`ではなく、`git clone`でソースコードを取得するように。
    GIT_STRATEGY: clone
  script:
    - gradle jar
  artifacts:
    paths:
      - build/libs/*.jar

build:
  stage: build
  script:
    - echo run build
  rules:
    - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH

variables:
  APP_DOMAIN: example.jp

# 本番環境
# 手動でこのジョブを実行すると、本番環境にデプロイされます。
# GitLab Environmentsに`production`として
# `https://example.jp`が登録され、
# GitLabプロジェクトからすぐにアクセスできます。
deploy:production:
  stage: deploy
  script:
    - echo deploy to production
  environment:
    # 本番系のURLは https://example.jp
    name: production
    url: https://${APP_DOMAIN}
  when: manual

# マージリクエストのReview Apps
# マージリクエストのブランチをそれぞれ別々の環境を作成してでデプロイします。
# `15-fix-bug`ブランチは`https://15-fix-bug.examplejp`として
# GitLab Environmentsに登録され、
# マージリクエストにこのアプリへのリンクボタンが表示されます。
review:
  stage: deploy
  script:
    - echo deploy to review apps
  environment:
    # Review AppsのURLは https://15-fix-bug.example.jp (`15-fix-bug`ブランチの場合)
    name: review/$CI_COMMIT_REF_NAME
    url: https://${CI_COMMIT_REF_SLUG}.${APP_DOMAIN}
    on_stop: stop:review
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"

stop:review:
  stage: deploy
  script:
    - echo delete deployment
  environment:
    name: review/$CI_COMMIT_REF_NAME
    action: stop
  when: manual

test:
  stage: test
  image: eclipse-temurin:17-jdk
  services:
    # テストのためのPostgreSQLサーバーを起動する。
    - postgres
  variables:
    POSTGRES_DB: app
    POSTGRES_USER: app
    POSTGRES_PASSWORD: p@assw0rd
  script:
    # データベースの初期化。
    - apt-get -qy update && apt-get -qy install postgresql-client
    - cat db/initialize.sql | PGPASSWORD=${POSTGRES_PASSWORD} psql -U ${POSTGRES_USER} -h postgres -d ${POSTGRES_DB}
    # アプリケーションのテスト。
    - export JDBC_URL=jdbc:postgresql://postgres:5432/${POSTGRES_DB}
    - export JDBC_USER=${POSTGRES_USER}
    - export JDBC_PASSWORD=${POSTGRES_PASSWORD}
    - ./gradlew test

default:
  # `eclipse-temurin:17`か`eclipse-temurin:11`になります。
  image: eclipse-temurin:$JAVA_VERSION

test:17:
  stage: test
  variables:
    JAVA_VERSION: 17
  script:
    - ./gradlew test

test:11:
  stage: test
  variables:
    JAVA_VERSION: 11
  script:
    - ./gradlew test

# `build.gradle` でプロパティからバージョン番号を読み取るようにしています。
#
# group 'com.example'
# version project.hasProperty('version') ? project['version'] : '0.0.0'

build:
  stage: build
  script:
    - ./gradlew war -Pversion=${CI_COMMIT_TAG}
  artifacts:
    paths:
      # `git tag 2.0.1 && git push --tags`で、
      # `build/libs/demo-2.0.1.war`ファイルが作成される。
      - build/libs/*.war
  rules:
    - if: $CI_COMMIT_TAG

# すべてのジョブで利用できます。
variables:
  VAR1: value1
  VAR2: value2

job1:
  variables:
    VAR1: job1_value1
    VAR3: https://example.jp/${VAR2}
  script:
    - echo $VAR1 # `job1_value1`と、ジョブ設定で上書きされます。
    - echo $VAR2 # `value2`と、グローバル設定のままです。
    - echo $VAR3 # `VAR2`変数を参照しています。

variables:
  VAR1: value1

job1:
  inherit:
    # グローバルセクションの`variables:`を引き継ぎません。
    variables: false
  script:
    - echo $VAR1 # 何も表示されません。


job2:
   inherit:
     # `variables: true`は既定値です。
     variables: true
   script:
      - echo $VAR1 # `value1`

test:
  variables:
    POSTGRES_DB: app
    POSTGRES_USER: app
    # プロジェクトのCI/CD変数の値をコピーします。
    POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
  services:
    - postgres
  before_script:
    - apt-get -qy update && apt-get -qy install postgresql-client
  script:
    - echo 'select current_date;' | PGPASSWORD=${POSTGRES_PASSWORD} psql -U ${POSTGRES_USER} -h postgres -d ${POSTGRES_DB}

[[runners]]
  name = "984d91d334c9"
  environment = ["http_proxy=http://proxy.example.jp:8080","https_proxy=http://proxy.example.jp:8080","no_proxy=localhost,127.0.0.1"]

variables:
  BUILD_ENV:
    description: "`Debug` or `Release`"
    value: Release

build:
   stage: build
   image: eclipse-temurin:17-jdk
   script:
     - ./gradlew bundle$BUILD_ENV
     - ./gradlew assemble$BUILD_ENV

https://gitlab.example.jp/group1/project1/-/pipelines/new?var[BUILD_ENV]=Release

$ curl --request POST \
       --form token=<token> \
       --form ref=<ref_name> \
       --form "variables[VAR1]=value1" \
       https://gitlab.example.jp/api/v4/projects/<project_id>/trigger/pipeline

https://gitlab.example.jp/api/v4/projects/<project_id>/ref/<ref_name>/trigger/pipeline?token=<token>&variables[VAR1]=value1

job1:
  script:
    - export VALUE1=job1

job2:
  script:
    - echo ${VALUE1} # 何も表示されません。
  needs:
    - job1

detect:node:
  stage: .pre
  script:
    # `.nvmrc`ファイルには`v18.9.1`と記述されています。
    - echo NODE_VERSION=`cat .nvmrc | sed 's/^v//;'` > .env
  artifacts:
    reports:
      dotenv: .env

test:
  # このジョブでは`NODE_VERSION: 18.9.1`が設定されています。
  image: node:${NODE_VERSION}
  script:
    - npm run test

test:
  stage: test
  image: node:${NODE_VERSION}
  before_script:
    - npm ci
  script:
    - npm test
  parallel:
    matrix:
      - NODE_VERSION:
          - '19'
          - '18'
          - '16'

build:
  variables:
    BUILD_ENV: Debug
  script:
     - ./gradlew bundle${BUILD_ENV}
  rules:
    # デフォルトブランチのとき。
    - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH
      variables:
         BUILD_ENV: Release
    # それ以外のとき。
    - when: on_success

.base: # `.`で始まる名前はジョブとして認識されません。
  variables:
    VAR1: base
    VAR2: base

job:
  extends: .base
  variables:
    VAR1: job
  script:
    - echo VAR1=$VAR1 # VAR1=job
    - echo VAR2=$VAR2 # VAR2=base

.base: &base
  variables:
    VAR1: base
    VAR2: base

job:
  <<: *base
  variables:
    VAR1: job
  script:
    - echo VAR1=$VAR1 # VAR1=job
    - echo VAR2=$VAR2 # `VAR2`は未設定。

variables:
  # `registry.gitlab.example.jp/group1/project1:main`のようになります。
  DOCKER_IMAGE_TAG: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG
  POSTGRES_DB: app
  POSTGRES_USER: app
  POSTGRES_PASSWORD: p@ssw0rd

job:
  variables:
    # `jdbc:postgres://postgres:5432/app`となります。
    JDBC_URL: jdbc:postgres://postgres:5432/$POSTGRES_DB
    # `app`ではなく、`$POSTGRES_DB`という文字列となります。
    VALUE: $$POSTGRES_DB
  script:
    - echo run job.

windows:
  variables:
    USER_NAME: Taro
    # ここはCI/CD変数の展開記法を使う。
    MESSAGE: Hello, ${USER_NAME}
  script:
    - echo $MESSAGE 
    - echo "Hello, $USER_NAME" # PowerShell変数
    - echo "Hello, ${USER_NAME}" # PowerShell変数
    - echo "Hello, $env:USER_NAME" # 環境変数
    - echo "Hello, ${env:USER_NAME}" # 環境変数
  tags:
    - windows

variables:
  WEB_APP_URL: https://${WEB_APP_HOSTNAME}example.jp

production:
  script:
    - # WEB_APP_URL=https://example.jp 
    - ./ci/deploy.sh --url ${WEB_APP_URL}
  environment:
    name: production
    url: ${WEB_APP_URL}
  when: manual

staging:
  variables:
    WEB_APP_HOSTNAME: staging.
  script:
    - # WEB_APP_URL=https://staging.example.jp 
    - ./ci/deploy.sh --url ${WEB_APP_URL}
  environment:
     name: staging
     url: ${WEB_APP_URL}
  when: manual

review:
  variables:
    WEB_APP_HOSTNAME: ${CI_COMMIT_REF_SLUG}-review.
  script:
    - # WEB_APP_URL=https://6-foo-review.example.jp 
    - ./ci/deploy.sh --url ${WEB_APP_URL}
  environment:
     name: review/$CI_COMMIT_REF_NAME
     url: ${WEB_APP_URL}
     on_stop: stop:review
  rules:
    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'

stop:review:
   script:
      - echo delete deployment
   environment:
      name: review/$CI_COMMIT_REF_NAME
   when: manual

variables:
  NODE_OPTS: --enable-fips

job:
  variables:
    NODE_OPTS: "$NODE_OPTS --experimental-fetch"
  script:
    # 次の行のようになります。
    # node $NODE_OPTS --experimental-fetch --experimental-fetch src/script.js
    - node $NODE_OPTS src/script.js