@flit/cdk-pipeline 1.5.0 → 2.1.0

package/src/pipeline-segment.ts

@@ -1,17 +1,17 @@
 import {
-  BuildEnvironmentVariable,
-  BuildSpec,
-  mergeBuildSpecs,
-  Project,
-  ProjectProps,
+	BuildEnvironmentVariable,
+	BuildSpec,
+	mergeBuildSpecs,
+	Project,
+	ProjectProps,
 } from "aws-cdk-lib/aws-codebuild";
 import { Stack } from "aws-cdk-lib";
 import { IAction } from "aws-cdk-lib/aws-codepipeline";
 import {
-  CloudFormationCreateReplaceChangeSetAction,
-  CloudFormationExecuteChangeSetAction,
-  CodeBuildAction,
-  ManualApprovalAction,
+	CloudFormationCreateReplaceChangeSetAction,
+	CloudFormationExecuteChangeSetAction,
+	CodeBuildAction,
+	ManualApprovalAction,
 } from "aws-cdk-lib/aws-codepipeline-actions";
 import * as path from "path";
 
@@ -21,154 +21,154 @@ import { Pipeline } from "./pipeline";
 import { PublishAssetsAction } from "./publish-assets-action";
 
 export interface PipelineSegmentProps {
-  /**
-   * The input arfifact for the build stage.
-   */
-  readonly input: Artifact | Artifact[];
-  /**
-   * The command(s) to build the stack.
-   * @example "cdk synth StackName --strict --exclusively"
-   */
-  readonly project: ProjectProps;
-  /**
-   * The environmental variables for the build stage.
-   */
-  readonly environmentVariables?: { [key: string]: BuildEnvironmentVariable };
-  /**
-   * The name of the stack to apply this action to.
-   * @default The name of the given stack.
-   */
-  readonly stackName?: string;
-  /**
-   * The artifact to hold the stack deployment output file.
-   * @default no output artifact
-   */
-  readonly output?: Artifact;
-  /**
-   * The filename for the file in the output artifact
-   * @default artifact.json
-   */
-  readonly outputFileName?: string;
-  /**
-   * Does this stage require manual approval of the change set?
-   * @default false
-   */
-  readonly manualApproval?: Boolean;
+	/**
+	 * The input arfifact for the build stage.
+	 */
+	readonly input: Artifact | Artifact[];
+	/**
+	 * The command(s) to build the stack.
+	 * @example "cdk synth StackName --strict --exclusively"
+	 */
+	readonly project: ProjectProps;
+	/**
+	 * The environmental variables for the build stage.
+	 */
+	readonly environmentVariables?: { [key: string]: BuildEnvironmentVariable };
+	/**
+	 * The name of the stack to apply this action to.
+	 * @default The name of the given stack.
+	 */
+	readonly stackName?: string;
+	/**
+	 * The artifact to hold the stack deployment output file.
+	 * @default no output artifact
+	 */
+	readonly output?: Artifact;
+	/**
+	 * The filename for the file in the output artifact
+	 * @default artifact.json
+	 */
+	readonly outputFileName?: string;
+	/**
+	 * Does this stage require manual approval of the change set?
+	 * @default false
+	 */
+	readonly manualApproval?: Boolean;
 }
 
 /**
  * @category Segments
  */
 export class PipelineSegment extends Segment {
-  readonly isPipeline = true;
-  readonly props: PipelineSegmentProps;
+	readonly isPipeline = true;
+	readonly props: PipelineSegmentProps;
 
-  constructor(props: PipelineSegmentProps) {
-    super(props);
-    this.props = props;
-  }
+	constructor(props: PipelineSegmentProps) {
+		super(props);
+		this.props = props;
+	}
 
-  construct(scope: Pipeline): SegmentConstructed {
-    return new PipelineSegmentConstructed(scope, `Deploy${scope.stackName}`, {
-      ...this.props,
-      stack: scope,
-      input: this.inputs[0],
-      extraInputs: this.inputs.slice(1),
-    });
-  }
+	construct(scope: Pipeline): SegmentConstructed {
+		return new PipelineSegmentConstructed(scope, `Deploy${scope.node.id}`, {
+			...this.props,
+			stack: scope,
+			input: this.inputs[0],
+			extraInputs: this.inputs.slice(1),
+		});
+	}
 }
 
 export interface PipelineSegmentConstructedProps {
-  readonly stack: Stack;
-  readonly project: ProjectProps;
-  readonly environmentVariables?: { [key: string]: BuildEnvironmentVariable };
-  readonly stackName?: string;
-  readonly input: Artifact;
-  readonly extraInputs?: Artifact[];
-  readonly output?: Artifact;
-  readonly outputFileName?: string;
-  readonly manualApproval?: Boolean;
+	readonly stack: Stack;
+	readonly project: ProjectProps;
+	readonly environmentVariables?: { [key: string]: BuildEnvironmentVariable };
+	readonly stackName?: string;
+	readonly input: Artifact;
+	readonly extraInputs?: Artifact[];
+	readonly output?: Artifact;
+	readonly outputFileName?: string;
+	readonly manualApproval?: Boolean;
 }
 
 export class PipelineSegmentConstructed extends SegmentConstructed {
-  readonly name: string;
-  readonly actions: IAction[];
+	readonly name: string;
+	readonly actions: IAction[];
 
-  constructor(
-    scope: Pipeline,
-    id: string,
-    props: PipelineSegmentConstructedProps,
-  ) {
-    super(scope, id);
+	constructor(
+		scope: Pipeline,
+		id: string,
+		props: PipelineSegmentConstructedProps,
+	) {
+		super(scope, id);
 
-    this.name = props.stack.stackName;
+		this.name = props.stack.stackName;
 
-    const buildArtifact = props.output || new Artifact();
+		const buildArtifact = props.output || new Artifact();
 
-    this.actions = [
-      new CodeBuildAction({
-        actionName: "Build",
-        runOrder: 1,
-        input: props.input,
-        extraInputs: props.extraInputs,
-        outputs: [buildArtifact],
-        environmentVariables: props.environmentVariables,
-        project: new Project(this, "UpdateCodeBuild", {
-          ...props.project,
-          buildSpec: props.project.buildSpec
-            ? mergeBuildSpecs(
-                props.project.buildSpec,
-                BuildSpec.fromObject({
-                  artifacts: {
-                    files: [path.join(scope.buildDir, "**/*")],
-                  },
-                }),
-              )
-            : BuildSpec.fromObject({
-                artifacts: {
-                  files: [path.join(scope.buildDir, "**/*")],
-                },
-              }),
-        }),
-      }),
-      new PublishAssetsAction(this, "PublishAssets", {
-        actionName: "PublishAssets",
-        runOrder: 2,
-        input: buildArtifact,
-        manifestPath: scope.buildDir,
-      }),
-      new CloudFormationCreateReplaceChangeSetAction({
-        actionName: "PrepareChanges",
-        runOrder: 3,
-        stackName: props.stackName ? props.stackName : props.stack.stackName,
-        account: props.stack.account,
-        region: props.stack.region,
-        changeSetName: `${props.stack.stackName}Changes`,
-        adminPermissions: true,
-        templatePath: buildArtifact.atPath(
-          path.join(scope.buildDir, props.stack.templateFile),
-        ),
-      }),
-      ...(props.manualApproval
-        ? [
-            new ManualApprovalAction({
-              actionName: "ApproveChanges",
-              runOrder: 4,
-            }),
-          ]
-        : []),
-      new CloudFormationExecuteChangeSetAction({
-        actionName: "ExecuteChanges",
-        runOrder: props.manualApproval ? 5 : 4,
-        stackName: props.stackName ? props.stackName : props.stack.stackName,
-        account: props.stack.account,
-        region: props.stack.region,
-        changeSetName: `${props.stack.stackName}Changes`,
-      }),
-    ];
-  }
+		this.actions = [
+			new CodeBuildAction({
+				actionName: "Build",
+				runOrder: 1,
+				input: props.input,
+				extraInputs: props.extraInputs,
+				outputs: [buildArtifact],
+				environmentVariables: props.environmentVariables,
+				project: new Project(this, "UpdateCodeBuild", {
+					...props.project,
+					buildSpec: props.project.buildSpec
+						? mergeBuildSpecs(
+								props.project.buildSpec,
+								BuildSpec.fromObject({
+									artifacts: {
+										files: [path.join(scope.buildDir, "**/*")],
+									},
+								}),
+						  )
+						: BuildSpec.fromObject({
+								artifacts: {
+									files: [path.join(scope.buildDir, "**/*")],
+								},
+						  }),
+				}),
+			}),
+			new PublishAssetsAction(this, "PublishAssets", {
+				actionName: "PublishAssets",
+				runOrder: 2,
+				input: buildArtifact,
+				manifestPath: scope.buildDir,
+			}),
+			new CloudFormationCreateReplaceChangeSetAction({
+				actionName: "PrepareChanges",
+				runOrder: 3,
+				stackName: props.stackName ? props.stackName : props.stack.stackName,
+				account: props.stack.account,
+				region: props.stack.region,
+				changeSetName: `${this.name}Changes`,
+				adminPermissions: true,
+				templatePath: buildArtifact.atPath(
+					path.join(scope.buildDir, props.stack.templateFile),
+				),
+			}),
+			...(props.manualApproval
+				? [
+						new ManualApprovalAction({
+							actionName: "ApproveChanges",
+							runOrder: 4,
+						}),
+				  ]
+				: []),
+			new CloudFormationExecuteChangeSetAction({
+				actionName: "ExecuteChanges",
+				runOrder: props.manualApproval ? 5 : 4,
+				stackName: props.stackName ? props.stackName : props.stack.stackName,
+				account: props.stack.account,
+				region: props.stack.region,
+				changeSetName: `${this.name}Changes`,
+			}),
+		];
+	}
 }
 
 export function isPipeline(item: Segment): item is PipelineSegment {
-  return item.isPipeline;
+	return item.isPipeline;
 }

