refactor(codepipeline): rename name in StageProps to stageName. (…

…#2882) BREAKING CHANGE: the property designating the name of the stage when creating a CodePipeline is now called `stageName` instead of `name`
aws · Jun 17, 2019 · be574a1 · be574a1
1 parent c10fc9a
commit be574a1
Show file tree

Hide file tree

Showing 34 changed files with 138 additions and 138 deletions.
diff --git a/packages/@aws-cdk/app-delivery/README.md b/packages/@aws-cdk/app-delivery/README.md
@@ -70,7 +70,7 @@ const source = new codepipeline_actions.GitHubSourceAction({
   /* ... */
 });
 pipeline.addStage({
-  name: 'source',
+  stageName: 'source',
   actions: [source],
 });
 
@@ -92,20 +92,20 @@ const buildAction = new codepipeline_actions.CodeBuildAction({
   outputs: [synthesizedApp],
 });
 pipeline.addStage({
-  name: 'build',
+  stageName: 'build',
   actions: [buildAction],
 });
 
 // Optionally, self-update the pipeline stack
-const selfUpdateStage = pipeline.addStage({ name: 'SelfUpdate' });
+const selfUpdateStage = pipeline.addStage({ stageName: 'SelfUpdate' });
 new cicd.PipelineDeployStackAction(pipelineStack, 'SelfUpdatePipeline', {
   stage: selfUpdateStage,
   stack: pipelineStack,
   input: synthesizedApp,
 });
 
 // Now add our service stacks
-const deployStage = pipeline.addStage({ name: 'Deploy' });
+const deployStage = pipeline.addStage({ stageName: 'Deploy' });
 const serviceStackA = new MyServiceStackA(app, 'ServiceStackA', { /* ... */ });
 // Add actions to deploy the stacks in the deploy stage:
 const deployServiceAAction = new cicd.PipelineDeployStackAction(pipelineStack, 'DeployServiceStackA', {

diff --git a/packages/@aws-cdk/app-delivery/test/integ.cicd.ts b/packages/@aws-cdk/app-delivery/test/integ.cicd.ts
@@ -23,10 +23,10 @@ const source = new cpactions.GitHubSourceAction({
   output: sourceOutput,
 });
 pipeline.addStage({
-  name: 'Source',
+  stageName: 'Source',
   actions: [source],
 });
-const stage = pipeline.addStage({ name: 'Deploy' });
+const stage = pipeline.addStage({ stageName: 'Deploy' });
 new cicd.PipelineDeployStackAction(stack, 'DeployStack', {
   stage,
   stack,

diff --git a/packages/@aws-cdk/app-delivery/test/test.pipeline-deploy-stack-action.ts b/packages/@aws-cdk/app-delivery/test/test.pipeline-deploy-stack-action.ts
@@ -31,14 +31,14 @@ export = nodeunit.testCase({
             const pipeline = new codepipeline.Pipeline(stack, 'Pipeline');
             const fakeAction = new FakeAction('Fake');
             pipeline.addStage({
-              name: 'FakeStage',
+              stageName: 'FakeStage',
               actions: [fakeAction],
             });
             new PipelineDeployStackAction(stack, 'Action', {
               changeSetName: 'ChangeSet',
               input: fakeAction.outputArtifact,
               stack: new cdk.Stack(app, 'DeployedStack', { env: { account: stackAccount } }),
-              stage: pipeline.addStage({ name: 'DeployStage' }),
+              stage: pipeline.addStage({ stageName: 'DeployStage' }),
               adminPermissions: false,
             });
           }, 'Cross-environment deployment is not supported');
@@ -60,7 +60,7 @@ export = nodeunit.testCase({
             const pipeline = new codepipeline.Pipeline(stack, 'Pipeline');
             const fakeAction = new FakeAction('Fake');
             pipeline.addStage({
-              name: 'FakeStage',
+              stageName: 'FakeStage',
               actions: [fakeAction],
             });
             new PipelineDeployStackAction(stack, 'Action', {
@@ -69,7 +69,7 @@ export = nodeunit.testCase({
               executeChangeSetRunOrder: executeRunOrder,
               input: fakeAction.outputArtifact,
               stack: new cdk.Stack(app, 'DeployedStack'),
-              stage: pipeline.addStage({ name: 'DeployStage' }),
+              stage: pipeline.addStage({ stageName: 'DeployStage' }),
               adminPermissions: false,
             });
           }, 'createChangeSetRunOrder must be < executeChangeSetRunOrder');
@@ -89,9 +89,9 @@ export = nodeunit.testCase({
     const selfUpdatingStack = createSelfUpdatingStack(pipelineStack);
 
     const pipeline = selfUpdatingStack.pipeline;
-    const selfUpdateStage1 = pipeline.addStage({ name: 'SelfUpdate1' });
-    const selfUpdateStage2 = pipeline.addStage({ name: 'SelfUpdate2' });
-    const selfUpdateStage3 = pipeline.addStage({ name: 'SelfUpdate3' });
+    const selfUpdateStage1 = pipeline.addStage({ stageName: 'SelfUpdate1' });
+    const selfUpdateStage2 = pipeline.addStage({ stageName: 'SelfUpdate2' });
+    const selfUpdateStage3 = pipeline.addStage({ stageName: 'SelfUpdate3' });
 
     new PipelineDeployStackAction(pipelineStack, 'SelfUpdatePipeline', {
       stage: selfUpdateStage1,
@@ -155,7 +155,7 @@ export = nodeunit.testCase({
     const selfUpdatingStack = createSelfUpdatingStack(pipelineStack);
 
     const pipeline = selfUpdatingStack.pipeline;
-    const selfUpdateStage = pipeline.addStage({ name: 'SelfUpdate' });
+    const selfUpdateStage = pipeline.addStage({ stageName: 'SelfUpdate' });
     new PipelineDeployStackAction(pipelineStack, 'SelfUpdatePipeline', {
       stage: selfUpdateStage,
       stack: pipelineStack,
@@ -191,7 +191,7 @@ export = nodeunit.testCase({
       assumedBy: new iam.ServicePrincipal('cloudformation.amazonaws.com'),
     });
     const pipeline = selfUpdatingStack.pipeline;
-    const selfUpdateStage = pipeline.addStage({ name: 'SelfUpdate' });
+    const selfUpdateStage = pipeline.addStage({ stageName: 'SelfUpdate' });
     const deployAction = new PipelineDeployStackAction(pipelineStack, 'SelfUpdatePipeline', {
       stage: selfUpdateStage,
       stack: pipelineStack,
@@ -214,7 +214,7 @@ export = nodeunit.testCase({
 
     // WHEN //
     // this our app/service/infra to deploy
-    const deployStage = pipeline.addStage({ name: 'Deploy' });
+    const deployStage = pipeline.addStage({ stageName: 'Deploy' });
     const deployAction = new PipelineDeployStackAction(pipelineStack, 'DeployServiceStackA', {
       stage: deployStage,
       stack: emptyStack,
@@ -276,11 +276,11 @@ export = nodeunit.testCase({
           const pipeline = new codepipeline.Pipeline(stack, 'Pipeline');
           const fakeAction = new FakeAction('Fake');
           pipeline.addStage({
-            name: 'FakeStage',
+            stageName: 'FakeStage',
             actions: [fakeAction],
           });
           const deployedStack = new cdk.Stack(app, 'DeployedStack');
-          const deployStage = pipeline.addStage({ name: 'DeployStage' });
+          const deployStage = pipeline.addStage({ stageName: 'DeployStage' });
           const action = new PipelineDeployStackAction(stack, 'Action', {
             changeSetName: 'ChangeSet',
             input: fakeAction.outputArtifact,
@@ -338,7 +338,7 @@ function createSelfUpdatingStack(pipelineStack: cdk.Stack): SelfUpdatingPipeline
     output: sourceOutput,
   });
   pipeline.addStage({
-    name: 'source',
+    stageName: 'source',
     actions: [sourceAction],
   });
 
@@ -351,7 +351,7 @@ function createSelfUpdatingStack(pipelineStack: cdk.Stack): SelfUpdatingPipeline
     outputs: [buildOutput],
   });
   pipeline.addStage({
-    name: 'build',
+    stageName: 'build',
     actions: [buildAction],
   });
   return {synthesizedApp: buildOutput, pipeline};

diff --git a/packages/@aws-cdk/aws-codepipeline-actions/README.md b/packages/@aws-cdk/aws-codepipeline-actions/README.md
@@ -42,7 +42,7 @@ const sourceAction = new codepipeline_actions.CodeCommitSourceAction({
   output: sourceOutput,
 });
 pipeline.addStage({
-  name: 'Source',
+  stageName: 'Source',
   actions: [sourceAction],
 });
 ```
@@ -65,7 +65,7 @@ const sourceAction = new codepipeline_actions.GitHubSourceAction({
   trigger: codepipeline_actions.GitHubTrigger.Poll // default: 'WebHook', 'None' is also possible for no Source trigger
 });
 pipeline.addStage({
-  name: 'Source',
+  stageName: 'Source',
   actions: [sourceAction],
 });
 ```
@@ -90,7 +90,7 @@ const sourceAction = new codepipeline_actions.S3SourceAction({
   output: sourceOutput,
 });
 pipeline.addStage({
-  name: 'Source',
+  stageName: 'Source',
   actions: [sourceAction],
 });
 ```
@@ -136,7 +136,7 @@ const sourceAction = new codepipeline_actions.EcrSourceAction({
   output: sourceOutput,
 });
 pipeline.addStage({
-  actionName: 'Source',
+  stageName: 'Source',
   actions: [sourceAction],
 });
 ```
@@ -172,11 +172,11 @@ const buildAction = new codepipeline_actions.CodeBuildAction({
 new codepipeline.Pipeline(this, 'MyPipeline', {
   stages: [
     {
-      name: 'Source',
+      stageName: 'Source',
       actions: [sourceAction],
     },
     {
-      name: 'Build',
+      stageName: 'Build',
       actions: [buildAction],
     },
   ],
@@ -382,7 +382,7 @@ const deployAction = new codepipeline_actions.CodeDeployServerDeployAction({
   deploymentGroup,
 });
 pipeline.addStage({
-  name: 'Deploy',
+  stageName: 'Deploy',
   actions: [deployAction],
 });
 ```
@@ -423,7 +423,7 @@ The deploy Action receives one input Artifact which contains the [image definiti
 
 ```typescript
 const deployStage = pipeline.addStage({
-  name: 'Deploy',
+  stageName: 'Deploy',
   actions: [
     new codepipeline_actions.EcsDeployAction({
       actionName: 'DeployAction',
@@ -458,7 +458,7 @@ const deployAction = new codepipeline_actions.S3DeployAction({
   input: sourceOutput,
 });
 const deployStage = pipeline.addStage({
-  name: 'Deploy',
+  stageName: 'Deploy',
   actions: [deployAction],
 });
 ```
@@ -552,7 +552,7 @@ const lambdaAction = new codepipeline_actions.LambdaInvokeAction({
   lambda: fn,
 });
 pipeline.addStage({
-  actionName: 'Lambda',
+  stageName: 'Lambda',
   actions: [lambdaAction],
 });
 ```

diff --git a/...-cdk/aws-codepipeline-actions/test/cloudformation/test.cloudformation-pipeline-actions.ts b/...-cdk/aws-codepipeline-actions/test/cloudformation/test.cloudformation-pipeline-actions.ts
@@ -31,7 +31,7 @@ export = {
     pollForSourceChanges: true,
   });
   pipeline.addStage({
-    name: 'source',
+    stageName: 'source',
     actions: [source]
   });
 
@@ -51,7 +51,7 @@ export = {
     outputs: [buildOutput],
   });
   pipeline.addStage({
-    name: 'build',
+    stageName: 'build',
     actions: [buildAction],
   });
 
@@ -63,7 +63,7 @@ export = {
   const stackName = 'BrelandsStack';
   const changeSetName = 'MyMagicalChangeSet';
   pipeline.addStage({
-    name: 'prod',
+    stageName: 'prod',
     actions: [
       new cpactions.CloudFormationCreateReplaceChangeSetAction({
         actionName: 'BuildChangeSetProd',
@@ -432,8 +432,8 @@ class TestFixture extends cdk.Stack {
     super();
 
     this.pipeline = new codepipeline.Pipeline(this, 'Pipeline');
-    this.sourceStage = this.pipeline.addStage({ name: 'Source' });
-    this.deployStage = this.pipeline.addStage({ name: 'Deploy' });
+    this.sourceStage = this.pipeline.addStage({ stageName: 'Source' });
+    this.deployStage = this.pipeline.addStage({ stageName: 'Deploy' });
     this.repo = new Repository(this, 'MyVeryImportantRepo', { repositoryName: 'my-very-important-repo' });
     this.sourceOutput = new codepipeline.Artifact('SourceArtifact');
     const source = new cpactions.CodeCommitSourceAction({

diff --git a/packages/@aws-cdk/aws-codepipeline-actions/test/integ.cfn-template-from-repo.lit.ts b/packages/@aws-cdk/aws-codepipeline-actions/test/integ.cfn-template-from-repo.lit.ts
@@ -19,7 +19,7 @@ const source = new cpactions.CodeCommitSourceAction({
   pollForSourceChanges: true,
 });
 const sourceStage = {
-  name: 'Source',
+  stageName: 'Source',
   actions: [source],
 };
 
@@ -28,7 +28,7 @@ const stackName = 'OurStack';
 const changeSetName = 'StagedChangeSet';
 
 const prodStage = {
-  name: 'Deploy',
+  stageName: 'Deploy',
   actions: [
     new cpactions.CloudFormationCreateReplaceChangeSetAction({
       actionName: 'PrepareChanges',

diff --git a/.../@aws-cdk/aws-codepipeline-actions/test/integ.lambda-deployed-through-codepipeline.lit.ts b/.../@aws-cdk/aws-codepipeline-actions/test/integ.lambda-deployed-through-codepipeline.lit.ts
@@ -36,7 +36,7 @@ const lambdaSourceAction = new codepipeline_actions.CodeCommitSourceAction({
   output: lambdaSourceOutput,
 });
 pipeline.addStage({
-  name: 'Source',
+  stageName: 'Source',
   actions: [cdkSourceAction, lambdaSourceAction],
 });
 
@@ -107,13 +107,13 @@ const lambdaBuildAction = new codepipeline_actions.CodeBuildAction({
 });
 
 pipeline.addStage({
-  name: 'Build',
+  stageName: 'Build',
   actions: [cdkBuildAction, lambdaBuildAction],
 });
 
 // finally, deploy your Lambda Stack
 pipeline.addStage({
-  name: 'Deploy',
+  stageName: 'Deploy',
   actions: [
     new codepipeline_actions.CloudFormationCreateUpdateStackAction({
       actionName: 'Lambda_CFN_Deploy',

diff --git a/packages/@aws-cdk/aws-codepipeline-actions/test/integ.lambda-pipeline.ts b/packages/@aws-cdk/aws-codepipeline-actions/test/integ.lambda-pipeline.ts
@@ -11,7 +11,7 @@ const stack = new cdk.Stack(app, 'aws-cdk-codepipeline-lambda');
 
 const pipeline = new codepipeline.Pipeline(stack, 'Pipeline');
 
-const sourceStage = pipeline.addStage({ name: 'Source' });
+const sourceStage = pipeline.addStage({ stageName: 'Source' });
 const bucket = new s3.Bucket(stack, 'PipelineBucket', {
   versioned: true,
   removalPolicy: cdk.RemovalPolicy.Destroy,
@@ -36,7 +36,7 @@ const lambdaFun = new lambda.Function(stack, 'LambdaFun', {
   handler: 'index.handler',
   runtime: lambda.Runtime.Nodejs810,
 });
-const lambdaStage = pipeline.addStage({ name: 'Lambda' });
+const lambdaStage = pipeline.addStage({ stageName: 'Lambda' });
 lambdaStage.addAction(new cpactions.LambdaInvokeAction({
   actionName: 'Lambda' ,
   lambda: lambdaFun,

diff --git a/packages/@aws-cdk/aws-codepipeline-actions/test/integ.pipeline-alexa-deploy.ts b/packages/@aws-cdk/aws-codepipeline-actions/test/integ.pipeline-alexa-deploy.ts
@@ -19,12 +19,12 @@ const sourceAction = new cpactions.S3SourceAction({
   bucketKey: 'key',
 });
 const sourceStage = {
-  name: 'Source',
+  stageName: 'Source',
   actions: [sourceAction],
 };
 
 const deployStage = {
-  name: 'Deploy',
+  stageName: 'Deploy',
   actions: [
     new cpactions.AlexaSkillDeployAction({
       actionName: 'DeploySkill',

diff --git a/packages/@aws-cdk/aws-codepipeline-actions/test/integ.pipeline-cfn-cross-region.ts b/packages/@aws-cdk/aws-codepipeline-actions/test/integ.pipeline-cfn-cross-region.ts
@@ -29,11 +29,11 @@ new codepipeline.Pipeline(stack, 'MyPipeline', {
   artifactBucket: bucket,
   stages: [
     {
-      name: 'Source',
+      stageName: 'Source',
       actions: [sourceAction],
     },
     {
-      name: 'CFN',
+      stageName: 'CFN',
       actions: [
         new cpactions.CloudFormationCreateUpdateStackAction({
           actionName: 'CFN_Deploy',

diff --git a/packages/@aws-cdk/aws-codepipeline-actions/test/integ.pipeline-cfn-wtih-action-role.ts b/packages/@aws-cdk/aws-codepipeline-actions/test/integ.pipeline-cfn-wtih-action-role.ts
@@ -21,7 +21,7 @@ const sourceAction = new cpactions.S3SourceAction({
   output: sourceOutput,
 });
 const sourceStage = {
-  name: 'Source',
+  stageName: 'Source',
   actions: [sourceAction],
 };
 
@@ -33,7 +33,7 @@ role.addToPolicy(new iam.PolicyStatement({
   resources: ['*']
 }));
 const cfnStage = {
-  name: 'CFN',
+  stageName: 'CFN',
   actions: [
     new cpactions.CloudFormationCreateUpdateStackAction({
       actionName: 'CFN_Deploy',