feat(aws-codebuild): allow setting Webhook for GitHub Sources. (#1387)

aws · Dec 19, 2018 · d5cae61 · d5cae61
1 parent 478a714
commit d5cae61
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 0 deletions.
diff --git a/packages/@aws-cdk/aws-codebuild/README.md b/packages/@aws-cdk/aws-codebuild/README.md
@@ -84,6 +84,18 @@ CodePipeline action.
 #### `GitHubSource` and `GitHubEnterpriseSource`
 
 These source types can be used to build code from a GitHub repository.
+Example:
+
+```typescript
+const gitHubSource = new codebuild.GitHubSource({
+ owner: 'awslabs',
+ repo: 'aws-cdk',
+ oauthToken: new cdk.SecretParameter(this, 'GitHubOAuthToken', {
+ ssmParameter: 'my-github-token',
+ }),
+ webhook: true, // optional, default: false
+});
+```
 
 #### `BitBucketSource`
 

diff --git a/packages/@aws-cdk/aws-codebuild/lib/project.ts b/packages/@aws-cdk/aws-codebuild/lib/project.ts
@@ -562,6 +562,7 @@ export class Project extends ProjectRef {
  timeoutInMinutes: props.timeout,
  secondarySources: new cdk.Token(() => this.renderSecondarySources()),
  secondaryArtifacts: new cdk.Token(() => this.renderSecondaryArtifacts()),
+ triggers: this.source.buildTriggers(),
  });
 
  this.projectArn = resource.projectArn;

diff --git a/packages/@aws-cdk/aws-codebuild/lib/source.ts b/packages/@aws-cdk/aws-codebuild/lib/source.ts
@@ -46,6 +46,10 @@ export abstract class BuildSource {
  };
  }
 
+ public buildTriggers(): CfnProject.ProjectTriggersProperty | undefined {
+ return undefined;
+ }
+
  protected toSourceProperty(): any {
  return {
  };
@@ -171,6 +175,13 @@ export interface GitHubSourceProps extends BuildSourceProps {
  */
  oauthToken: cdk.Secret;
 
+ /**
+ * Whether to create a webhook that will trigger a build every time a commit is pushed to the GitHub repository.
+ *
+ * @default false
+ */
+ webhook?: boolean;
+
  /**
  * Whether to send GitHub notifications on your build's start and end.
  *
@@ -187,14 +198,24 @@ export class GitHubSource extends BuildSource {
  private readonly httpsCloneUrl: string;
  private readonly oauthToken: cdk.Secret;
  private readonly reportBuildStatus: boolean;
+ private readonly webhook?: boolean;
 
  constructor(props: GitHubSourceProps) {
  super(props);
  this.httpsCloneUrl = `https://github.com/${props.owner}/${props.repo}.git`;
  this.oauthToken = props.oauthToken;
+ this.webhook = props.webhook;
  this.reportBuildStatus = props.reportBuildStatus === undefined ? true : props.reportBuildStatus;
  }
 
+ public buildTriggers(): CfnProject.ProjectTriggersProperty | undefined {
+ return this.webhook === undefined
+ ? undefined
+ : {
+ webhook: this.webhook,
+ };
+ }
+
  protected toSourceProperty(): any {
  return {
  auth: { type: 'OAUTH', resource: this.oauthToken },

diff --git a/packages/@aws-cdk/aws-codebuild/test/test.project.ts b/packages/@aws-cdk/aws-codebuild/test/test.project.ts
@@ -100,6 +100,30 @@ export = {
 
  test.done();
  },
+
+ 'can explicitly set webhook to true'(test: Test) {
+ // GIVEN
+ const stack = new cdk.Stack();
+
+ // WHEN
+ new codebuild.Project(stack, 'Project', {
+ source: new codebuild.GitHubSource({
+ owner: 'testowner',
+ repo: 'testrepo',
+ oauthToken: new cdk.Secret('test_oauth_token'),
+ webhook: true,
+ })
+ });
+
+ // THEN
+ expect(stack).to(haveResourceLike('AWS::CodeBuild::Project', {
+ Triggers: {
+ Webhook: true,
+ },
+ }));
+
+ test.done();
+ },
  },
 
  'github enterprise auth test'(test: Test) {