パラメータおよびパラメータ・リストの追加またはエクスポート
同じパイプライン内のダウンストリーム・ジョブで使用できるパイプライン・ジョブのパラメータを設定または変更できます。 または、Gitクローン操作からのデータに基づいて、クローニングされたリポジトリに新しいパラメータの値になる情報または既存パラメータの値をオーバーライドする情報が含まれている場合に、ジョブ実行の開始時にパラメータを追加することもできます。 このパラメータを使用して、後で実行するジョブを構成し、ビルドで実行されるシェル・スクリプトの環境変数として表示できます。 ビルド中に計算されたデータに基づいて、ジョブ実行の最後にパラメータをエクスポートすることもできます。
追加されたパラメータとエクスポートされたパラメータは両方ともダウンストリーム・ジョブに表示され、パラメータのサブセットを変更してから渡すことができます。
- シェル・スクリプトで環境変数を設定する場合と同じ方法で記述されるパラメータ定義のリストから、つまり、
PARAMETER_NAME=value定義を含む1つ以上の行を含むファイルから記述します。 - たとえば、秘密キーなどの複数行の値、パスワードや秘密キーなどの機密コンテンツを含むパラメータ。 これらには、単純な定義形式を使用して指定できるアイテムよりも複雑なアイテムが含まれます。
パイプライン内のすべてのジョブには、現在、パイプライン内のすべてのジョブに対して構成されているジョブ・パラメータが表示されます。 これらのパラメータは、パイプラインが開始されるとジョブから収集され、パイプラインを開始した条件の下流であるすべてのジョブ(手動で起動または定期的にトリガーされるパイプラインのトリガー・ジョブまたは開始ノード)に追加されます。 その後、ジョブが完了すると、そのパラメータが抽出され、トリガーしたダウンストリーム・ジョブに渡されます。
これらのジョブ・パラメータは変更でき、実行中に後続の作成ステップで新しいパラメータを追加できます。 これにより、シェル・スクリプトのように、ビルド・ステップの前と後の両方でパラメータを追加するように明示的に指示する方法が追加されます。
パラメータの追加
「パラメータの追加」タスクはビルド設定中に、Gitステップの実行が終了した後、ビルド・ステップが実行される前に実行されます。 このタスクでは、一度に1つのパラメータが追加され、ファイルからの複数行の値(秘密キーなど)を読み取ることができる可能性があり、そのパラメータには機密のマークを付けることができます。この方法では、ビルド・ログにこれらの値を出力しないことを意味します。 これらのうちの0個以上をジョブで構成できます。
ここでは、ビルド・ジョブにパラメータ(または複数のパラメータ)を追加するビルド前タスクを構成する方法を示します:
- 左側のナビゲータで、「ビルド」
をクリックします。
- ジョブの概要ページで、変更するジョブを選択し、「ジョブ詳細」ページが表示されます。
- 「構成」をクリックします。
「ジョブ構成」ページが表示されます。
- Gitタブで「Gitの追加」をクリックし、パラメータを含むファイルが格納されているリポジトリを選択します。
- 「ビルド前」タブをクリックします。
- 「ビルド前に追加アクション」をクリックし、「パラメータの追加」を選択します。
- 「パラメータ名」に、パラメータの名前を入力します。
- 「パラメータ値を含むファイル」に、パラメータの値を含むファイルの名前を入力します。
- 「機密」チェック・ボックスを選択して、パスワードや秘密キーのパラメータなどの機密コンテンツを含むパラメータの値をビルド・ログに出力しないようにします。
- ステップ6-8を繰り返して、複数のパラメータを追加します。
- 「保存」をクリックします。
パラメータ・リストの追加
「パラメータ・リストの追加」タスクはビルド設定中に、Gitステップの実行が終了した後、ビルド・ステップが実行される前に実行されます。 タスクは、PARAMETER_NAME=valueの形式で1つ以上のパラメータ定義のリストを1行ごとに1つ読み取り、それに応じてジョブ・パラメータを設定します。 これらのうちの0個以上をジョブで構成できます。
ここでは、パラメータ・リストをビルド・ジョブに追加する事前構築タスクを構成する方法を示します:
- 左側のナビゲータで、「ビルド」
をクリックします。
- ジョブの概要ページで、変更するジョブを選択し、「ジョブ詳細」ページが表示されます。
- 「構成」をクリックします。
「ジョブ構成」ページが表示されます。
- Gitタブで「Gitの追加」をクリックし、パラメータ・リストを含むファイルが格納されているリポジトリを選択します。
- 「ビルド前」タブをクリックします。
- 「ビルド前に追加アクション」をクリックし、「パラメータ・リストの追加」を選択します。
- パラメータ定義を含むファイルの名前を入力します。
- 「保存」をクリックします。
パラメータのエクスポート
「パラメータのエクスポート」タスクは、ビルド・ステップの実行後に実行されます。 このタスクでは、複数行の値(秘密キーなど)をファイルから読み取れるように、一度に1つのパラメータを追加します。 また、パラメータに機密のマークを付けることもでき、その方法では、これらの値をビルド・ログに出力しません。 これらのうちの0個以上をジョブで構成できます。
下流ビルド・ジョブに渡すことができるパラメータ(または複数のパラメータ)をエクスポートするビルド後タスクを構成するには、次の手順を実行します:
- 左側のナビゲータで、「ビルド」
をクリックします。
- ジョブの概要ページで、変更するジョブを選択し、「ジョブ詳細」ページが表示されます。
- 「構成」をクリックします。
「ジョブ構成」ページが表示されます。
- Gitタブで「Gitの追加」をクリックし、パラメータの値が書き込まれるファイルを含むリポジトリを選択します。
- 「ビルド後」タブをクリックします。
- 「ビルド・アクション後に追加」をクリックし、「エクスポート・パラメータ」を選択します。
- 「パラメータ名」に、エクスポートするパラメータの名前を入力します。
- 「パラメータ値を含むファイル」に、パラメータの値を書き込むファイルの名前を入力します。
- 「機密」チェック・ボックスを選択して、パスワードや秘密キーのパラメータなどの機密コンテンツを含むパラメータの値をビルド・ログに出力しないようにします。
- ステップ6-8を繰り返して、複数のパラメータをエクスポートします。
- 「保存」をクリックします。
パラメータ・リストのエクスポート
「パラメータ・リストのエクスポート」タスクは、ビルド・ステップの実行後に実行されます。 タスクは、PARAMETER_NAME=valueの形式で1つ以上のパラメータ定義のリストを1行ごとに1つ読み取り、それに応じてジョブ・パラメータを設定します。 これらのうちの0個以上をジョブで構成できます。
下流ビルド・ジョブで使用できるパラメータ・リストをエクスポートするビルド後タスクを構成する方法を次に示します:
- 左側のナビゲータで、「ビルド」
をクリックします。
- ジョブの概要ページで、変更するジョブを選択し、「ジョブ詳細」ページが表示されます。
- 「構成」をクリックします。
「ジョブ構成」ページが表示されます。
- Gitタブで「Gitの追加」をクリックし、パラメータ・リストの値が書き込まれるファイルを含むリポジトリを選択します。
- 「ビルド後」タブをクリックします。
- 「ビルド・アクション後に追加」をクリックし、「パラメータ・リストのエクスポート」を選択します。
- ビルド・ジョブで使用されるパラメータ定義が書き込まれるファイルの名前を入力します。
- 「保存」をクリックします。