Skip to content

Commit

Permalink
fix(codebuild): Rename includeBuildID property of S3BucketBuildArtifa…
Browse files Browse the repository at this point in the history
…cts (#1354)

The property name ending with `ID` caused a mismatch of names to appear
in non-TypeScript languages, as the name translation rules would convert
back to `Id`.

BREAKING CHANGE: the `includeBuildID` property of
`S3BucketBuildArtifacts` was renamed to `includeBuildId` (note the
lower-case trailing `d`).

Fixes #1347
  • Loading branch information
RomainMuller authored Dec 13, 2018
1 parent cbeea75 commit 84eb7ad
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions packages/@aws-cdk/aws-codebuild/lib/artifacts.ts
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ export interface S3BucketBuildArtifactsProps extends BuildArtifactsProps {
* The name of the build output ZIP file or folder inside the bucket.
*
* The full S3 object key will be "<path>/<build-id>/<name>" or
* "<path>/<name>" depending on whether `includeBuildID` is set to true.
* "<path>/<name>" depending on whether `includeBuildId` is set to true.
*/
name: string;

Expand All @@ -102,7 +102,7 @@ export interface S3BucketBuildArtifactsProps extends BuildArtifactsProps {
*
* @default true
*/
includeBuildID?: boolean;
includeBuildId?: boolean;

/**
* If this is true, all build output will be packaged into a single .zip file.
Expand Down Expand Up @@ -131,7 +131,7 @@ export class S3BucketBuildArtifacts extends BuildArtifacts {
return {
location: this.props.bucket.bucketName,
path: this.props.path,
namespaceType: this.props.includeBuildID === false ? 'NONE' : 'BUILD_ID',
namespaceType: this.props.includeBuildId === false ? 'NONE' : 'BUILD_ID',
name: this.props.name,
packaging: this.props.packageZip === false ? 'NONE' : 'ZIP',
};
Expand Down

0 comments on commit 84eb7ad

Please sign in to comment.