@flit/cdk-pipeline 2.0.0 → 2.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@flit/cdk-pipeline",
-	"version": "2.0.0",
+	"version": "2.2.0",
 	"description": "A highly customizable and extensible CI/CD pipeline intended as alternative to CDK's native CodePipeline",
 	"keywords": [
 		"aws",

package/src/pipeline-segment.ts

@@ -143,7 +143,7 @@ export class PipelineSegmentConstructed extends SegmentConstructed {
 				stackName: props.stackName ? props.stackName : props.stack.stackName,
 				account: props.stack.account,
 				region: props.stack.region,
-				changeSetName: `${props.stack.stackName}Changes`,
+				changeSetName: `${this.name}Changes`,
 				adminPermissions: true,
 				templatePath: buildArtifact.atPath(
 					path.join(scope.buildDir, props.stack.templateFile),
@@ -163,7 +163,7 @@ export class PipelineSegmentConstructed extends SegmentConstructed {
 				stackName: props.stackName ? props.stackName : props.stack.stackName,
 				account: props.stack.account,
 				region: props.stack.region,
-				changeSetName: `${props.stack.stackName}Changes`,
+				changeSetName: `${this.name}Changes`,
 			}),
 		];
 	}

package/src/pipeline.ts

@@ -7,10 +7,15 @@ import {
 } from "aws-cdk-lib/aws-codepipeline";
 import * as path from "path";
 
-import { Segment, SegmentConstructed } from "./segment";
+import { isSegment, Segment, SegmentConstructed } from "./segment";
 import { isSource } from "./source-segment";
 import { isPipeline } from "./pipeline-segment";
 
+export interface SegmentGroup {
+	readonly stageName?: string;
+	readonly segments: Segment[];
+}
+
 export interface PipelineProps extends StackProps {
 	/**
 	 * The name of the generated pipeline.
@@ -26,7 +31,7 @@ export interface PipelineProps extends StackProps {
 	/**
 	 * The segments to populating the pipeline.
 	 */
-	readonly segments: (Segment | Segment[])[];
+	readonly segments: (Segment | Segment[] | SegmentGroup)[];
 }
 
 /**
@@ -50,12 +55,16 @@ export class Pipeline extends Stack {
 
 		if (!this.bundlingRequired) return;
 
-		const segments = props.segments.map((segment) =>
-			Array.isArray(segment) ? segment : [segment],
+		const stages = props.segments.map((segment) =>
+			Array.isArray(segment)
+				? { stageName: undefined, segments: segment }
+				: isSegment(segment)
+				  ? { stageName: undefined, segments: [segment] }
+				  : segment,
 		);
 
-		segments.forEach((unit) => {
-			unit.forEach((segment) => {
+		stages.forEach((stage) => {
+			stage.segments.forEach((segment) => {
 				segment.inputs.forEach((artifact) => {
 					if (!artifact.producer) {
 						throw new Error("Artifact consumed but never produced.");
@@ -64,22 +73,28 @@ export class Pipeline extends Stack {
 			});
 		});
 
-		if (segments[0].filter(isSource).length !== segments[0].length) {
+		if (
+			stages[0].segments.filter(isSource).length !== stages[0].segments.length
+		) {
 			throw new Error("First segment must contain only source segments");
 		}
 
-		if (segments.slice(1).find((unit) => unit.filter(isSource).length)) {
+		if (
+			stages.slice(1).find((stage) => stage.segments.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
+			stages[1].segments.length !== 1 ||
+			stages[1].segments.filter(isPipeline).length !== stages[1].segments.length
 		) {
 			throw new Error("Second segment must be the pipeline segment");
 		}
 
-		if (segments.slice(2).find((unit) => unit.filter(isPipeline).length)) {
+		if (
+			stages.slice(2).find((stage) => stage.segments.filter(isPipeline).length)
+		) {
 			throw new Error("Only the second segment can be the pipeline segment");
 		}
 
@@ -89,9 +104,9 @@ export class Pipeline extends Stack {
 			pipelineType: PipelineType.V2,
 			stages: [
 				{
-					stageName: "Source",
+					stageName: stages[0].stageName || "Source",
 					actions: [
-						...segments[0].reduce(
+						...stages[0].segments.reduce(
 							(actions, segment) => [
 								...actions,
 								...segment.construct(this).actions,
@@ -101,9 +116,9 @@ export class Pipeline extends Stack {
 					],
 				},
 				{
-					stageName: "Pipeline",
+					stageName: stages[1].stageName || "Pipeline",
 					actions: [
-						...segments[1].reduce(
+						...stages[1].segments.reduce(
 							(actions, segment) => [
 								...actions,
 								...segment.construct(this).actions,
@@ -112,13 +127,14 @@ export class Pipeline extends Stack {
 						),
 					],
 				},
-				...segments.slice(2).map((unit) => {
-					const builds = unit.reduce(
+				...stages.slice(2).map((stage) => {
+					const builds = stage.segments.reduce(
 						(segments, segment) => [...segments, segment.construct(this)],
 						[] as SegmentConstructed[],
 					);
 					return {
-						stageName: builds.map((build) => build.name).join("-"),
+						stageName:
+							stage.stageName || builds.map((build) => build.name).join("-"),
 						actions: builds.reduce(
 							(actions, build) => [...actions, ...build.actions],
 							[] as IAction[],

package/src/segment.ts

@@ -11,6 +11,7 @@ export interface SegmentProps {
 }
 
 export abstract class Segment {
+	readonly isSegment: boolean = true;
 	readonly isSource: boolean = false;
 	readonly isPipeline: boolean = false;
 	readonly dependencies?: Stack[];
@@ -35,3 +36,7 @@ export abstract class SegmentConstructed extends Construct {
 	readonly name: string = "";
 	readonly actions: IAction[] = [];
 }
+
+export function isSegment(item: any): item is Segment {
+	return item.isSegment;
+}

package/src/stack-segment.ts

@@ -120,7 +120,7 @@ export class StackSegmentConstructed extends SegmentConstructed {
 	) {
 		super(scope, id);
 
-		this.name = props.stack.stackName;
+		this.name = props.stack.node.id;
 
 		const buildArtifact = props.project
 			? props.buildOutput || new Artifact()
@@ -208,7 +208,7 @@ export class StackSegmentConstructed extends SegmentConstructed {
 				stackName: props.stackName ? props.stackName : props.stack.stackName,
 				account: props.stack.account,
 				region: props.stack.region,
-				changeSetName: `${props.stack.stackName}Changes`,
+				changeSetName: `${this.name}Changes`,
 				adminPermissions: true,
 				templatePath: (buildArtifact ? buildArtifact : props.input).atPath(
 					path.join(scope.buildDir, props.stack.templateFile),
@@ -234,7 +234,7 @@ export class StackSegmentConstructed extends SegmentConstructed {
 				stackName: props.stackName ? props.stackName : props.stack.stackName,
 				account: props.stack.account,
 				region: props.stack.region,
-				changeSetName: `${props.stack.stackName}Changes`,
+				changeSetName: `${this.name}Changes`,
 				output: props.stackOutput,
 				outputFileName: props.outputFileName
 					? props.outputFileName