feat(codepipeline): pipeline type v2 with pipeline-level variables and triggers

[go-to-k]

This PR supports pipeline type v2 with pipeline-level variables and triggers.

When referring to a variable in pipeline actions, it must be specified according to the format #{variables.variableName}. In order to avoid the need to specify directly in this form, a new class Variable with a reference() method was created.

const myVariable = new codepipeline.Variable({
  variableName: 'bucket-var',
  description: 'description',
  defaultValue: 'sample',
});

const pipeline = new codepipeline.Pipeline(stack, 'Pipeline', {
  artifactBucket: sourceBucket,
  pipelineType: codepipeline.PipelineType.V2,
  variables: [myVariable],
  stages: [
    {
      stageName: 'Source',
      actions: [sourceAction],
    },
    {
      stageName: 'Deploy',
      actions: [
        new S3DeployAction({
          actionName: 'DeployAction',
          extract: false,
          // objectKey: '#{variables.bucket-var}.txt',
          objectKey: `${myVariable.reference()}.txt`,
          input: sourceOutput,
          bucket: deployBucket,
        }),
      ],
    },
  ],
});

• user guide
  • https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-types-planning.html
  • https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-variables.html#reference-variables-workflow
  • https://docs.aws.amazon.com/codepipeline/latest/userguide/tutorials-github-tags.html
• CloudFormation
  • https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html
  • https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-variabledeclaration.html
  • https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-pipelinetriggerdeclaration.html

Closes #28476 #28694.

---

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

[aws-cdk-automation]

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

[go-to-k]

@kaizencc

I have changed the followings as well as your comments. Could you please confirm them?

• add addTrigger() method to Pipeline construct.
• change Trigger from interface to class.
• change the property names to tagsExcludes and tagsIncludes.
  • See this thread.
• Others
  • validate a length of gitPushFilter.
    • CFn does not allow empty pushFilter, but it can be allowed for user-friendly in CDK.
  • validate duplicated variables and triggers with duplicate source action.

[kaizencc]

I think this looks great @go-to-k! Thanks for adding these features in!

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: 0cf9190
• Result: SUCCEEDED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

[mikelhamer]

@go-to-k did the typescript type definitions get updated for this? I am on the latest version 2.128.0 but my project won't build due to this error:

error TS2353: Object literal may only specify known properties, and 'pipelineType' does not exist in type 'CodePipelineProps'.

[go-to-k]

@mikelhamer

Perhaps you have not "npm/yarn install"?

It's working correctly in my environment with v2.128.0.

[mikelhamer]

@mikelhamer

Perhaps you have not "npm/yarn install"?

It's working correctly in my environment with v2.128.0.

I realized it's because I'm using the CDK CodePipline construct vs the Pipeline construct this feature you made is for

[go-to-k]

I could confirm to work and deploy with the released CDK, not in this repository with this branch.

[go-to-k]

My sample code repository.
https://github.com/go-to-k/cdk-codepipeline-v2-sample

[AllanOricil]

@go-to-k thank you