@flit/cdk-pipeline 1.1.2 → 1.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flit/cdk-pipeline",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "A highly customizable and extensible CI/CD pipeline intended as alternative to CDK's native CodePipeline",
   "keywords": [
     "aws",
@@ -11,16 +11,15 @@
     "codepipeline",
     "cicd"
   ],
-  "homepage": "https://github.com/jumper-de/cdk-pipeline",
-  "bugs": "https://github.com/jumper-de/cdk-pipeline/issues",
+  "homepage": "https://github.com/vierroth/cdk-pipeline",
+  "bugs": "https://github.com/vierroth/cdk-pipeline/issues",
   "repository": {
     "type": "git",
-    "url": "https://github.com/jumper-de/cdk-pipeline.git"
+    "url": "https://github.com/vierroth/cdk-pipeline.git"
   },
   "license": "Apache-2.0",
   "author": {
     "name": "Luis Vierroth",
-    "email": "luis@jumper.de",
     "url": "https://github.com/p-mercury"
   },
   "main": "./dist/index.js",
@@ -32,21 +31,40 @@
     "./LICENSE.txt",
     "./README.md"
   ],
+  "workspaces": [
+    "./example"
+  ],
   "scripts": {
-    "build": "jsii",
+    "build": "jsii && (cd example && npm run build)",
     "prepack": "jsii"
   },
