環境変数

Screwdriver はビルドの過程で利用できる環境変数をエクスポートしています。

注意: 1つのジョブに対して設定した環境変数は他のジョブでは参照できません。ジョブ間で値を渡すには、metadata を利用してください。

ビルド固有

全般

環境変数名 説明
SD_BUILD_ID ビルド番号 (例: 1, 2, など)
SD_EVENT_ID イベントの ID
SD_JOB_ID ジョブの ID
SD_JOB_NAME ジョブの名前 (例: main)
SD_PARENT_BUILD_ID このビルドをトリガーするビルドのリスト(例: [12345 23456])
SD_PARENT_EVENT_ID リスタートの場合、親のイベントの ID
SD_PR_PARENT_JOB_ID PRジョブの 本来のID。例えば、PR-1:mainビルドにおいては、本環境変数が指す値はmainジョブのIDとなる
SD_PIPELINE_ID パイプラインの ID
SD_PIPELINE_NAME パイプラインの名前(例: d2lam/myPipeline)
SD_PRIVATE_PIPELINE パイプラインがプライベート(true)か、パブリック(false）か
SD_PULL_REQUEST プルリクエスト番号 (プルリクエストでない場合は空)
SD_STEP_EXIT_CODE 以前実行されたステップの終了コード。teardown stepsのみで利用可能。（例: 以前のすべてのステップがパスしていれば0、そうでなければ最後の0でない終了コード。)
SD_STEP_NAME 現在のステップ名。ただしsetup stepsとteardown stepsでは利用不可 (例: teardownステップではsetup stepsとteardown steps以外で最後に成功したステップ名が設定される)
SD_TEMPLATE_FULLNAME 使用しているテンプレートの完全な名前 (テンプレートを使用していない場合は空)
SD_TEMPLATE_NAME 使用しているテンプレートの名前 (テンプレートを使用していない場合は空)
SD_TEMPLATE_NAMESPACE 使用しているテンプレートのネームスペース (テンプレートを使用していない場合は空)
SD_TEMPLATE_VERSION 使用しているテンプレートのバージョン (テンプレートを使用していない場合は空)
SD_BUILD_CLUSTER_NAME 使用しているビルドクラスターの名前
SD_TOKEN ビルド用の JWT トークン
SD_SCHEDULED_BUILD スケジューラーによってビルドを開始する(true)か、否(false)か
SD_DIND_SHARE_PATH Docker-in-Docker機能が有効な場合に使われる。ビルドコンテナとDinDコンテナの共有ディレクトリへのパス
CONTAINER_IMAGE ビルドコンテナイメージ ビルドエグゼキューターとしてKubernetesを使用している場合に利用可能
CONTAINER_CPU_LIMIT ビルドコンテナに割り当てられたCPUの値
CONTAINER_MEMORY_LIMIT ビルドコンテナに割り当てられたメモリの値

ユーザ設定

環境変数名 デフォルト値 説明
SD_ZIP_ARTIFACTS false オプション: (true/false)

artifacts を単一の zip ファイルにしてアップロードします。

ユースケース: ビルドで大量の artifacts が生成される場合にアップロード時間を短縮できます。アップロードに失敗する場合は、zipファイルのサイズが処理可能なサイズより大きい可能性があります。

注意: このオプションが利用可能かどうかは、クラスタ管理者に問い合わせてください。
USER_SHELL_BIN sh ビルド内で実行されるシェルを指定します。/bin/bashのように、絶対パスでの指定もできます。サンプルリポジトリ: https://github.com/screwdriver-cd-test/user-shell-example
GIT_SHALLOW_CLONE true オプション: (true/false)

shallow clone します。
GIT_SHALLOW_CLONE_DEPTH 50 shallow clone する際の履歴を指定されたコミット数までで切り捨てます。
GIT_SHALLOW_CLONE_SINCE   指定した日時から始まる履歴の一部でShallow cloneします。設定されている場合、GIT_SHALLOW_CLONE_DEPTHよりも優先されます。

