@flit/cdk-pipeline 1.4.4 → 2.0.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: `${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`,
+			}),
+		];
+	}
 }
 
 export function isPipeline(item: Segment): item is PipelineSegment {
-  return item.isPipeline;
+	return item.isPipeline;
 }

package/src/pipeline.ts

@@ -1,9 +1,9 @@
 import { App, Stack, StackProps } from "aws-cdk-lib";
 import { Construct } from "constructs";
 import {
-  Pipeline as AwsPipeline,
-  IAction,
-  PipelineType,
+	Pipeline as AwsPipeline,
+	IAction,
+	PipelineType,
 } from "aws-cdk-lib/aws-codepipeline";
 import * as path from "path";
 
@@ -12,120 +12,120 @@ import { isSource } from "./source-segment";
 import { isPipeline } from "./pipeline-segment";
 
 export interface PipelineProps extends StackProps {
-  /**
-   * The name of the generated pipeline.
-   * @default Stack ID
-   */
-  readonly pipelineName?: string;
-  /**
-   * The path to the cdk projects root directory containing the cdk.json file
-   * relative to the asset root
-   * @default "."
-   */
-  readonly rootDir?: string;
-  /**
-   * The segments to populating the pipeline.
-   */
-  readonly segments: (Segment | Segment[])[];
+	/**
+	 * The name of the generated pipeline.
+	 * @default Stack ID
+	 */
+	readonly pipelineName?: string;
+	/**
+	 * The path to the cdk projects root directory containing the cdk.json file
+	 * relative to the asset root
+	 * @default "."
+	 */
+	readonly rootDir?: string;
+	/**
+	 * The segments to populating the pipeline.
+	 */
+	readonly segments: (Segment | Segment[])[];
 }
 
 /**
  * @category Constructs
  */
 export class Pipeline extends Stack {
-  readonly pipelineName: string;
-  readonly rootDir: string;
-  readonly buildDir: string;
+	readonly pipelineName: string;
+	readonly rootDir: string;
+	readonly buildDir: string;
 
-  constructor(
-    scope: Construct,
-    id: string,
-    readonly props: PipelineProps,
-  ) {
-    super(scope, id, props);
+	constructor(
+		scope: Construct,
+		id: string,
+		readonly props: PipelineProps,
+	) {
+		super(scope, id, props);
 
-    this.pipelineName = props.pipelineName || id;
-    this.rootDir = props.rootDir || ".";
-    this.buildDir = path.join(this.rootDir, (this.node.root as App).outdir);
+		this.pipelineName = props.pipelineName || id;
+		this.rootDir = props.rootDir || ".";
+		this.buildDir = path.join(this.rootDir, (this.node.root as App).outdir);
 
-    if (!this.bundlingRequired) return;
+		if (!this.bundlingRequired) return;
 
-    const segments = props.segments.map((segment) =>
-      Array.isArray(segment) ? segment : [segment],
-    );
+		const segments = props.segments.map((segment) =>
+			Array.isArray(segment) ? segment : [segment],
+		);
 
-    segments.forEach((unit) => {
-      unit.forEach((segment) => {
-        segment.inputs.forEach((artifact) => {
-          if (!artifact.producer) {
-            throw new Error("Artifact consumed but never produced.");
-          }
-        });
-      });
-    });
+		segments.forEach((unit) => {
+			unit.forEach((segment) => {
+				segment.inputs.forEach((artifact) => {
+					if (!artifact.producer) {
+						throw new Error("Artifact consumed but never produced.");
+					}
+				});
+			});
+		});
 
-    if (segments[0].filter(isSource).length !== segments[0].length) {
-      throw new Error("First segment must contain only source segments");
-    }
+		if (segments[0].filter(isSource).length !== segments[0].length) {
+			throw new Error("First segment must contain only source segments");
+		}
 
-    if (segments.slice(1).find((unit) => unit.filter(isSource).length)) {
-      throw new Error("Only the first segment can contain source segments");
-    }
+		if (segments.slice(1).find((unit) => unit.filter(isSource).length)) {
+			throw new Error("Only the first segment can contain source segments");
+		}
 
-    if (
-      segments[1].length === 1 &&
-      segments[1].filter(isPipeline).length !== segments[1].length
-    ) {
-      throw new Error("Second segment must be the pipeline segment");
-    }
+		if (
+			segments[1].length !== 1 ||
+			segments[1].filter(isPipeline).length !== segments[1].length
+		) {
+			throw new Error("Second segment must be the pipeline segment");
+		}
 
-    if (segments.slice(2).find((unit) => unit.filter(isPipeline).length)) {
-      throw new Error("Only the second segment can be the pipeline segment");
-    }
+		if (segments.slice(2).find((unit) => unit.filter(isPipeline).length)) {
+			throw new Error("Only the second segment can be the pipeline segment");
+		}
 
-    new AwsPipeline(this, "Pipeline", {
-      pipelineName: props.pipelineName,
-      restartExecutionOnUpdate: true,
-      pipelineType: PipelineType.V2,
-      stages: [
-        {
-          stageName: "Source",
-          actions: [
-            ...segments[0].reduce(
-              (actions, segment) => [
-                ...actions,
-                ...segment.construct(this).actions,
-              ],
-              [] as IAction[],
-            ),
-          ],
-        },
-        {
-          stageName: "Pipeline",
-          actions: [
-            ...segments[1].reduce(
-              (actions, segment) => [
-                ...actions,
-                ...segment.construct(this).actions,
-              ],
-              [] as IAction[],
-            ),
-          ],
-        },
-        ...segments.slice(2).map((unit) => {
-          const builds = unit.reduce(
-            (segments, segment) => [...segments, segment.construct(this)],
-            [] as SegmentConstructed[],
-          );
-          return {
-            stageName: builds.map((build) => build.name).join(""),
-            actions: builds.reduce(
-              (actions, build) => [...actions, ...build.actions],
-              [] as IAction[],
-            ),
-          };
-        }),
-      ],
-    });
-  }
+		new AwsPipeline(this, "Pipeline", {
+			pipelineName: props.pipelineName,
+			restartExecutionOnUpdate: true,
+			pipelineType: PipelineType.V2,
+			stages: [
+				{
+					stageName: "Source",
+					actions: [
+						...segments[0].reduce(
+							(actions, segment) => [
+								...actions,
+								...segment.construct(this).actions,
+							],
+							[] as IAction[],
+						),
+					],
+				},
+				{
+					stageName: "Pipeline",
+					actions: [
+						...segments[1].reduce(
+							(actions, segment) => [
+								...actions,
+								...segment.construct(this).actions,
+							],
+							[] as IAction[],
+						),
+					],
+				},
+				...segments.slice(2).map((unit) => {
+					const builds = unit.reduce(
+						(segments, segment) => [...segments, segment.construct(this)],
+						[] as SegmentConstructed[],
+					);
+					return {
+						stageName: builds.map((build) => build.name).join("-"),
+						actions: builds.reduce(
+							(actions, build) => [...actions, ...build.actions],
+							[] as IAction[],
+						),
+					};
+				}),
+			],
+		});
+	}
 }