feat(codepipeline): branches and files support in git push filter L2 construct by hwum · Pull Request #33872 · aws/aws-cdk

hwum · 2025-03-22T02:22:07Z

branches and files in git push filter in codepipeline L2 construct

Refer to the README content of reverted pr:(https://github.com/aws/aws-cdk/pull/30462/files). Credit to @go-to-k

Issue # 31009(#31009)

Reason for this change

Branches and files in git push filter under codepipeline trigger has been supported last year, and cdk library didn't support this feature yet.

Description of changes

Support ranches and files in git push filter under codepipeline trigger.

Describe any new or updated permissions being added

No

Description of how you validated changes

Unit test/Integ test/ local deployment

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

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

aws-cdk-automation

(This review is outdated)

codecov · 2025-03-22T02:30:59Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.35%. Comparing base (b855978) to head (f3f11e3).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #33872   +/-   ##
=======================================
  Coverage   82.35%   82.35%           
=======================================
  Files         120      120           
  Lines        6941     6941           
  Branches     1172     1172           
=======================================
  Hits         5716     5716           
  Misses       1120     1120           
  Partials      105      105

Flag	Coverage Δ
suite.unit	`82.35% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
packages/aws-cdk	`∅ <ø> (∅)`
packages/aws-cdk-lib/core	`82.35% <ø> (ø)`

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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

GavinZZ

LGTM, mostly minor comments.

GavinZZ · 2025-03-25T18:09:09Z

 * Git pull request filter for trigger.
 */
-export interface GitPullRequestFilter {
+export interface GitPullRequestFilter extends GitFilter{


Suggested change

export interface GitPullRequestFilter extends GitFilter{

export interface GitPullRequestFilter extends GitFilter {

GavinZZ · 2025-03-25T18:11:31Z

+  }
+}
+
+function ValidateGitPushFilter(pushFilter: GitPushFilter[], actionName: string) {


Suggested change

function ValidateGitPushFilter(pushFilter: GitPushFilter[], actionName: string) {

function validateGitPushFilter(pushFilter: GitPushFilter[], actionName: string) {

GavinZZ · 2025-03-25T18:11:54Z

+  if (!pushFilter?.length && !pullRequestFilter?.length) {
+    throw new UnscopedValidationError(`must specify either GitPushFilter or GitPullRequestFilter for the trigger with sourceAction with name '${sourceAction.actionProperties.actionName}'`);
+  }
+  if (pushFilter!== undefined) {


Suggested change

if (pushFilter!== undefined) {

if (pushFilter !== undefined) {

GavinZZ · 2025-03-25T18:12:02Z

+  if (pushFilter!== undefined) {
+    ValidateGitPushFilter(pushFilter, sourceAction.actionProperties.actionName);
+  }
+  if (pullRequestFilter!== undefined) {


Suggested change

if (pullRequestFilter!== undefined) {

if (pullRequestFilter !== undefined) {

GavinZZ · 2025-03-25T18:15:08Z

+  });
+}
+
+function validateGitPullRequestFilter(pullRequestFilter: GitPullRequestFilter[], actionName: string) {


Not specific to this line but all the new lines added in this file.

It's really hard to review the validation logics to make sure we don't accidentally introduce breaking change. I appreciate the fact that we're doing synthesis validation to early error out. Curious if there is a way that we can simplify some of the validations and leave it to CFN deployment time?

I"m doing this since I found some ambiguous error msg from codepipeline backend during running integ tests, I believe it will make customer confused. I didn't add any validation check with clear error msg from cp backend.
For the avoiding breaking change, I think the current integ test was working will cover that part.
I'll aslo work on some improvement in our backend part as well

GavinZZ · 2025-03-25T18:17:37Z

+  }
+
+  private getTagsFilterProperty(filter: GitPushFilter) : CfnPipeline.GitTagFilterCriteriaProperty | undefined {
+    return filter.tagsExcludes?.length || filter.tagsIncludes?.length ?{


Suggested change

return filter.tagsExcludes?.length || filter.tagsIncludes?.length ?{

return filter.tagsExcludes?.length || filter.tagsIncludes?.length ? {

Pull request has been modified.

…r in triggers

GavinZZ · 2025-03-25T21:17:44Z

 * Git push filter for trigger.
 */
-export interface GitPushFilter {
+export interface GitPushFilter extends GitFilter{


Suggested change

export interface GitPushFilter extends GitFilter{

export interface GitPushFilter extends GitFilter {

Pull request has been modified.

mergify · 2025-03-25T23:54:08Z

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 · 2025-03-26T00:24:55Z

AWS CodeBuild CI Report

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

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

mergify · 2025-03-26T00:25:21Z

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).

github-actions · 2025-03-26T00:25:37Z

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

github-actions Bot added the p2 label Mar 22, 2025

aws-cdk-automation requested a review from a team March 22, 2025 02:22

github-actions Bot added the beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK label Mar 22, 2025

aws-cdk-automation previously requested changes Mar 22, 2025

View reviewed changes

hwum changed the title ~~feat(aws-codepipeline)branches and files in git push filter in codepipeline L2 construct~~ feat(aws-codepipeline):branches and files in git push filter in codepipeline L2 construct Mar 22, 2025

hwum force-pushed the dev branch from 5480fa0 to 79a1972 Compare March 24, 2025 02:08

hwum changed the title ~~feat(aws-codepipeline):branches and files in git push filter in codepipeline L2 construct~~ feat(codepipeline): branches and files support in git push filter L2 construct Mar 24, 2025

hwum requested a review from aws-cdk-automation March 24, 2025 02:25

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Mar 24, 2025

SimonCMoore added p1 and removed p2 labels Mar 24, 2025

aws-cdk-automation added pr/needs-maintainer-review This PR needs a review from a Core Team Member and removed pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. labels Mar 24, 2025

QuantumNeuralCoder self-assigned this Mar 24, 2025

GavinZZ previously requested changes Mar 25, 2025

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Mar 25, 2025

hwum force-pushed the dev branch from 79a1972 to 812722c Compare March 25, 2025 19:52

feat(aws-codepipeline) add branches & files feature in git push filte…

092f1ce

…r in triggers

hwum force-pushed the dev branch from 812722c to 092f1ce Compare March 25, 2025 19:58

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Mar 25, 2025

GavinZZ previously approved these changes Mar 25, 2025

View reviewed changes

Update packages/aws-cdk-lib/aws-codepipeline/lib/trigger.ts

c265188

GavinZZ approved these changes Mar 25, 2025

View reviewed changes

Merge branch 'main' into dev

f3f11e3

mergify Bot merged commit 45623d6 into aws:main Mar 26, 2025
20 checks passed

github-actions Bot locked as resolved and limited conversation to collaborators Mar 26, 2025

hwum deleted the dev branch March 26, 2025 01:26

	export interface GitPullRequestFilter extends GitFilter{
	export interface GitPullRequestFilter extends GitFilter {

	function ValidateGitPushFilter(pushFilter: GitPushFilter[], actionName: string) {
	function validateGitPushFilter(pushFilter: GitPushFilter[], actionName: string) {

	if (pushFilter!== undefined) {
	if (pushFilter !== undefined) {

	if (pullRequestFilter!== undefined) {
	if (pullRequestFilter !== undefined) {

	return filter.tagsExcludes?.length \|\| filter.tagsIncludes?.length ?{
	return filter.tagsExcludes?.length \|\| filter.tagsIncludes?.length ? {

	export interface GitPushFilter extends GitFilter{
	export interface GitPushFilter extends GitFilter {

Conversation

hwum commented Mar 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue # 31009(#31009)

Reason for this change

Description of changes

Describe any new or updated permissions being added

Description of how you validated changes

Checklist

Uh oh!

aws-cdk-automation left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented Mar 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

GavinZZ left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mergify Bot commented Mar 25, 2025

Uh oh!

aws-cdk-automation commented Mar 26, 2025

AWS CodeBuild CI Report

Uh oh!

mergify Bot commented Mar 26, 2025

Uh oh!

Uh oh!

github-actions Bot commented Mar 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

hwum commented Mar 22, 2025 •

edited

Loading

aws-cdk-automation left a comment •

edited

Loading

codecov Bot commented Mar 22, 2025 •

edited

Loading