feat(codepipeline): `GitPullRequestFilter` for pipeline trigger #29128

go-to-k · 2024-02-16T06:06:24Z

Issue # (if applicable)

Closes #29126.

Related PR: #29127
Perhaps if one merges, the other will cause a conflict.

Reason for this change

We would be good to trigger pipelines by git pull request filters.

CFn and API docs

Description of changes

Add gitPullRequestFilter parameter with new interface into GitConfiguration interface.

Description of how you validated changes

Both unit and integ tests.

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

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.

go-to-k · 2024-02-16T06:12:55Z

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

+/**
+ * Event for trigger with pull request filter.
+ */
+export enum GitPullRequestEvent {
+  /**
+   * OPEN
+   */
+  OPEN = 'OPEN',
+  /**
+   * UPDATED
+   */
+  UPDATED = 'UPDATED',
+  /**
+   * CLOSED
+   */
+  CLOSED = 'CLOSED',
+}


from the API doc.
https://docs.aws.amazon.com/codepipeline/latest/APIReference/API_GitPullRequestFilter.html

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

go-to-k · 2024-02-25T13:10:36Z

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

+      if (pushFilter?.length && pullRequestFilter?.length) {
+        throw new Error(`cannot specify both pushFilter and pullRequestFilter for the trigger with sourceAction with name '${sourceAction.actionProperties.actionName}'`);
+      }
+      if (!pushFilter?.length && !pullRequestFilter?.length) {
+        throw new Error(`must specify either pushFilter or pullRequestFilter for the trigger with sourceAction with name '${sourceAction.actionProperties.actionName}'`);
+      }


If there is no this validation, the error occurred in CFn.

The trigger configuration for the source action is not valid. Make sure to choose one trigger configuration for each source action.

go-to-k · 2024-02-25T13:42:05Z

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

+        // set to all events if empty array or undefined because CloudFormation does not accept empty array and undefined
+        const events: string[] = filter.events?.length ? Array.from(new Set(filter.events)) : [
+          GitPullRequestEvent.OPEN,
+          GitPullRequestEvent.UPDATED,
+          GitPullRequestEvent.CLOSED,
+        ];


The CDK code and CFn with events as an empty array or undefined will occur.

The trigger configuration for the source action is not valid. Make sure to choose one trigger configuration for each source action.

In addition, You must select at least one pull request event. is displayed in AWS console.

change

GavinZZ

As mentioned, going to approve and merge this PR again. We can always have follow-up PR to improve it.

mergify · 2024-05-13T19:23:47Z

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

Pull request has been modified.

aws-cdk-automation · 2024-05-13T21:37:39Z

AWS CodeBuild CI Report

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

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

mergify · 2024-05-13T21:38:00Z

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