+  "prettier": {
+    "plugins": [
+      "prettier-plugin-packagejson"
+    ],
+    "tabWidth": 2,
+    "overrides": [
+      {
+        "files": "*.sublime-project",
+        "options": {
+          "parser": "json"
+        }
+      }
+    ]
+  },
   "devDependencies": {
-    "@types/node": "^22.10.2",
-    "aws-cdk-lib": "2.173.1",
-    "constructs": "10.4.2",
-    "jsii": "^5.7.2",
+    "@types/node": "^22.10.7",
+    "aws-cdk-lib": "^2.174.0",
+    "constructs": "^10.4.0",
+    "jsii": "^5.7.4",
     "jsii-pacmak": "^1.106.0",
-    "typescript": "^5.7.2"
+    "prettier": "^3.4.2",
+    "prettier-plugin-packagejson": "^2.5.8",
+    "typescript": "^5.7.3"
   },
   "peerDependencies": {
-    "aws-cdk-lib": "^2.163.0",
-    "constructs": "^10.4.2"
+    "aws-cdk-lib": "^2.174.0",
+    "constructs": "^10.4.0"
   },
   "publishConfig": {
     "access": "public"

package/src/artifact.ts

@@ -3,22 +3,22 @@ import { Artifact as AwsArtifact } from "aws-cdk-lib/aws-codepipeline";
 import { Segment } from "./segment";
 
 export class Artifact extends AwsArtifact {
-  private producer?: Segment;
-  private consumers: Segment[] = [];
+  private _producer?: Segment;
+  private _consumers: Segment[] = [];
   constructor(artifactName?: string) {
     super(artifactName);
   }
   produce(producer: Segment) {
-    if (this.producer) throw new Error("Artifact is already produced");
-    this.producer = producer;
+    if (this._producer) throw new Error("Artifact is already produced");
+    this._producer = producer;
   }
   consume(producer: Segment) {
     this.consumers.push(producer);
   }
-  obtainProducer(): Segment | undefined {
-    return this.producer;
+  get producer(): Segment | undefined {
+    return this._producer;
   }
-  obtainConsumers(): Segment[] {
-    return this.consumers;
+  get consumers(): Segment[] {
+    return this._consumers;
   }
 }

package/src/pipeline-segment.ts

@@ -39,14 +39,6 @@ export interface PipelineSegmentProps {
    * @deafult The name of the given stack.
    */
   readonly stackName?: string;
-  /**
-   * The AWS account this Action is supposed to operate in.
-   */
-  readonly account?: string;
-  /**
-   * The AWS region the given Action resides in.
-   */
-  readonly region?: string;
   /**
    * The artifact to hold the stack deployment output file.
    * @default no output artifact
@@ -68,7 +60,7 @@ export interface PipelineSegmentProps {
  * @category Segments
  */
 export class PipelineSegment extends Segment {
-  readonly isPipeline: boolean = true;
+  readonly isPipeline = true;
   readonly props: PipelineSegmentProps;
 
   constructor(props: PipelineSegmentProps) {
@@ -91,8 +83,6 @@ export interface PipelineSegmentConstructedProps {
   readonly project: ProjectProps;
   readonly environmentVariables?: { [key: string]: BuildEnvironmentVariable };
   readonly stackName?: string;
-  readonly account?: string;
-  readonly region?: string;
   readonly input: Artifact;
   readonly extraInputs?: Artifact[];
   readonly output?: Artifact;
@@ -151,8 +141,8 @@ export class PipelineSegmentConstructed extends SegmentConstructed {
         actionName: "PrepareChanges",
         runOrder: 3,
         stackName: props.stackName ? props.stackName : props.stack.stackName,
-        account: props.account,
-        region: props.region,
+        account: props.stack.account,
+        region: props.stack.region,
         changeSetName: `${props.stack.stackName}Changes`,
         adminPermissions: true,
         templatePath: buildArtifact.atPath(
@@ -171,10 +161,14 @@ export class PipelineSegmentConstructed extends SegmentConstructed {
         actionName: "ExecuteChanges",
         runOrder: props.manualApproval ? 5 : 4,
         stackName: props.stackName ? props.stackName : props.stack.stackName,
-        account: props.account,
-        region: props.region,
+        account: props.stack.account,
+        region: props.stack.region,
         changeSetName: `${props.stack.stackName}Changes`,
       }),
     ];
   }
 }
+
+export function isPipeline(item: Segment): item is PipelineSegment {
+  return item.isPipeline;
+}

package/src/pipeline.ts

@@ -7,22 +7,22 @@ import {
 } from "aws-cdk-lib/aws-codepipeline";
 import * as path from "path";
 
-import { Artifact } from "./artifact";
 import { Segment } from "./segment";
-import { SourceSegment } from "./source-segment";
-import { PipelineSegment } from "./pipeline-segment";
+import { isSource } from "./source-segment";
+import { isPipeline } from "./pipeline-segment";
 
 export interface PipelineProps extends StackProps {
   /**
    * The name of the generated pipeline.
-   * @default Stack ID
+   * @defaultValue Stack ID
    */
   readonly pipelineName?: string;
   /**
    * The path to the cdk projects root directory containing the cdk.json file
    * relative to the asset root
+   * @defaultValue `"."`
    */
-  readonly rootDir: string;
+  readonly rootDir?: string;
   /**
    * The segments to populating the pipeline.
    */
@@ -44,29 +44,37 @@ export class Pipeline extends Stack {
   ) {
     super(scope, id, props);
 
-    this.pipelineName = props.pipelineName ? props.pipelineName : id;
-    this.rootDir = props.rootDir;
+    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;
 
-    props.segments.forEach((segment: Segment) => {
-      segment.inputs.forEach((artifact: Artifact) => {
-        if (!artifact.obtainProducer())
+    props.segments.forEach((segment) => {
+      segment.inputs.forEach((artifact) => {
+        if (!artifact.producer) {
           throw new Error("Artifact consumed but never produced.");
+        }
       });
     });
 
-    const sourceSegments: SourceSegment[] = props.segments.filter(
-      (segment: Segment) => segment.isSource,
-    ) as SourceSegment[];
+    const sourceSegments = props.segments.filter(isSource);
+    const pipelineSegments = props.segments.filter(isPipeline);
+
+    if (pipelineSegments.length < 1) {
+      throw new Error(
+        "Missing pipeline segment, one instance of the pipeline segment is required in the segments array.",
+      );
+    }
 
-    const pipelineSegment: PipelineSegment | undefined = props.segments.find(
-      (segment: Segment) => segment.isPipeline,
-    ) as PipelineSegment;
+    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.",
+      );
+    }
 
     const segments: Segment[] = props.segments.filter(
-      (segment: Segment) => !segment.isSource && !segment.isPipeline,
+      (segment) => !isSource(segment) && !isPipeline(segment),
     );
 
     new AwsPipeline(this, "Pipeline", {
@@ -78,19 +86,19 @@ export class Pipeline extends Stack {
           stageName: "Source",
           actions: [
             ...sourceSegments.reduce(
-              (actions: IAction[], segment: SourceSegment) => [
+              (actions, segment) => [
                 ...actions,
                 ...segment.construct(this).actions,
               ],
-              [],
+              [] as IAction[],
             ),
           ],
         },
         {
           stageName: "Pipeline",
-          actions: [...pipelineSegment.construct(this).actions],
+          actions: [...pipelineSegments[0].construct(this).actions],
         },
-        ...segments.map((segment: Segment) => {
+        ...segments.map((segment) => {
           const build = segment.construct(this);
           return {
             stageName: build.name,

package/src/segment.ts

@@ -18,22 +18,14 @@ export abstract class Segment {
   readonly outputs: Artifact[] = [];
   constructor(props: SegmentProps) {
     if (props.input) {
-      this.inputs = (
-        props.input.constructor.name === "Array" ? props.input : [props.input]
-      ) as Artifact[];
-      this.inputs.forEach((artifact: Artifact) => {
-        artifact.consume(this);
-      }, this);
+      this.inputs = Array.isArray(props.input) ? props.input : [props.input];
+      this.inputs.forEach((artifact) => artifact.consume(this), this);
     }
     if (props.output) {
-      this.outputs = (
-        props.output.constructor.name === "Array"
-          ? props.output
-          : [props.output]
-      ) as Artifact[];
-      this.outputs.forEach((artifact: Artifact) => {
-        artifact.produce(this);
-      }, this);
+      this.outputs = Array.isArray(props.output)
+        ? props.output
+        : [props.output];
+      this.outputs.forEach((artifact) => artifact.produce(this), this);
     }
   }
   abstract construct(scope: Pipeline): SegmentConstructed;

package/src/source-segment.ts

@@ -6,5 +6,9 @@ export interface SourceSegmentProps {
 }
 
 export abstract class SourceSegment extends Segment {
-  readonly isSource: boolean = true;
+  readonly isSource = true;
+}
+
+export function isSource(item: Segment): item is SourceSegment {
+  return item.isSource;
 }

package/src/stack-segment.ts

@@ -45,30 +45,21 @@ export interface StackSegmentProps {
   readonly environmentVariables?: { [key: string]: BuildEnvironmentVariable };
   /**
    * The name of the stack to deploy the changes to.
-   * @deafult The name of the given stack.
+   * @defaultValue The name of the given stack.
    */
   readonly stackName?: string;
-  /**
-   * The AWS account this Action is supposed to operate in.
-   */
-  readonly account?: string;
-  /**
-   * The AWS region the given Action resides in.
-   */
-  readonly region?: 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
+   * @defaultValue `"artifact.json"``
    */
   readonly outputFileName?: string;
   /**
    * Does this stage require manual approval of the change set?
-   * @default false
+   * @defaultValue `false``
    */
   readonly manualApproval?: Boolean;
 }
@@ -102,8 +93,6 @@ export interface StackSegmentConstructedProps {
   readonly project?: ProjectProps;
   readonly environmentVariables?: { [key: string]: BuildEnvironmentVariable };
   readonly stackName?: string;
-  readonly account?: string;
-  readonly region?: string;
   readonly input: Artifact;
   readonly extraInputs?: Artifact[];
   readonly output?: Artifact;
@@ -166,8 +155,8 @@ export class StackSegmentConstructed extends SegmentConstructed {
         actionName: "PrepareChanges",
         runOrder: buildArtifact ? 3 : 1,
         stackName: props.stackName ? props.stackName : props.stack.stackName,
-        account: props.account,
-        region: props.region,
+        account: props.stack.account,
+        region: props.stack.region,
         changeSetName: `${props.stack.stackName}Changes`,
         adminPermissions: true,
         templatePath: (buildArtifact ? buildArtifact : props.input).atPath(
@@ -192,8 +181,8 @@ export class StackSegmentConstructed extends SegmentConstructed {
             ? 4
             : 2,
         stackName: props.stackName ? props.stackName : props.stack.stackName,
-        account: props.account,
-        region: props.region,
+        account: props.stack.account,
+        region: props.stack.region,
         changeSetName: `${props.stack.stackName}Changes`,
         output: props.output,
         outputFileName: props.outputFileName