feat(codebuild): add support of organization webhook in github source #31740

dviryamin · 2024-10-12T17:54:13Z

Issue # (if applicable)

Reason for this change

Currently, the AWS CDK aws-codebuild module lacks native support for creating GitHub organization-level webhooks through the Source construct. Users need to manually use the CfnProject to enable organization webhooks, which adds complexity and inconsistency to the CodeBuild setup. This PR introduces support for creating GitHub organization webhooks directly within the Source construct, streamlining the experience and making it more consistent with the rest of the AWS CDK's high-level constructs.

Description of changes

Enhanced the GitHubSource construct in the aws-codebuild module to support GitHub organization webhooks.
Updated the GitHubSource construct's configuration to so when repo is not specified an organization webhook is created.
Added filter of REPOSITORY_NAME to FilterGroups.

Description of how you validated changes

Added unit tests to validate that organization-level webhooks are created correctly when repo is not specified.
Ran integration tests to ensure that the changes do not break any existing functionality related to project webhooks.
Tested deployment of a CodeBuild project with organization webhook setup in a sample CDK application to verify end-to-end functionality.

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.

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

shivatalwar · 2024-10-20T04:58:45Z

This is great - any blockers on getting this merged

GavinZZ · 2024-10-24T21:46:28Z

@dviryamin do you need any help with the failed integ test?

dviryamin · 2024-10-25T00:04:06Z

Hi @GavinZZ,
Thank you for offering to help! I’ve updated the integration test snapshot with the new default image, so the tests should pass now. I’d really appreciate it if you could take a moment to review the PR when you have time. Looking forward to your feedback!

GavinZZ

Left some questions and feedback. Mainly for my own understanding.

GavinZZ · 2024-10-25T00:25:30Z

packages/aws-cdk-lib/aws-codebuild/lib/source.ts

+        ? {
+          ...superConfig.buildTriggers,
+          scopeConfiguration: {
+            name: this.organization,


I'm not too familiar with organization webhook with github source, but I'm reading this official documentation https://docs.aws.amazon.com/codebuild/latest/userguide/github-global-organization-webhook-setup.html.

Hopefully you can help answer my clarifying questions to help me review this PR. In the above link step 2, it mentions set the scope configuration to either GITHUB_ORGANIZATION or GITHUB_GLOBAL, but step 3 says use the organization name as scope.

Step 2 it's a toggle between GitHub Global (for enterprise level webhooks) and GitHub Organization (for organization webhooks).
In step 3 you specify the Enterprise name or the Organization name depending on what you choose in step 2.
Anyway, cloudformation only supports Organization webhooks as mentioned here.

GavinZZ · 2024-10-25T00:31:42Z

packages/@aws-cdk-testing/framework-integ/test/aws-codebuild/test/integ.github-org-webhook.ts

+        codebuild.FilterGroup.inEventOf(
+          codebuild.EventAction.WORKFLOW_JOB_QUEUED,
+        )
+          .andRepositoryNameIs('aws-cdk.*')


I assume this refers to repository name, is this saying a repository name that

starts with aws-cdk. or (if this is the case, I assume no repo is named like this and is this just for demo purpose showing how to use regex)?

starts with aws-cdk and .* is regex saying one or more at the end

It means repository name that starts with aws-cdk and can have more characters after that.
.* means zero or more characters.
If you have a better example for demonstrating usage of regex pattern it will be great.

GavinZZ · 2024-10-25T19:06:22Z

packages/aws-cdk-lib/aws-codebuild/test/project.test.ts

+    Template.fromStack(stack).hasResourceProperties('AWS::CodeBuild::Project', {
+      Source: {
+        Type: 'GITHUB',
+        Location: 'CODEBUILD_DEFAULT_WEBHOOK_SOURCE_LOCATION',
+      },
+      Triggers: {
+        ScopeConfiguration: {
+          Name: 'testowner',
+        },
+      },
+    });
+  });


can we also test webhookFilter here since webhook filter's logic also changes if it's organization github source.

Yeah I'll add tests for FilterGroups.

Pull request has been modified.

mergify · 2024-10-28T17:11:51Z

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 · 2024-10-28T17:44:44Z

AWS CodeBuild CI Report

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

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

mergify · 2024-10-28T17:45:12Z

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 · 2024-10-28T17:45:29Z

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.

dviryamin added 3 commits October 11, 2024 17:08

Add support for github organization webhooks

07b8637

Update README

e293c53

Add organization webhook test

6347928

aws-cdk-automation requested a review from a team October 12, 2024 17:54

github-actions bot added effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK labels Oct 12, 2024

aws-cdk-automation previously requested changes Oct 12, 2024

View reviewed changes

dviryamin changed the title ~~feat(codebuild): Add support of organization webhook in github source~~ feat(codebuild): add support of organization webhook in github source Oct 12, 2024