…trigger (#29127) ### Issue # (if applicable) Closes #29124 Related PR: #29128 Perhaps if one merges, the other will cause a conflict. ### Reason for this change We would be good to trigger pipelines by GitPushFilter with branches and file paths. - CFn docs - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitpushfilter.html - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitbranchfiltercriteria.html - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitfilepathfiltercriteria.html ### Description of changes Add props: - branchesExcludes - branchesIncludes - filePathsExcludes - filePathsIncludes ### Description of how you validated changes Both unit and integ tests. ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

…er (#29128)" This reverts commit 5ce1b64.

…trigger (aws#29127) ### Issue # (if applicable) Closes aws#29124 Related PR: aws#29128 Perhaps if one merges, the other will cause a conflict. ### Reason for this change We would be good to trigger pipelines by GitPushFilter with branches and file paths. - CFn docs - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitpushfilter.html - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitbranchfiltercriteria.html - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-gitfilepathfiltercriteria.html ### Description of changes Add props: - branchesExcludes - branchesIncludes - filePathsExcludes - filePathsIncludes ### Description of how you validated changes Both unit and integ tests. ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

feat(codepipeline): GitPullRequestFilter for pipeline trigger

1da6da4

aws-cdk-automation requested a review from a team February 16, 2024 06:06

github-actions bot added feature-request A feature should be added or improved. p2 distinguished-contributor [Pilot] contributed 50+ PRs to the CDK labels Feb 16, 2024

aws-cdk-automation previously requested changes Feb 16, 2024

View reviewed changes

go-to-k commented Feb 16, 2024

View reviewed changes

github-actions bot added the effort/medium Medium work item – several days of effort label Feb 17, 2024

go-to-k mentioned this pull request Feb 17, 2024

feat(codepipeline): GitPushFilter with branches and file paths for trigger #29127

Merged

1 task

go-to-k added 10 commits February 18, 2024 02:57

validate filePaths without branches

bea84bc

tweak style

2e5c2af

change unit tests

6b1189d

add unit tests

a75b405

default for events

6fff573

README

7b32764

add validation for both pushFilter and pullRequestFilter

c61b165

Merge branch 'main' into pipeline-trigger-pull-request

66c87f8

refactor

e112c34

integ test

fe37ea7

go-to-k marked this pull request as ready for review February 22, 2024 16:43

go-to-k changed the title ~~feat(codepipeline): GitPullRequestFilter for pipeline trigger~~ feat(codepipeline): gitPullRequestFilter for pipeline trigger Feb 22, 2024

modify unit test

b5c6039

go-to-k changed the title ~~feat(codepipeline): gitPullRequestFilter for pipeline trigger~~ feat(codepipeline): GitPullRequestFilter for pipeline trigger Feb 22, 2024

go-to-k marked this pull request as draft February 22, 2024 16:50

add validation

36830a1

go-to-k commented Feb 25, 2024

View reviewed changes

all events

d03b9af

go-to-k commented Feb 25, 2024

View reviewed changes

add validation for branches check

b57a21b

change

GavinZZ previously approved these changes May 13, 2024

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label May 13, 2024

Merge branch 'main' into pipeline-trigger-pull-request

bdb348b

GavinZZ approved these changes May 13, 2024

View reviewed changes

mergify bot merged commit 5ce1b64 into aws:main May 13, 2024
11 checks passed

go-to-k deleted the pipeline-trigger-pull-request branch May 13, 2024 23:58

gracelu0 added a commit that referenced this pull request Jun 6, 2024

Revert "feat(codepipeline): GitPullRequestFilter for pipeline trigg…

9645994

…er (#29128)" This reverts commit 5ce1b64.

gracelu0 mentioned this pull request Jun 6, 2024

revert: "feat(codepipeline): GitPullRequestFilter for pipeline trigger" #30464

Closed

tengell mentioned this pull request Jun 6, 2024

[Snyk] Upgrade aws-cdk-lib from 2.141.0 to 2.142.0 capralifecycle/liflig-cdk#267

Closed

NOUIY mentioned this pull request Jun 7, 2024

[Snyk] Upgrade: , aws-cdk NOUIY/aws-solutions-constructs#102

Open

niravparikh05 mentioned this pull request Jun 13, 2024

[Snyk] Upgrade aws-cdk from 2.65.0 to 2.142.1 paralus/eks-blueprints-addon#3

Open

NOUIY mentioned this pull request Jun 14, 2024

[Snyk] Upgrade: , aws-cdk NOUIY/aws-solutions-constructs#103

Open

snyk-io bot mentioned this pull request Jun 20, 2024

[Snyk] Upgrade aws-cdk-lib from 2.138.0 to 2.143.1 Opetushallitus/heratepalvelu#280

Open

NOUIY mentioned this pull request Jun 20, 2024

[Snyk] Upgrade: , aws-cdk NOUIY/aws-solutions-constructs#104

Open

snyk-io bot mentioned this pull request Jun 21, 2024

[Snyk] Upgrade aws-cdk-lib from 2.139.0 to 2.143.1 Opetushallitus/ovara#36

Open

rwlxxvii mentioned this pull request Jun 22, 2024

[Snyk] Upgrade aws-cdk-lib from 2.139.0 to 2.144.0 rwlxxvii/containers#140

Merged

This was referenced Jun 22, 2024

[Snyk] Upgrade: , aws-cdk NOUIY/aws-solutions-constructs#105

Open

[Snyk] Upgrade: , aws-cdk NOUIY/aws-solutions-constructs#106

Open

This was referenced Jul 5, 2024

[Snyk] Upgrade: , aws-cdk NOUIY/aws-solutions-constructs#107

Open

[Snyk] Upgrade: , aws-cdk NOUIY/aws-solutions-constructs#108

Open

This was referenced Jul 16, 2024

[Snyk] Upgrade: , aws-cdk NOUIY/aws-solutions-constructs#109

Open

[Snyk] Upgrade: , aws-cdk NOUIY/aws-solutions-constructs#110

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(codepipeline): `GitPullRequestFilter` for pipeline trigger #29128

feat(codepipeline): `GitPullRequestFilter` for pipeline trigger #29128

go-to-k commented Feb 16, 2024 •

edited

Loading

aws-cdk-automation left a comment

go-to-k Feb 16, 2024

go-to-k Feb 25, 2024 •

edited

Loading

go-to-k Feb 25, 2024

GavinZZ left a comment •

edited

Loading

mergify bot commented May 13, 2024

aws-cdk-automation commented May 13, 2024

mergify bot commented May 13, 2024

feat(codepipeline): GitPullRequestFilter for pipeline trigger #29128

feat(codepipeline): GitPullRequestFilter for pipeline trigger #29128

Conversation

go-to-k commented Feb 16, 2024 • edited Loading

Issue # (if applicable)

Reason for this change

Description of changes

Description of how you validated changes

Checklist

aws-cdk-automation left a comment

Choose a reason for hiding this comment

go-to-k Feb 16, 2024

Choose a reason for hiding this comment

go-to-k Feb 25, 2024 • edited Loading

Choose a reason for hiding this comment

go-to-k Feb 25, 2024

Choose a reason for hiding this comment

GavinZZ left a comment • edited Loading

Choose a reason for hiding this comment

mergify bot commented May 13, 2024

aws-cdk-automation commented May 13, 2024

AWS CodeBuild CI Report

mergify bot commented May 13, 2024

feat(codepipeline): `GitPullRequestFilter` for pipeline trigger #29128

feat(codepipeline): `GitPullRequestFilter` for pipeline trigger #29128

go-to-k commented Feb 16, 2024 •

edited

Loading

go-to-k Feb 25, 2024 •

edited

Loading

GavinZZ left a comment •

edited

Loading