--shallow-sinceを利用しており、絶対年代(例: 2019-04-01)と相対年代(例: 4 weeks ago)が設定できます。
GIT_SHALLOW_CLONE_SINGLE_BRANCH   trueの場合、shallow cloneの際に--single-branchオプションを使います。それ以外の場合、--no-single-branchオプションが使われます。
SD_COVERAGE_PLUGIN_ENABLED true falseの場合、sd-teardown-screwdriver-coverage-bookendステップがスキップされます。

プラグイン

これらの環境変数は、インストールされているプラグインによって利用できたりできなかったりします。

カバレッジ(Sonar)

環境変数名 説明
SD_SONAR_AUTH_URL Sonar のアクセストークンを返す Screwdriver API の認証 URL
SD_SONAR_HOST Sonar のホストの URL
SD_SONAR_ENTERPRISE SonarQube の Enterprise 版を利用している(true)か、オープンソース版を使っている(false)か
SD_SONAR_PROJECT_KEY Sonar の project key (例: pipeline:123 or job:456)
SD_SONAR_PROJECT_NAME Sonar の project 名 (例: d2lam/myPipeline or d2lam/myPipeline:main)
SD_ALLOW_PRIVATE_COVERAGE_SEND true の場合、プライベートパイプラインでもCoverage送信ができるようになります

ディレクトリ

環境変数名 説明
SD_ARTIFACTS_DIR ビルド･生成されたファイルのディレクトリ

注意: ビルドがABORTEDで無い場合に、sd-teardown-screwdriver-artifact-bookendステップでこのディレクトリからストアへアップロードされます。
SD_META_DIR メタデータディレクトリのパス
SD_META_PATH メタデータファイルのパス
SD_ROOT_DIR ワークスペースのディレクトリ (例: /sd/workspace)
SD_SOURCE_DIR チェックアウトされたコードのディレクトリ (例: /sd/workspace/src/github.com/d2lam/myPipeline)
SD_SOURCE_PATH ビルドをトリガーしたソースのパス。参考: Source Paths.
SD_CONFIG_DIR 親パイプラインのリポジトリのディレクトリ(子パイプラインでのみ設定されます) (例: /sd/workspace/config)

環境変数

環境変数名 説明
screwdriver.yaml の “environment” の項目で設定された環境変数

以下のように、ドットを含む環境変数を使用する場合には注意してください。

environment:
   REGION.INSTANCE: 'xyz'

この時、process.env.REGION.INSTANCE では環境変数を取得できません。process.env['REGION.INSTANCE'] を使用してください。

ソースコード

環境変数名 説明
SCM_URL チェックアウトされた SCM の URL
GIT_URL チェックアウトされた SCM の URL に .git を追加した URL
CONFIG_URL 親パイプラインのリポジトリの SCM の URL (子パイプラインでのみ設定されます)
GIT_BRANCH プルリクエストまたはブランチのリファレンス (例: origin/refs/${PRREF} または origin/${BRANCH})
PR_BASE_BRANCH_NAME プルリクエストのベースとなっているブランチ名 (例: ${BRANCH})
PR_BRANCH_NAME プルリクエストのブランチ名 (例: origin/${BRANCH} または upstream/${BRANCH})
SD_BUILD_SHA Git の commit SHA (例: b5a94cdabf23b21303a0e6d5be5e96bd6300847a)

URLs

環境変数名 説明
SD_API_URL Screwdriver API の URL へのリンク (例: https://api.screwdriver.cd/v4/)
SD_BUILD_URL Screwdriver のビルド API へのリンク (例: https://api.screwdriver.cd/v4/builds/1)
SD_STORE_URL Screwdriver Store の URL へのリンク (例: https://store.screwdriver.cd/v1/)
SD_UI_URL Screwdriver UI の URL へのリンク (例: https://cd.screwdriver.cd/)
SD_UI_BUILD_URL Screwdriver UI のビルド URL へのリンク (例: https://cd.screwdriver.cd/pipelines/259/builds/173)

継続的インテグレーション

環境変数名 説明
SCREWDRIVER true
CI true
CONTINUOUS_INTEGRATION true