Skip to content

Commit 84eb7ad

Browse files
authored
fix(codebuild): Rename includeBuildID property of S3BucketBuildArtifacts (#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
1 parent cbeea75 commit 84eb7ad

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ export interface S3BucketBuildArtifactsProps extends BuildArtifactsProps {
9292
* The name of the build output ZIP file or folder inside the bucket.
9393
*
9494
* The full S3 object key will be "<path>/<build-id>/<name>" or
95-
* "<path>/<name>" depending on whether `includeBuildID` is set to true.
95+
* "<path>/<name>" depending on whether `includeBuildId` is set to true.
9696
*/
9797
name: string;
9898

@@ -102,7 +102,7 @@ export interface S3BucketBuildArtifactsProps extends BuildArtifactsProps {
102102
*
103103
* @default true
104104
*/
105-
includeBuildID?: boolean;
105+
includeBuildId?: boolean;
106106

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

0 commit comments

Comments
 (0)