feat(codebuild): add `startBatchBuild` option #11743

tjenkinson · 2020-11-26T22:15:45Z

This adds a startBatchBuild option to the code build source, to trigger a batch build. The cloudformation property isn't in the official docs yet but is mentioned here.

Closes #11663

gitpod-io · 2020-11-26T22:15:48Z

tjenkinson · 2020-11-27T22:00:01Z

@skinny85 do you know why BuildType is not appearing in the template? There are no type errors and buildType on buildTriggers also exists in the (generated) types.

I guess somewhere else needs updating?

Edit: nevermind, Just spotted the problem :|

skinny85

Awesome contribution @tjenkinson ! Just a few questions/comments before I "ShipIt".

packages/@aws-cdk/aws-codebuild/test/test.codebuild.ts

packages/@aws-cdk/aws-codebuild/README.md

skinny85 · 2020-11-30T16:55:09Z

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

@@ -482,6 +482,13 @@ interface ThirdPartyGitSourceProps extends GitSourceProps {
   */
  readonly webhook?: boolean;

+  /**
+   * Start a batch build when the webhook is triggered instead of a standard one.


The "when the webhook is triggered" is an interesting statement. So this setting works only for builds started through the webhook? Not through, for instance, CloudWatch Events?

If that is indeed the case, I'd like to change this a little bit:

Let's call this property webhookTriggersBatchBuild?: boolean instead, to make it absolutely clear what it does.

If webhookTriggersBatchBuild is passed as true, but webhook is false (which gets a little complicated because webhook is considered true if it's undefined, but webhookFilters have been provided), that sounds like an error to me, and we should validate that scenario (and check that logic with a separate unit test, of course 🙂).

Hmm good question. I assume it applies for anything that triggers. Asked here: aws-cloudformation/cloudformation-coverage-roadmap#621 (comment)

@tjenkinson can you perhaps do an experiment with that setting and CloudWatch Events, and report back what you find? I don't want to hold your PR hostage to this question 🙂.

Looking at the console

It really implies it's just webhooks?

Looking at the docs here I don't think it's possible to trigger a batch build from cloudwatch, because it mentions that any options you provide are for the StartBuild call, not StartBuildBatch

For more information about the parameters you can pass, see StartBuild. You cannot pass the projectName parameter in this field. Instead, you specify the project using the ARN in Project ARN.

@tjenkinson OK. Let's assume that it is the case then, and let's implement the 2 points I made here #11743 (comment) .

@skinny85 currently if you pass webhooks: false and also provide filter groups, then the end result is no error, and the SourceConfig contains webhook false and the filter groups.

So I followed the same logic and decided to default webhooks to true if it was omitted and there were filter groups or webhookTriggersBatchBuild was true.

Also if you explicitly set webhooks to false we will leave it as false but still set the buildType in the SourceConfig just like we do with the filters.

WDYT?

I feel like passing webhooks: false, but webhookFilters is probably a mistake...

In fact, I just tried it, and I got the following error from CodeBuild's API:

Failed to call CreateWebhook, reason: Cannot specify filter groups when webhook is disabled. (Service: null; Status Code: 400; Error Code: null; Request ID: null; Proxy: null)

This makes me believe that adding this validation for webhookTriggersBatchBuild is the correct thing to do (I won't bother you with adding it for webhookFilters, as it's not really the topic of this PR).

Pull request has been modified.

Co-authored-by: Adam Ruka <adamruka85@gmail.com>

skinny85

Putting in "Request changes" to remove it from y ToDo-list. @tjenkinson when you've updated the PR, please make sure to re-request my review!

Pull request has been modified.

tjenkinson · 2020-12-21T13:52:30Z

Oh build failed. Will look into that. It worked locally

skinny85

Fantastic contribution @tjenkinson ! Fix the behavior for webhookTriggersBatchBuild being true, but webhook being given as false (it should throw an exception), and I'll gladly merge this one in 🙂.

Thanks,
Adam

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

…gured

Pull request has been modified.

skinny85

Thanks for the contribution @tjenkinson !

mergify · 2020-12-24T18:10:44Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

aws-cdk-automation · 2020-12-24T19:18:32Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 34d7203
Result: SUCCEEDED
Build Logs (available for 30 days)

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

mergify · 2020-12-24T19:18:55Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

This adds a `startBatchBuild` option to the code build source, to trigger a batch build. The cloudformation property isn't in the official docs yet but is mentioned [here](aws-cloudformation/cloudformation-coverage-roadmap#621 (comment)). Closes aws#11663

feat(aws-codebuild): add startBatchBuild option

d727b61

github-actions bot added the @aws-cdk/aws-codebuild Related to AWS CodeBuild label Nov 26, 2020

github-actions bot assigned skinny85 Nov 26, 2020

Merge branch 'master' into codebuild-batch-build

20d027a

tjenkinson and others added 2 commits November 27, 2020 22:04

set startBatchBuild from the props

74767fd

Merge branch 'master' into codebuild-batch-build

bb0adba

tjenkinson marked this pull request as ready for review November 27, 2020 22:32

skinny85 changed the title ~~feat(aws-codebuild): add startBatchBuild option~~ feat(codebuild): add startBatchBuild option Nov 30, 2020

skinny85 previously requested changes Nov 30, 2020

View reviewed changes

remove unneeded assertion

8afcec1

tjenkinson mentioned this pull request Nov 30, 2020

AWS::CodeBuild::Project - Support Batch Builds (From Trigger) aws-cloudformation/cloudformation-coverage-roadmap#621

Closed

correct doc

c518f3a

tjenkinson and others added 2 commits November 30, 2020 20:54

mention the default is false

94a3ffa

Co-authored-by: Adam Ruka <adamruka85@gmail.com>

Merge branch 'master' into codebuild-batch-build

7b851c1

skinny85 previously requested changes Dec 15, 2020

View reviewed changes

startBatchBuild => webhookTriggersBatchBuild

372a491

Merge branch 'master' into codebuild-batch-build

f92772a

tjenkinson requested a review from skinny85 December 21, 2020 12:54

tjenkinson marked this pull request as draft December 21, 2020 13:52

remove unneeded test

05414cc

tjenkinson marked this pull request as ready for review December 21, 2020 16:14

skinny85 previously requested changes Dec 24, 2020

View reviewed changes

packages/@aws-cdk/aws-codebuild/lib/source.ts Outdated Show resolved Hide resolved

throw error if webhook: false and batch enabled or filter group confi…

dbda6e7

…gured

Merge branch 'master' into codebuild-batch-build

6bf1746

tjenkinson requested a review from skinny85 December 24, 2020 10:34

skinny85 approved these changes Dec 24, 2020

View reviewed changes

Merge branch 'master' into codebuild-batch-build

34d7203

mergify bot merged commit d9353b7 into aws:master Dec 24, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(codebuild): add `startBatchBuild` option #11743

feat(codebuild): add `startBatchBuild` option #11743

tjenkinson commented Nov 26, 2020 •

edited

Loading

gitpod-io bot commented Nov 26, 2020 •

edited

Loading

tjenkinson commented Nov 27, 2020 •

edited

Loading

skinny85 left a comment

skinny85 Nov 30, 2020

tjenkinson Nov 30, 2020

skinny85 Dec 7, 2020

tjenkinson Dec 11, 2020

tjenkinson Dec 11, 2020

skinny85 Dec 11, 2020

tjenkinson Dec 21, 2020

skinny85 Dec 24, 2020

skinny85 left a comment

tjenkinson commented Dec 21, 2020

skinny85 left a comment

skinny85 left a comment

mergify bot commented Dec 24, 2020

aws-cdk-automation commented Dec 24, 2020

mergify bot commented Dec 24, 2020

feat(codebuild): add startBatchBuild option #11743

feat(codebuild): add startBatchBuild option #11743

Conversation

tjenkinson commented Nov 26, 2020 • edited Loading

gitpod-io bot commented Nov 26, 2020 • edited Loading

tjenkinson commented Nov 27, 2020 • edited Loading

skinny85 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skinny85 left a comment

Choose a reason for hiding this comment

tjenkinson commented Dec 21, 2020

skinny85 left a comment

Choose a reason for hiding this comment

skinny85 left a comment

Choose a reason for hiding this comment

mergify bot commented Dec 24, 2020

aws-cdk-automation commented Dec 24, 2020

AWS CodeBuild CI Report

mergify bot commented Dec 24, 2020

feat(codebuild): add `startBatchBuild` option #11743

feat(codebuild): add `startBatchBuild` option #11743

tjenkinson commented Nov 26, 2020 •

edited

Loading

gitpod-io bot commented Nov 26, 2020 •

edited

Loading

tjenkinson commented Nov 27, 2020 •

edited

Loading