package/src/pipeline.ts

@@ -73,7 +73,7 @@ export class Pipeline extends Stack {
 		}
 
 		if (
-			segments[1].length === 1 &&
+			segments[1].length !== 1 ||
 			segments[1].filter(isPipeline).length !== segments[1].length
 		) {
 			throw new Error("Second segment must be the pipeline segment");

package/src/publish-assets-action.ts

@@ -1,123 +1,123 @@
 import { Stack } from "aws-cdk-lib";
 import { Construct } from "constructs";
 import {
-  ActionBindOptions,
-  ActionConfig,
-  ActionProperties,
-  Artifact,
-  IAction,
-  IStage,
+	ActionBindOptions,
+	ActionConfig,
+	ActionProperties,
+	Artifact,
+	IAction,
+	IStage,
 } from "aws-cdk-lib/aws-codepipeline";
 import { BuildSpec, LinuxBuildImage, Project } from "aws-cdk-lib/aws-codebuild";
 import { CodeBuildAction } from "aws-cdk-lib/aws-codepipeline-actions";
 import {
-  AccountPrincipal,
-  CompositePrincipal,
-  PolicyDocument,
-  PolicyStatement,
-  Role,
-  ServicePrincipal,
+	AccountPrincipal,
+	CompositePrincipal,
+	PolicyDocument,
+	PolicyStatement,
+	Role,
+	ServicePrincipal,
 } from "aws-cdk-lib/aws-iam";
 import { IRuleTarget, RuleProps, Rule } from "aws-cdk-lib/aws-events";
 import * as path from "path";
 
 export interface PublishAssetsActionProps {
-  readonly actionName: string;
-  readonly input: Artifact;
-  readonly manifestPath: string;
-  readonly runOrder?: number;
+	readonly actionName: string;
+	readonly input: Artifact;
+	readonly manifestPath: string;
+	readonly runOrder?: number;
 }
 
 export class PublishAssetsAction extends Construct implements IAction {
-  public readonly actionProperties: ActionProperties;
+	public readonly actionProperties: ActionProperties;
 
-  bound(
-    scope: Construct,
-    stage: IStage,
-    options: ActionBindOptions,
-  ): ActionConfig {
-    throw new Error(`Method not implemented.${!scope && !stage! && options}`);
-  }
+	bound(
+		scope: Construct,
+		stage: IStage,
+		options: ActionBindOptions,
+	): ActionConfig {
+		throw new Error(`Method not implemented.${!scope && !stage! && options}`);
+	}
 
-  bind(
-    scope: Construct,
-    stage: IStage,
-    options: ActionBindOptions,
-  ): ActionConfig {
-    throw new Error(`Method not implemented.${!scope && !stage! && options}`);
-  }
+	bind(
+		scope: Construct,
+		stage: IStage,
+		options: ActionBindOptions,
+	): ActionConfig {
+		throw new Error(`Method not implemented.${!scope && !stage! && options}`);
+	}
 
-  onStateChange(
-    name: string,
-    target?: IRuleTarget | undefined,
-    options?: RuleProps | undefined,
-  ): Rule {
-    throw new Error(`Method not implemented.${!name && !target! && options}`);
-  }
+	onStateChange(
+		name: string,
+		target?: IRuleTarget | undefined,
+		options?: RuleProps | undefined,
+	): Rule {
+		throw new Error(`Method not implemented.${!name && !target! && options}`);
+	}
 
-  constructor(scope: Construct, id: string, props: PublishAssetsActionProps) {
-    super(scope, id);
-    const codeBuild = new CodeBuildAction({
-      ...props,
-      input: props.input,
-      project: new Project(this, id, {
-        environment: {
-          buildImage: LinuxBuildImage.AMAZON_LINUX_2_5,
-        },
-        role: new Role(this, "UpdatePipelineCodeCuildRole", {
-          assumedBy: new CompositePrincipal(
-            new ServicePrincipal("codebuild.amazonaws.com"),
-            new AccountPrincipal(Stack.of(this).account),
-          ),
-          inlinePolicies: {
-            selfMutation: new PolicyDocument({
-              statements: [
-                new PolicyStatement({
-                  actions: ["sts:AssumeRole"],
-                  resources: [`arn:*:iam::${Stack.of(this).account}:role/*`],
-                  conditions: {
-                    "ForAnyValue:StringEquals": {
-                      "iam:ResourceTag/aws-cdk:bootstrap-role": [
-                        "image-publishing",
-                        "file-publishing",
-                        "deploy",
-                      ],
-                    },
-                  },
-                }),
-              ],
-            }),
-          },
-        }),
-        buildSpec: BuildSpec.fromObject({
-          version: "0.2",
-          phases: {
-            install: {
-              "runtime-versions": {
-                nodejs: "latest",
-              },
-              commands: ["npm i -g @flit/publish-cdk-assets@latest"],
-            },
-            build: {
-              commands: `pca ${
-                props.manifestPath ? path.normalize(props.manifestPath) : "."
-              }`,
-            },
-          },
-        }),
-      }),
-    });
+	constructor(scope: Construct, id: string, props: PublishAssetsActionProps) {
+		super(scope, id);
+		const codeBuild = new CodeBuildAction({
+			...props,
+			input: props.input,
+			project: new Project(this, id, {
+				environment: {
+					buildImage: LinuxBuildImage.AMAZON_LINUX_2_5,
+				},
+				role: new Role(this, "UpdatePipelineCodeCuildRole", {
+					assumedBy: new CompositePrincipal(
+						new ServicePrincipal("codebuild.amazonaws.com"),
+						new AccountPrincipal(Stack.of(this).account),
+					),
+					inlinePolicies: {
+						selfMutation: new PolicyDocument({
+							statements: [
+								new PolicyStatement({
+									actions: ["sts:AssumeRole"],
+									resources: [`arn:*:iam::${Stack.of(this).account}:role/*`],
+									conditions: {
+										"ForAnyValue:StringEquals": {
+											"iam:ResourceTag/aws-cdk:bootstrap-role": [
+												"image-publishing",
+												"file-publishing",
+												"deploy",
+											],
+										},
+									},
+								}),
+							],
+						}),
+					},
+				}),
+				buildSpec: BuildSpec.fromObject({
+					version: "0.2",
+					phases: {
+						install: {
+							"runtime-versions": {
+								nodejs: "latest",
+							},
+							commands: ["npm i -g @flit/publish-cdk-assets@latest"],
+						},
+						build: {
+							commands: `pca ${
+								props.manifestPath ? path.normalize(props.manifestPath) : "."
+							}`,
+						},
+					},
+				}),
+			}),
+		});
 
-    this.actionProperties = codeBuild.actionProperties;
-    this.bind = (
-      scope: Construct,
-      stage: IStage,
-      options: ActionBindOptions,
-    ): ActionConfig => codeBuild.bind(scope, stage, options);
-    this.onStateChange = (
-      name: string,
-      target?: IRuleTarget,
-      options?: RuleProps,
-    ): Rule => codeBuild.onStateChange(name, target, options);
-  }
+		this.actionProperties = codeBuild.actionProperties;
+		this.bind = (
+			scope: Construct,
+			stage: IStage,
+			options: ActionBindOptions,
+		): ActionConfig => codeBuild.bind(scope, stage, options);
+		this.onStateChange = (
+			name: string,
+			target?: IRuleTarget,
+			options?: RuleProps,
+		): Rule => codeBuild.onStateChange(name, target, options);
+	}
 }

package/src/s3-source-segment.ts

@@ -1,7 +1,7 @@
 import { IAction } from "aws-cdk-lib/aws-codepipeline";
 import {
-  S3SourceAction,
-  S3Trigger,
+	S3SourceAction,
+	S3Trigger,
 } from "aws-cdk-lib/aws-codepipeline-actions";
 import { SecretValue } from "aws-cdk-lib";
 import { IBucket } from "aws-cdk-lib/aws-s3";
@@ -12,51 +12,51 @@ import { SegmentConstructed } from "./segment";
 import { SourceSegment, SourceSegmentProps } from "./source-segment";
 
 export interface S3SourceSegmentProps extends SourceSegmentProps {
-  readonly oauthToken: SecretValue;
-  readonly bucket: IBucket;
-  readonly bucketKey: string;
-  readonly trigger?: S3Trigger;
-  readonly variablesNamespace?: string;
+	readonly oauthToken: SecretValue;
+	readonly bucket: IBucket;
+	readonly bucketKey: string;
+	readonly trigger?: S3Trigger;
+	readonly variablesNamespace?: string;
 }
 
 /**
  * @category Segments
  */
 export class S3SourceSegment extends SourceSegment {
-  private props: S3SourceSegmentProps;
-  constructor(props: S3SourceSegmentProps) {
-    super(props);
-    this.props = props;
-  }
-  construct(scope: Pipeline): SegmentConstructed {
-    const name = `${this.props.bucket}-${this.props.bucketKey}`;
+	private props: S3SourceSegmentProps;
+	constructor(props: S3SourceSegmentProps) {
+		super(props);
+		this.props = props;
+	}
+	construct(scope: Pipeline): SegmentConstructed {
+		const name = `${this.props.bucket}-${this.props.bucketKey}`;
 
-    return new S3SourceSegmentConstructed(scope, name, {
-      ...this.props,
-      actionName: name,
-    });
-  }
+		return new S3SourceSegmentConstructed(scope, name, {
+			...this.props,
+			actionName: name,
+		});
+	}
 }
 
 export interface S3SourceSegmentConstructedProps {
-  readonly output: Artifact;
-  readonly actionName: string;
-  readonly bucket: IBucket;
-  readonly bucketKey: string;
-  readonly trigger?: S3Trigger;
-  readonly variablesNamespace?: string;
+	readonly output: Artifact;
+	readonly actionName: string;
+	readonly bucket: IBucket;
+	readonly bucketKey: string;
+	readonly trigger?: S3Trigger;
+	readonly variablesNamespace?: string;
 }
 
 export class S3SourceSegmentConstructed extends SegmentConstructed {
-  readonly name: string;
-  readonly actions: IAction[];
-  constructor(
-    scope: Pipeline,
-    id: string,
-    props: S3SourceSegmentConstructedProps,
-  ) {
-    super(scope, id);
-    this.name = "Source";
-    this.actions = [new S3SourceAction(props)];
-  }
+	readonly name: string;
+	readonly actions: IAction[];
+	constructor(
+		scope: Pipeline,
+		id: string,
+		props: S3SourceSegmentConstructedProps,
+	) {
+		super(scope, id);
+		this.name = "Source";
+		this.actions = [new S3SourceAction(props)];
+	}
 }