事前定義された変数の使用

事前定義された変数は、ワークフローによって自動的に出力され、ワークフローアクションで使用できるようにするキーと値のペアです。

事前定義された変数は、任意のワークフローアクションで使用できます。

事前定義された変数の参照

事前定義された変数を参照するには、以下の手順に従います。

前提条件

など、参照する事前定義された変数の名前を決定しますCommitId。詳細については、「ワークフローが出力する事前定義された変数の決定」を参照してください。

Visual

使用できません。YAML を選択して YAML の手順を表示します。

YAML

事前定義された変数を参照するには (YAML エディタ）

1. https://codecatalyst.aws/ で CodeCatalyst コンソールを開きます。

2. プロジェクトを選択します。

3. ナビゲーションペインで CI/CD を選択し、ワークフロー を選択します。

4. ワークフローの名前を選択します。ワークフローが定義されているソースリポジトリまたはブランチ名でフィルタリングすることも、ワークフロー名でフィルタリングすることもできます。

5. [編集] を選択します。

6. YAML を選択します。

7. CodeCatalyst アクションで、次の構文を使用して事前定義された変数リファレンスを追加します。

   ${action-group-name.action-name-or-WorkflowSource.variable-name}

   置換:

   • action-group-name アクショングループの名前。

     注記

     アクショングループaction-group-nameがない場合、または変数が同じアクショングループ内のアクションによって生成される場合は、 を省略できます。

   • action-name-or-WorkflowSource と：

     変数を出力するアクションの名前。

     または

     WorkflowSource変数が BranchNameまたは CommitId変数の場合、。

   • variable-name と変数の名前。

   例:

   MySecondAction:
       Configuration:
         Steps:
           - Run: echo ${MyFirstECSAction.cluster}

   別の例を紹介します。

   MySecondAction:
       Configuration:
         Steps:
           - Run: echo ${WorkflowSource.CommitId}

   その他の例については、「事前定義された変数の例」を参照してください。詳細については、アクションのワークフロー YAML 定義「」を参照してください。

8. （オプション) 検証 を選択して、コミットする前にワークフローの YAML コードを検証します。

9. コミット を選択し、コミットメッセージを入力し、もう一度コミット を選択します。

ワークフローが出力する事前定義された変数の決定

ワークフローが出力する事前定義された変数は、次の 2 つの方法で判断できます。

• ワークフローを 1 回実行します。実行が完了すると、ワークフローによって出力される変数が、実行の詳細ページの変数タブに表示されます。詳細については、「ワークフローの実行ステータスと詳細の表示」を参照してください。

• を参照してください事前定義された変数のリスト。このリファレンスには、事前定義された各変数の変数名 (キー) と値が一覧表示されます。

注記

ワークフローの変数の最大合計サイズは、 に記載されていますワークフローのクォータ。合計サイズが最大値を超えると、最大値に達した後に実行されるアクションが失敗する可能性があります。

事前定義された変数の例

次の例は、ワークフロー定義ファイルで事前定義された変数を参照する方法を示しています。

例

• 例：「」のCommitId事前定義された変数を参照する
• 例：「」のBranchName事前定義された変数を参照する

例：「」のCommitId事前定義された変数を参照する

次の例は、 MyBuildActionアクションでCommitId事前定義された変数を参照する方法を示しています。CommitId 変数は によって自動的に出力されます CodeCatalyst。

この例では、ビルドアクションで使用されている変数を示していますが、任意のアクションCommitIdで を使用できます。

MyBuildAction:
    Identifier: aws/build@v1
    Inputs:
      Sources:
        - WorkflowSource
    Configuration:
      Steps:
      #Build Docker image and tag it with a commit ID
        - Run: docker build -t image-repo/my-docker-image:latest .
        - Run: docker tag image-repo/my-docker-image:${WorkflowSource.CommitId}

例：「」のBranchName事前定義された変数を参照する

次の例は、 CDKDeployアクションでBranchName事前定義された変数を参照する方法を示しています。BranchName 変数は によって自動的に出力されます CodeCatalyst。

この例では、AWS CDK デプロイアクションで使用されている変数を示していますが、任意のアクションBranchNameで を使用できます。

CDKDeploy:
    Identifier: aws/cdk-deploy@v1
    Inputs:
      Sources:
        - WorkflowSource
    Configuration:
      StackName: app-stack-${WorkflowSource.BranchName}