@flit/cdk-pipeline 1.0.25 → 1.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flit/cdk-pipeline",
-  "version": "1.0.25",
+  "version": "1.1.0",
   "description": "A highly customizable and extensible CI/CD pipeline intended as alternative to CDK's native CodePipeline",
   "keywords": [
     "aws",
@@ -11,11 +11,11 @@
     "codepipeline",
     "cicd"
   ],
-  "homepage": "https://p-mercury.github.io/jumper-de/modules/_flit_cdk_pipeline",
-  "bugs": "https://github.com/p-mercury/jumper-de/issues",
+  "homepage": "https://github.com/jumper-de/cdk-pipeline",
+  "bugs": "https://github.com/jumper-de/cdk-pipeline/issues",
   "repository": {
     "type": "git",
-    "url": "https://github.com/p-mercury/jumper-de.git"
+    "url": "https://github.com/jumper-de/cdk-pipeline.git"
   },
   "license": "Apache-2.0",
   "author": {
@@ -29,6 +29,7 @@
     "./dist",
     "./src",
     "./.jsii",
+    "./LICENSE.txt",
     "./README.md"
   ],
   "scripts": {
@@ -36,20 +37,16 @@
     "prepack": "jsii"
   },
   "devDependencies": {
-    "@types/node": "^20.11.16",
-    "aws-cdk-lib": "^2.126.0",
-    "cdk-aws-lambda-powertools-layer": "^3.7.0",
-    "constructs": "10.3.0",
-    "jest": "^29.7.0",
-    "jsii": "^5.3.12",
-    "jsii-pacmak": "^1.94.0",
-    "ts-jest": "^29.1.2",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.3.3"
+    "@types/node": "^22.7.8",
+    "aws-cdk-lib": "2.163.0",
+    "constructs": "10.4.2",
+    "jsii": "^5.5.4",
+    "jsii-pacmak": "^1.104.0",
+    "typescript": "^5.6.3"
   },
   "peerDependencies": {
-    "aws-cdk-lib": "^2.126.0",
-    "constructs": "^10.3.0"
+    "aws-cdk-lib": "2.163.0",
+    "constructs": "10.4.2"
   },
   "publishConfig": {
     "access": "public"
@@ -82,9 +79,5 @@
       }
     }
   },
-  "stability": "stable",
-  "typedocOptions": {
-    "entryPoints": "./src/index.ts",
-    "readme": "./TYPEDOC.md"
-  }
+  "stability": "stable"
 }

package/src/pipeline-segment.ts

@@ -1,9 +1,24 @@
-import { BuildEnvironmentVariable } from "aws-cdk-lib/aws-codebuild";
+import {
+  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,
+} from "aws-cdk-lib/aws-codepipeline-actions";
+import * as path from "path";
 
 import { Artifact } from "./artifact";
 import { Segment, SegmentConstructed } from "./segment";
-import { StackSegmentConstructed } from "./stack-segment";
 import { Pipeline } from "./pipeline";
+import { PublishAssetsAction } from "./publish-assets-action";
 
 export interface PipelineSegmentProps {
   /**
@@ -14,7 +29,7 @@ export interface PipelineSegmentProps {
    * The command(s) to build the stack.
    * @example "cdk synth StackName --strict --exclusively"
    */
-  readonly command: string | string[];
+  readonly project: ProjectProps;
   /**
    * The environmental variables for the build stage.
    */
@@ -62,7 +77,7 @@ export class PipelineSegment extends Segment {
   }
 
   construct(scope: Pipeline): SegmentConstructed {
-    return new StackSegmentConstructed(scope, `Deploy${scope.stackName}`, {
+    return new PipelineSegmentConstructed(scope, `Deploy${scope.stackName}`, {
       ...this.props,
       stack: scope,
       input: this.inputs[0],
@@ -70,3 +85,96 @@ export class PipelineSegment extends Segment {
     });
   }
 }
+
+export interface PipelineSegmentConstructedProps {
+  readonly stack: Stack;
+  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;
+  readonly outputFileName?: string;
+  readonly manualApproval?: Boolean;
+}
+
+export class PipelineSegmentConstructed extends SegmentConstructed {
+  readonly name: string;
+  readonly actions: IAction[];
+
+  constructor(
+    scope: Pipeline,
+    id: string,
+    props: PipelineSegmentConstructedProps,
+  ) {
+    super(scope, id);
+
+    this.name = props.stack.stackName;
+
+    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.account,
+        region: props.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.account,
+        region: props.region,
+        changeSetName: `${props.stack.stackName}Changes`,
+      }),
+    ];
+  }
+}

package/src/pipeline.ts

@@ -1,6 +1,10 @@
 import { App, Stack, StackProps } from "aws-cdk-lib";
 import { Construct } from "constructs";
-import { Pipeline as AwsPipeline, IAction } from "aws-cdk-lib/aws-codepipeline";
+import {
+  Pipeline as AwsPipeline,
+  IAction,
+  PipelineType,
+} from "aws-cdk-lib/aws-codepipeline";
 import * as path from "path";
 
 import { Artifact } from "./artifact";