aws-cdk-automation added the pr/reviewer-clarification-requested The contributor has requested clarification on feedback, a failing build, or a failing PR Linter run label Oct 12, 2024

dviryamin added 3 commits October 12, 2024 21:29

Merge branch 'main' into organization-webhook

e075a94

Fix webhook filters

974a3b1

Fix webhook filters

eb2ad23

dviryamin marked this pull request as ready for review October 12, 2024 20:40

Add integration test

239bc1b

aws-cdk-automation removed the pr/reviewer-clarification-requested The contributor has requested clarification on feedback, a failing build, or a failing PR Linter run label Oct 12, 2024

dviryamin added 5 commits October 14, 2024 08:46

Fix diff in integration tests

fad2212

Merge branch 'main' into organization-webhook

8fcecef

Update integration test

b43a9de

Update integration test

8169b82

Update integration tests

0b1867c

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

dviryamin added 3 commits October 17, 2024 20:57

Merge branch 'main' into organization-webhook

19e7884

Merge branch 'main' into organization-webhook

09f3024

Merge branch 'main' into organization-webhook

cdb491d

dviryamin requested a review from aws-cdk-automation October 22, 2024 00:44

Merge branch 'main' into organization-webhook

ba7496d

dviryamin added 3 commits October 23, 2024 05:19

Merge branch 'main' into organization-webhook

1c21723

Merge branch 'main' into organization-webhook

cdc704f

Merge branch 'main' into organization-webhook

2de92fd

GavinZZ self-requested a review October 24, 2024 21:46

dviryamin added 4 commits October 24, 2024 23:10

Update github project default image in integration test

ebc4c9c

revert manually update template

da7f567

Try update template again

a972825

Merge branch 'main' into organization-webhook

e84ae63

dviryamin added 2 commits October 25, 2024 13:16

Merge branch 'main' into organization-webhook

0772096

Merge branch 'main' into organization-webhook

c6f44cc

GavinZZ previously requested changes Oct 25, 2024

View reviewed changes

aws-cdk-automation removed pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. labels Oct 25, 2024

Add tests for filtergroups using organization webhook

c8c5f0b

Merge branch 'main' into organization-webhook

6cf830d

dviryamin requested a review from GavinZZ October 26, 2024 21:45

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

GavinZZ approved these changes Oct 28, 2024

View reviewed changes

Merge branch 'main' into organization-webhook

12d9825

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Oct 28, 2024

mergify bot merged commit 8c15b5f into aws:main Oct 28, 2024
12 checks passed

github-actions bot locked as resolved and limited conversation to collaborators Oct 28, 2024

dviryamin deleted the organization-webhook branch October 28, 2024 17:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(codebuild): add support of organization webhook in github source #31740

feat(codebuild): add support of organization webhook in github source #31740

dviryamin commented Oct 12, 2024 •

edited

Loading

aws-cdk-automation left a comment

shivatalwar commented Oct 20, 2024

GavinZZ commented Oct 24, 2024

dviryamin commented Oct 25, 2024

GavinZZ left a comment

GavinZZ Oct 25, 2024

dviryamin Oct 26, 2024

GavinZZ Oct 25, 2024

dviryamin Oct 26, 2024 •

edited

Loading

GavinZZ Oct 25, 2024

dviryamin Oct 26, 2024

dviryamin Oct 26, 2024

mergify bot commented Oct 28, 2024

aws-cdk-automation commented Oct 28, 2024

mergify bot commented Oct 28, 2024

github-actions bot commented Oct 28, 2024

feat(codebuild): add support of organization webhook in github source #31740

feat(codebuild): add support of organization webhook in github source #31740

Conversation

dviryamin commented Oct 12, 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

shivatalwar commented Oct 20, 2024

GavinZZ commented Oct 24, 2024

dviryamin commented Oct 25, 2024

GavinZZ left a comment

Choose a reason for hiding this comment

GavinZZ Oct 25, 2024

Choose a reason for hiding this comment

dviryamin Oct 26, 2024

Choose a reason for hiding this comment

GavinZZ Oct 25, 2024

Choose a reason for hiding this comment

dviryamin Oct 26, 2024 • edited Loading

Choose a reason for hiding this comment

GavinZZ Oct 25, 2024

Choose a reason for hiding this comment

dviryamin Oct 26, 2024

Choose a reason for hiding this comment

dviryamin Oct 26, 2024

Choose a reason for hiding this comment

mergify bot commented Oct 28, 2024

aws-cdk-automation commented Oct 28, 2024

AWS CodeBuild CI Report

mergify bot commented Oct 28, 2024

github-actions bot commented Oct 28, 2024

dviryamin commented Oct 12, 2024 •

edited

Loading

dviryamin Oct 26, 2024 •

edited

Loading