@flit/cdk-pipeline 1.2.4 → 1.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flit/cdk-pipeline",
-  "version": "1.2.4",
+  "version": "1.4.0",
   "description": "A highly customizable and extensible CI/CD pipeline intended as alternative to CDK's native CodePipeline",
   "keywords": [
     "aws",
@@ -53,12 +53,12 @@
     ]
   },
   "devDependencies": {
-    "@types/node": "^22.10.7",
+    "@types/node": "^22.13.5",
     "aws-cdk-lib": "^2.174.0",
     "constructs": "^10.4.0",
-    "jsii": "^5.7.4",
-    "jsii-pacmak": "^1.106.0",
-    "prettier": "^3.4.2",
+    "jsii": "^5.7.6",
+    "jsii-pacmak": "^1.108.0",
+    "prettier": "^3.5.2",
     "prettier-plugin-packagejson": "^2.5.8",
     "typescript": "^5.7.3"
   },

package/src/code-star-source-segment.ts

@@ -9,7 +9,7 @@ import { SourceSegment, SourceSegmentProps } from "./source-segment";
 export interface CodeStarSourceSegmentProps extends SourceSegmentProps {
   /**
    * The owning user or organization of the repository.
-   * @example `"aws"`
+   * @example "aws"
    */
   readonly owner: string;
   /**
@@ -21,12 +21,12 @@ export interface CodeStarSourceSegmentProps extends SourceSegmentProps {
   readonly connectionArn: string;
   /**
    * The name of the repository.
-   * @example `"aws-cdk"`
+   * @example "aws-cdk"
    */
   readonly repository: string;
   /**
    * The branch to build.
-   * @default `"master"`
+   * @default "master"
    */
   readonly branch?: string;
   readonly triggerOnPush?: boolean;

package/src/git-hub-source-segment.ts

@@ -14,17 +14,17 @@ export interface GitHubSourceSegmentProps extends SourceSegmentProps {
   readonly oauthToken: SecretValue;
   /**
    * The owning user or organization of the repository.
-   * @example `"aws"`
+   * @example "aws"
    */
   readonly owner: string;
   /**
    * The name of the repository.
-   * @example `"aws-cdk"`
+   * @example "aws-cdk"
    */
   readonly repository: string;
   /**
    * The branch to build.
-   * @default `"master"`
+   * @default "master"
    */
   readonly branch?: string;
   readonly trigger?: GitHubTrigger;

package/src/pipeline.ts

@@ -7,7 +7,7 @@ import {
 } from "aws-cdk-lib/aws-codepipeline";
 import * as path from "path";
 
-import { Segment } from "./segment";
+import { Segment, SegmentConstructed } from "./segment";
 import { isSource } from "./source-segment";
 import { isPipeline } from "./pipeline-segment";
 
@@ -20,13 +20,13 @@ export interface PipelineProps extends StackProps {
   /**
    * The path to the cdk projects root directory containing the cdk.json file
    * relative to the asset root
-   * @default `"."`
+   * @default "."
    */
   readonly rootDir?: string;
   /**
    * The segments to populating the pipeline.
    */
-  readonly segments: Segment[];
+  readonly segments: (Segment | Segment[])[];
 }
 
 /**
@@ -50,32 +50,38 @@ export class Pipeline extends Stack {
 
     if (!this.bundlingRequired) return;
 
-    props.segments.forEach((segment) => {
-      segment.inputs.forEach((artifact) => {
-        if (!artifact.producer) {
-          throw new Error("Artifact consumed but never produced.");
-        }
+    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.");
+          }
+        });
       });
     });
 
-    const sourceSegments = props.segments.filter(isSource);
-    const pipelineSegments = props.segments.filter(isPipeline);
+    if (segments[0].filter(isSource).length !== segments[0].length) {
+      throw new Error("First segment must contain only source segments");
+    }
 
-    if (pipelineSegments.length < 1) {
-      throw new Error(
-        "Missing pipeline segment, one instance of the pipeline segment is required in the segments array.",
-      );
+    if (segments.find((unit) => unit.filter(isSource).length)) {
+      throw new Error("Only the first segment can contain source segments");
     }
 
-    if (pipelineSegments.length > 1) {
-      throw new Error(
-        "To many pipeline segment, only one instance of the pipeline segment can be present in the segments array.",
-      );
+    if (
+      segments[0].length === 1 &&
+      segments[0].filter(isPipeline).length !== segments[0].length
+    ) {
+      throw new Error("Second segment must be the pipeline segment");
     }
 
-    const segments: Segment[] = props.segments.filter(
-      (segment) => !isSource(segment) && !isPipeline(segment),
-    );
+    if (segments.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,
@@ -85,7 +91,7 @@ export class Pipeline extends Stack {
         {
           stageName: "Source",
           actions: [
-            ...sourceSegments.reduce(
+            ...segments[0].reduce(
               (actions, segment) => [
                 ...actions,
                 ...segment.construct(this).actions,
@@ -96,13 +102,27 @@ export class Pipeline extends Stack {
         },
         {
           stageName: "Pipeline",
-          actions: [...pipelineSegments[0].construct(this).actions],
+          actions: [
+            ...segments[1].reduce(
+              (actions, segment) => [
+                ...actions,
+                ...segment.construct(this).actions,
+              ],
+              [] as IAction[],
+            ),
+          ],
         },
-        ...segments.map((segment) => {
-          const build = segment.construct(this);
+        ...segments.slice(2).map((unit) => {
+          const builds = unit.reduce(
+            (segments, segment) => [...segments, segment.construct(this)],
+            [] as SegmentConstructed[],
+          );
           return {
-            stageName: build.name,
-            actions: build.actions,
+            stageName: builds.map((build) => build.name).join(""),
+            actions: builds.reduce(
+              (actions, build) => [...actions, ...build.actions],
+              [] as IAction[],
+            ),
           };
         }),
       ],

package/src/stack-segment.ts

@@ -48,18 +48,22 @@ export interface StackSegmentProps {
    * @default The name of the given stack.
    */
   readonly stackName?: string;
+  /**
+   * The artifact to hold the output of the build if this stack includes a build.
+   */
+  readonly buildOutput?: Artifact;
   /**
    * The artifact to hold the stack deployment output file.
    */
-  readonly output?: Artifact;
+  readonly stackOutput?: Artifact;
   /**
    * The filename for the file in the output artifact
-   * @default `"artifact.json"`
+   * @default "artifact.json"
    */
   readonly outputFileName?: string;
   /**
    * Does this stage require manual approval of the change set?
-   * @default `false`
+   * @default false
    */
   readonly manualApproval?: Boolean;
 }
@@ -71,7 +75,10 @@ export class StackSegment extends Segment {
   readonly props: StackSegmentProps;
 
   constructor(props: StackSegmentProps) {
-    super(props);
+    super({
+      ...props,
+      output: [props.buildOutput, props.stackOutput].filter((a) => !!a),
+    });
     this.props = props;
   }
 
@@ -95,7 +102,8 @@ export interface StackSegmentConstructedProps {
   readonly stackName?: string;
   readonly input: Artifact;
   readonly extraInputs?: Artifact[];
-  readonly output?: Artifact;
+  readonly buildOutput?: Artifact;
+  readonly stackOutput?: Artifact;
   readonly outputFileName?: string;
   readonly manualApproval?: Boolean;
 }
@@ -113,7 +121,9 @@ export class StackSegmentConstructed extends SegmentConstructed {
 
     this.name = props.stack.stackName;
 
-    const buildArtifact = props.project ? new Artifact() : undefined;
+    const buildArtifact = props.project
+      ? props.buildOutput || new Artifact()
+      : undefined;
 
     this.actions = [
       ...(buildArtifact
@@ -184,11 +194,11 @@ export class StackSegmentConstructed extends SegmentConstructed {
         account: props.stack.account,
         region: props.stack.region,
         changeSetName: `${props.stack.stackName}Changes`,
-        output: props.output,
+        output: props.stackOutput,
         outputFileName: props.outputFileName
           ? props.outputFileName
-          : props.output
-            ? `artifact.json`
+          : props.stackOutput
+            ? "artifact.json"
             : undefined,
       }),
     ];