Skip to content

Commit 825e448

Browse files
authored
feat(aws-codebuild): rename the Project methods for adding Actions to CodePipeline. (#1254)
BREAKING CHANGE: `addBuildToPipeline` was renamed to `addToPipeline` and `addTestToPipeline` was renamed to `addPipelineToTest` in order to align with naming conventions. Fixes #1211
1 parent edc9a21 commit 825e448

File tree

6 files changed

+12
-12
lines changed

6 files changed

+12
-12
lines changed

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ You can also add the Project to the Pipeline directly:
8080
8181
```ts
8282
// equivalent to the code above:
83-
const buildAction = project.addBuildToPipeline(buildStage, 'CodeBuild');
83+
const buildAction = project.addToPipeline(buildStage, 'CodeBuild');
8484
```
8585
8686
In addition to the build Action,
@@ -100,7 +100,7 @@ new codebuild.PipelineTestAction(this, 'IntegrationTest', {
100100
});
101101

102102
// equivalent to the code above:
103-
project.addTestToPipeline(buildStage, 'IntegrationTest', {
103+
project.addToPipelineAsTest(buildStage, 'IntegrationTest', {
104104
// of course, this property is optional here as well
105105
outputArtifactName: 'IntegrationTestOutput',
106106
});
@@ -206,7 +206,7 @@ const sourceAction2 = repository2.addToPipeline(sourceStage, 'Source2', {
206206
});
207207

208208
const buildStage = pipeline.addStage('Build');
209-
const buildAction = project.addBuildToPipeline(buildStage, 'Build', {
209+
const buildAction = project.addToPipeline(buildStage, 'Build', {
210210
inputArtifact: sourceAction1.outputArtifact,
211211
outputArtifactName: 'artifact1', // for better buildspec readability - see below
212212
additionalInputArtifacts: [

packages/@aws-cdk/aws-codebuild/lib/pipeline-actions.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export interface CommonCodeBuildActionProps {
2323
/**
2424
* Common properties for creating {@link PipelineBuildAction} -
2525
* either directly, through its constructor,
26-
* or through {@link ProjectRef#addBuildToPipeline}.
26+
* or through {@link ProjectRef#addToPipeline}.
2727
*/
2828
export interface CommonPipelineBuildActionProps extends CommonCodeBuildActionProps,
2929
codepipeline.CommonActionProps {
@@ -109,7 +109,7 @@ export class PipelineBuildAction extends codepipeline.BuildAction {
109109
/**
110110
* Common properties for creating {@link PipelineTestAction} -
111111
* either directly, through its constructor,
112-
* or through {@link ProjectRef#addTestToPipeline}.
112+
* or through {@link ProjectRef#addToPipelineAsTest}.
113113
*/
114114
export interface CommonPipelineTestActionProps extends CommonCodeBuildActionProps,
115115
codepipeline.CommonActionProps {

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ export abstract class ProjectRef extends cdk.Construct implements events.IEventR
9292
* @param props the properties of the new Action
9393
* @returns the newly created {@link PipelineBuildAction} build Action
9494
*/
95-
public addBuildToPipeline(stage: codepipeline.IStage, name: string, props: CommonPipelineBuildActionProps = {}): PipelineBuildAction {
95+
public addToPipeline(stage: codepipeline.IStage, name: string, props: CommonPipelineBuildActionProps = {}): PipelineBuildAction {
9696
return new PipelineBuildAction(this, name, {
9797
stage,
9898
project: this,
@@ -109,7 +109,7 @@ export abstract class ProjectRef extends cdk.Construct implements events.IEventR
109109
* @param props the properties of the new Action
110110
* @returns the newly created {@link PipelineBuildAction} test Action
111111
*/
112-
public addTestToPipeline(stage: codepipeline.IStage, name: string, props: CommonPipelineTestActionProps = {}): PipelineTestAction {
112+
public addToPipelineAsTest(stage: codepipeline.IStage, name: string, props: CommonPipelineTestActionProps = {}): PipelineTestAction {
113113
return new PipelineTestAction(this, name, {
114114
stage,
115115
project: this,

packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-code-build-multiple-inputs-outputs.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ const sourceAction2 = bucket.addToPipeline(sourceStage, 'Source2', {
2727

2828
const project = new codebuild.PipelineProject(stack, 'MyBuildProject');
2929
const buildStage = pipeline.addStage('Build');
30-
const buildAction = project.addBuildToPipeline(buildStage, 'Build1', {
30+
const buildAction = project.addToPipeline(buildStage, 'Build1', {
3131
inputArtifact: sourceAction1.outputArtifact,
3232
additionalInputArtifacts: [
3333
sourceAction2.outputArtifact,
@@ -36,7 +36,7 @@ const buildAction = project.addBuildToPipeline(buildStage, 'Build1', {
3636
'CustomOutput1',
3737
],
3838
});
39-
const testAction = project.addTestToPipeline(buildStage, 'Build2', {
39+
const testAction = project.addToPipelineAsTest(buildStage, 'Build2', {
4040
inputArtifact: sourceAction2.outputArtifact,
4141
additionalInputArtifacts: [
4242
sourceAction1.outputArtifact,

packages/@aws-cdk/aws-codepipeline/test/integ.pipeline-code-commit-build.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ const project = new codebuild.Project(stack, 'MyBuildProject', {
2626
});
2727

2828
const buildStage = new codepipeline.Stage(pipeline, 'build', { pipeline });
29-
project.addBuildToPipeline(buildStage, 'build');
30-
project.addTestToPipeline(buildStage, 'test');
29+
project.addToPipeline(buildStage, 'build');
30+
project.addToPipelineAsTest(buildStage, 'test');
3131

3232
app.run();

packages/@aws-cdk/aws-codepipeline/test/test.action.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ export = {
7676

7777
const project = new codebuild.PipelineProject(stack, 'Project');
7878
const buildStage = pipeline.addStage('Build');
79-
project.addBuildToPipeline(buildStage, 'CodeBuild');
79+
project.addToPipeline(buildStage, 'CodeBuild');
8080

8181
expect(stack).to(haveResource('AWS::CodePipeline::Pipeline', {
8282
"Stages": [

0 commit comments

Comments
 (0)