パラメーター定義
パラメーターを定義するには、以下の例のように3つの方法があります。
parameters:
nameA: "value1"
nameB:
value: "value2"
description: "description of nameB"
nameC: ["value1", "value2"]
パラメーターとはkey:valueのペアで定義できるものです。
parameters:
nameA: "value1"
key: string (上記の例を参照) はkey:value (下記の例を参照)を簡潔に記述したものです。
parameters:
nameA:
value: "value1"
description: ""
上記の2つの例は同等のものです。
ドロップダウンから選択するために、パラメーターを配列で定義することもできます。配列の先頭要素がデフォルトとして使われます。例えば、以下の例ではvalue1がデフォルトとして選択されます。
parameters:
nameA: ["value1", "value2"]
スコープ
パラメーターは2つのスコープで定義できます。
- パイプライン
- パイプラインレベルで定義されたパラメーターは全てのジョブで利用可能です。
- ジョブ
- ジョブレベルで定義されたパラメーターは、そのジョブでのみ利用可能です。
- 異なるジョブ間で同じ名前のパラメーターが定義されたとしても競合しません。
- パイプラインとジョブの両方のスコープで同じ名前のパラメーターが定義された場合、ジョブのスコープの値が優先されます。
- テンプレートのパラメーターは、パイプラインのスコープでオーバーライドされない限り、ジョブのスコープで継承されます。
例
screwdriver.yamlの全容は以下の通り:
shared:
image: node:lts
parameters:
skip_test: ["no", "yes"]
test_coverage:
value: "80"
description: "test coverage threshold percentage"
jobs:
deploy_stage:
requires: [~pr, ~commit]
parameters:
test_coverage: "60"
region: "us-east-1"
az:
value: ["use1-az1", "use1-az2"]
description: "availability zone"
steps:
- step_print_pramaeters: |
echo skip_test = $(meta get parameters.skip_test)
echo test_coverage = $(meta get parameters.test_coverage)
echo region = $(meta get parameters.region)
echo az = $(meta get parameters.az)
deploy_prod:
requires: deploy_stage
parameters:
region: "us-west-2"
az:
value: ["usw2-az1", "usw2-az2"]
description: "availability zone"
steps:
- step_print_pramaeters: |
echo skip_test = $(meta get parameters.skip_test)
echo test_coverage = $(meta get parameters.test_coverage)
echo region = $(meta get parameters.region)
echo az = $(meta get parameters.az)
ビルドで利用されるパラメーターはSetup -> sd-setup-initステップで確認することができます。
パイプラインの動作イメージ:
ビルドのサンプル
- パイプラインのスコープでのみパラメーターが定義されているサンプルは、parameters-build-sampleをご覧ください。
- パイプラインとジョブの両方のスコープでパラメーターが定義されているサンプルは、job-parameters-build-exampleをご覧ください。