codepipeline: Add Branches and File Paths to CodePipeline pipeline GitPushFilter configuration

[einstein-aws]

Describe the feature

Currently, as it seems, only tag-based filters are available (or exposed) in CodePipeline pipeline GitPushFilter configuration via tagsExcludes and tagsIncludes parameters. However, both Branches and FilePaths options exist in CloudFormation spec https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitpushfilter.html Can you please add the two missing configuration parameters? Thanks!

Use Case

Branch-based pipeline trigger.

Proposed Solution

Add branchesExclude, branchesInclude, filePathsExclude and filePathsInclude parameters to match CloudFormation spec.

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

CDK version used

v2.128.0 (TypeScript)

Environment details (OS name and version, etc.)

MacOS Sonoma 14.3.1

[go-to-k]

I will take this issue.

[vumdao]

@go-to-k Can you please update for packages/aws-cdk-lib/pipelines/lib/codepipeline/codepipeline.ts either? Thanks.

[go-to-k]

@vumdao

The pipelines module already seems to be quite different in structure from aws-codepipeline. It might be better if you could create a separate issue with specific use cases.
In the meantime, we can pass existing pipelines to props, so that might help us meet the requirements even before we have to deal with that.

https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/pipelines/README.md#using-an-existing-aws-codepipeline

[pahud]

Awesome! Thank you for picking this up with a PR. @go-to-k

[jmihalich]

+1 for adding this to the cdk CodePipeline construct. I've been waiting for this.

Joe

[mostafafarzaneh]

+1 for this feature. Is there any update?

[go-to-k]

The PR is awaiting review, so please be patient.

If the number of thumbs-up reactions (👍) to this issue is high, it will be given priority for review. So please do.

[github-actions]

This issue has received a significant amount of attention so we are automatically upgrading its priority. A member of the community will see the re-prioritization and provide an update on the issue.

[mglubb]

For those still needing this, pending the PR being merged, you can use the cdk escape hatch. E.g.

const cfnPipeline = pipeline.node.defaultChild as CfnPipeline;
cfnPipeline.addPropertyOverride('Triggers', [
  {
    GitConfiguration: {
      Push: [
        {
          Branches: {
            Includes: ['main'],
          },
        },
      ],
      SourceActionName: 'MySourceName',
    },
    ProviderType: 'CodeStarSourceConnection',
  }
]);

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

[wilhen01]

Can we reopen this issue since the fix was reverted?

[dguisinger]

Can we reopen this issue since the fix was reverted?

@go-to-k see @wilhen01's message above. It looks like this change was reverted.

[go-to-k]

Perhaps the reopening can only be done by maintainers. Therefore, creating a new issue is good.

[wilhen01]

Re-raised as #31009

[dguisinger]

Re-raised as #31009

@wilhen01 there appear to be a tangled mess of cross-referencing issues and pull requests I was digging through last night while trying to figure out how to get this to work on my project. It appears this was rejected because it didn't meet the standards of how the CDK team wants to do things, and there has been a draft pull request sitting out there since June 10th: #30516

However there has been no movement for 45 days

[wilhen01]

Thanks @dguisinger - I've mentioned that in the new issue.

[jamierbower]

@mglubb Thanks for posting the work around using escape hatches.

I have tried implementing that fix, however when I try to deploy I am getting the following error: "Triggers for connections must reference a CodeStarSourceConnection action."

Am I right in thinking the value for "SourceActionName" should be the same as the "Name" property of the Source stage in my pipeline?