@@ -68,6 +72,7 @@ export class Pipeline extends Stack {
     new AwsPipeline(this, "Pipeline", {
       pipelineName: props.pipelineName,
       restartExecutionOnUpdate: true,
+      pipelineType: PipelineType.V2,
       stages: [
         {
           stageName: "Source",

package/src/publish-assets-action.ts

@@ -96,10 +96,7 @@ export class PublishAssetsAction extends Construct implements IAction {
               "runtime-versions": {
                 nodejs: "latest",
               },
-              commands: [
-                "n lts",
-                "npm i -g npm@latest @flit/publish-cdk-assets@latest",
-              ],
+              commands: ["npm i -g npm@latest @flit/publish-cdk-assets@latest"],
             },
             build: {
               commands: `pca ${

package/src/stack-segment.ts

@@ -2,9 +2,9 @@ import { Stack } from "aws-cdk-lib";
 import {
   BuildEnvironmentVariable,
   BuildSpec,
-  ComputeType,
-  LinuxBuildImage,
+  mergeBuildSpecs,
   Project,
+  ProjectProps,
 } from "aws-cdk-lib/aws-codebuild";
 import { IAction } from "aws-cdk-lib/aws-codepipeline";
 import {
@@ -16,10 +16,10 @@ import {
 import { IRole } from "aws-cdk-lib/aws-iam";
 import * as path from "path";
 
-import { PublishAssetsAction } from "./publish-assets-action";
 import { Artifact } from "./artifact";
 import { Segment, SegmentConstructed } from "./segment";
 import { Pipeline } from "./pipeline";
+import { PublishAssetsAction } from "./publish-assets-action";
 
 export interface StackSegmentProps {
   /**
@@ -34,7 +34,7 @@ export interface StackSegmentProps {
    * The command(s) to build the stack.
    * @example "cdk synth StackName --strict --exclusively"
    */
-  readonly command: string | string[];
+  readonly project?: ProjectProps;
   /**
    * The role for the build stage.
    */
@@ -99,7 +99,7 @@ export class StackSegment extends Segment {
 
 export interface StackSegmentConstructedProps {
   readonly stack: Stack;
-  readonly command: string | string[];
+  readonly project?: ProjectProps;
   readonly environmentVariables?: { [key: string]: BuildEnvironmentVariable };
   readonly stackName?: string;
   readonly account?: string;
@@ -124,59 +124,53 @@ export class StackSegmentConstructed extends SegmentConstructed {
 
     this.name = props.stack.stackName;
 
-    const buildArtifact = new Artifact();
+    const buildArtifact = props.project ? new Artifact() : undefined;
 
     this.actions = [
-      new CodeBuildAction({
-        actionName: "Build",
-        runOrder: 1,
-        input: props.input,
-        extraInputs: props.extraInputs,
-        outputs: [buildArtifact],
-        environmentVariables: props.environmentVariables,
-        project: new Project(this, "UpdateCodeBuild", {
-          environment: {
-            computeType: ComputeType.MEDIUM,
-            buildImage: LinuxBuildImage.AMAZON_LINUX_2_5,
-            privileged: true,
-          },
-          buildSpec: BuildSpec.fromObject({
-            version: "0.2",
-            phases: {
-              install: {
-                "runtime-versions": {
-                  nodejs: "latest",
-                },
-                commands: ["n 18.18.2", "npm i -g npm@latest", "npm ci"],
-              },
-              build: {
-                commands: props.command,
-              },
-            },
-            artifacts: {
-              files: [path.join(scope.buildDir, "**/*")],
-            },
-            cache: {
-              paths: ["/root/.npm/**/*"],
-            },
-          }),
-        }),
-      }),
-      new PublishAssetsAction(this, "PublishAssets", {
-        actionName: "PublishAssets",
-        runOrder: 2,
-        input: buildArtifact,
-        manifestPath: scope.buildDir,
-      }),
+      ...(buildArtifact
+        ? [
+            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,
+        runOrder: buildArtifact ? 3 : 1,
         stackName: props.stackName ? props.stackName : props.stack.stackName,
         account: props.account,
         region: props.region,
         changeSetName: `${props.stack.stackName}Changes`,
         adminPermissions: true,
-        templatePath: buildArtifact.atPath(
+        templatePath: (buildArtifact ? buildArtifact : props.input).atPath(
           path.join(scope.buildDir, props.stack.templateFile),
         ),
       }),
@@ -184,13 +178,19 @@ export class StackSegmentConstructed extends SegmentConstructed {
         ? [
             new ManualApprovalAction({
               actionName: "ApproveChanges",
-              runOrder: 4,
+              runOrder: buildArtifact ? 4 : 2,
             }),
           ]
         : []),
       new CloudFormationExecuteChangeSetAction({
         actionName: "ExecuteChanges",
-        runOrder: props.manualApproval ? 5 : 4,
+        runOrder: props.manualApproval
+          ? buildArtifact
+            ? 5
+            : 3
+          : buildArtifact
+            ? 4
+            : 2,
         stackName: props.stackName ? props.stackName : props.stack.stackName,
         account: props.account,
         region: props.region,