Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

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

Open
2 tasks
wilhen01 opened this issue Aug 2, 2024 · 5 comments
Labels
@aws-cdk/aws-codepipeline Related to AWS CodePipeline effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 pr/work-in-progress This PR is a draft and needs further work.

Comments

@wilhen01
Copy link
Contributor

wilhen01 commented Aug 2, 2024

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

Previously raised as #29124 but the fix was reverted so opening this to track progress on actually getting it implemented.

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

@wilhen01 wilhen01 added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Aug 2, 2024
@github-actions github-actions bot added the @aws-cdk/aws-codepipeline Related to AWS CodePipeline label Aug 2, 2024
@einstein-aws
Copy link

I submitted this feature request initially in #29124 and I would love it see it added. Thanks!

@wilhen01
Copy link
Contributor Author

wilhen01 commented Aug 2, 2024

There also appears to be a draft PR #30516 which goes some way to implementing this issue?

@ashishdhingra ashishdhingra added investigating This issue is being investigated and/or work is in progress to resolve the issue. and removed needs-triage This issue or PR still needs to be triaged. labels Aug 2, 2024
@ashishdhingra ashishdhingra self-assigned this Aug 2, 2024
@ashishdhingra
Copy link
Contributor

The workaround mentioned here is to use escape hatch. The filters Branches and FilePaths mentioned at AWS::CodePipeline::Pipeline GitPushFilter are missing from GitPushFilter.

The PR #30516 appears to deprecate existing filters in favor of CodeStarSourceConnection Source Action as in file diff.

@ashishdhingra ashishdhingra added effort/medium Medium work item – several days of effort pr/work-in-progress This PR is a draft and needs further work. and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. labels Aug 2, 2024
@ashishdhingra ashishdhingra removed their assignment Aug 2, 2024
@shandc007
Copy link

Any update on #31009? The escape hatch is also not working

@ewanmellor
Copy link

@shandc007 This escape hatch worked for me:

        const branch = 'my-branch-name'

        ;(pipeline.node.defaultChild as CfnPipeline).addPropertyOverride(
            'Triggers.0.GitConfiguration.Push',
            [
                {
                    Branches: {
                        Includes: [branch],
                    },
                },
            ],
        )

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
@aws-cdk/aws-codepipeline Related to AWS CodePipeline effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 pr/work-in-progress This PR is a draft and needs further work.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants