@cloudsnorkel/cdk-github-runners 0.7.4 → 0.7.6

package/.jsii

@@ -3114,7 +3114,7 @@
     "stability": "experimental"
   },
   "homepage": "https://github.com/CloudSnorkel/cdk-github-runners.git",
-  "jsiiVersion": "1.72.0 (build 4b8828b)",
+  "jsiiVersion": "1.73.0 (build 6faeda3)",
   "keywords": [
     "aws",
     "aws-cdk",
@@ -3184,7 +3184,7 @@
         },
         "locationInModule": {
           "filename": "src/providers/image-builders/ami.ts",
-          "line": 223
+          "line": 230
         },
         "parameters": [
           {
@@ -3215,7 +3215,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/providers/image-builders/ami.ts",
-        "line": 220
+        "line": 227
       },
       "methods": [
         {
@@ -3225,7 +3225,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/ami.ts",
-            "line": 285
+            "line": 296
           },
           "name": "addComponent",
           "parameters": [
@@ -3245,7 +3245,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/ami.ts",
-            "line": 300
+            "line": 311
           },
           "name": "addExtraCertificates",
           "parameters": [
@@ -3267,7 +3267,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/ami.ts",
-            "line": 313
+            "line": 324
           },
           "name": "bind",
           "overrides": "@cloudsnorkel/cdk-github-runners.IAmiBuilder",
@@ -3438,7 +3438,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/ami.ts",
-            "line": 271
+            "line": 282
           },
           "name": "prependComponent",
           "parameters": [
@@ -3599,6 +3599,25 @@
             "fqn": "@cloudsnorkel/cdk-github-runners.Architecture"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "true",
+            "remarks": "You may want to disable this if you are building a Windows image and don't have a Docker Desktop license.",
+            "stability": "experimental",
+            "summary": "Install Docker inside the image, so it can be used by the runner."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/image-builders/ami.ts",
+            "line": 115
+          },
+          "name": "installDocker",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -4480,7 +4499,16 @@
             {
               "name": "task",
               "type": {
-                "fqn": "aws-cdk-lib.aws_stepfunctions.TaskStateBase"
+                "union": {
+                  "types": [
+                    {
+                      "fqn": "aws-cdk-lib.aws_stepfunctions.Parallel"
+                    },
+                    {
+                      "fqn": "aws-cdk-lib.aws_stepfunctions.TaskStateBase"
+                    }
+                  ]
+                }
               }
             },
             {
@@ -5680,7 +5708,16 @@
             {
               "name": "task",
               "type": {
-                "fqn": "aws-cdk-lib.aws_stepfunctions.TaskStateBase"
+                "union": {
+                  "types": [
+                    {
+                      "fqn": "aws-cdk-lib.aws_stepfunctions.Parallel"
+                    },
+                    {
+                      "fqn": "aws-cdk-lib.aws_stepfunctions.TaskStateBase"
+                    }
+                  ]
+                }
               }
             },
             {
@@ -5734,7 +5771,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/ec2.ts",
-            "line": 370
+            "line": 402
           },
           "name": "grantStateMachine",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -5803,7 +5840,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/ec2.ts",
-            "line": 400
+            "line": 432
           },
           "name": "status",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -5832,7 +5869,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/ec2.ts",
-            "line": 421
+            "line": 453
           },
           "name": "connections",
           "overrides": "aws-cdk-lib.aws_ec2.IConnectable",
@@ -6177,7 +6214,16 @@
             {
               "name": "task",
               "type": {
-                "fqn": "aws-cdk-lib.aws_stepfunctions.TaskStateBase"
+                "union": {
+                  "types": [
+                    {
+                      "fqn": "aws-cdk-lib.aws_stepfunctions.Parallel"
+                    },
+                    {
+                      "fqn": "aws-cdk-lib.aws_stepfunctions.TaskStateBase"
+                    }
+                  ]
+                }
               }
             },
             {
@@ -6825,7 +6871,7 @@
         },
         "locationInModule": {
           "filename": "src/runner.ts",
-          "line": 187
+          "line": 188
         },
         "parameters": [
           {
@@ -6852,7 +6898,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/runner.ts",
-        "line": 169
+        "line": 170
       },
       "name": "GitHubRunners",
       "properties": [
@@ -6864,7 +6910,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 173
+            "line": 174
           },
           "name": "providers",
           "type": {
@@ -6884,7 +6930,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 178
+            "line": 179
           },
           "name": "secrets",
           "type": {
@@ -6898,7 +6944,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 187
+            "line": 188
           },
           "name": "props",
           "optional": true,
@@ -6920,7 +6966,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/runner.ts",
-        "line": 24
+        "line": 25
       },
       "name": "GitHubRunnersProps",
       "properties": [
@@ -6935,7 +6981,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 47
+            "line": 48
           },
           "name": "allowPublicSubnet",
           "optional": true,
@@ -6953,7 +6999,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 79
+            "line": 80
           },
           "name": "extraCertificates",
           "optional": true,
@@ -6972,7 +7018,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 86
+            "line": 87
           },
           "name": "idleTimeout",
           "optional": true,
@@ -6990,7 +7036,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 93
+            "line": 94
           },
           "name": "logOptions",
           "optional": true,
@@ -7009,7 +7055,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 30
+            "line": 31
           },
           "name": "providers",
           "optional": true,
@@ -7032,7 +7078,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 52
+            "line": 53
           },
           "name": "securityGroup",
           "optional": true,
@@ -7050,7 +7096,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 35
+            "line": 36
           },
           "name": "vpc",
           "optional": true,
@@ -7068,7 +7114,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 40
+            "line": 41
           },
           "name": "vpcSubnets",
           "optional": true,
@@ -7279,7 +7325,8 @@
       "fqn": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
       "interfaces": [
         "aws-cdk-lib.aws_ec2.IConnectable",
-        "aws-cdk-lib.aws_iam.IGrantable"
+        "aws-cdk-lib.aws_iam.IGrantable",
+        "constructs.IConstruct"
       ],
       "kind": "interface",
       "locationInModule": {
@@ -7898,7 +7945,16 @@
             {
               "name": "task",
               "type": {
-                "fqn": "aws-cdk-lib.aws_stepfunctions.TaskStateBase"
+                "union": {
+                  "types": [
+                    {
+                      "fqn": "aws-cdk-lib.aws_stepfunctions.Parallel"
+                    },
+                    {
+                      "fqn": "aws-cdk-lib.aws_stepfunctions.TaskStateBase"
+                    }
+                  ]
+                }
               }
             },
             {
@@ -8407,7 +8463,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/linux-components.ts",
-            "line": 49
+            "line": 51
           },
           "name": "awsCli",
           "parameters": [
@@ -8443,7 +8499,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/linux-components.ts",
-            "line": 135
+            "line": 137
           },
           "name": "docker",
           "parameters": [
@@ -8479,7 +8535,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/linux-components.ts",
-            "line": 154
+            "line": 156
           },
           "name": "extraCertificates",
           "parameters": [
@@ -8515,7 +8571,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/linux-components.ts",
-            "line": 89
+            "line": 91
           },
           "name": "git",
           "parameters": [
@@ -8551,7 +8607,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/linux-components.ts",
-            "line": 73
+            "line": 75
           },
           "name": "githubCli",
           "parameters": [
@@ -8587,7 +8643,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/linux-components.ts",
-            "line": 103
+            "line": 105
           },
           "name": "githubRunner",
           "parameters": [
@@ -8710,7 +8766,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/runner.ts",
-        "line": 99
+        "line": 100
       },
       "name": "LogOptions",
       "properties": [
@@ -8724,7 +8780,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 110
+            "line": 111
           },
           "name": "includeExecutionData",
           "optional": true,
@@ -8742,7 +8798,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 117
+            "line": 118
           },
           "name": "level",
           "optional": true,
@@ -8759,7 +8815,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 103
+            "line": 104
           },
           "name": "logGroupName",
           "optional": true,
@@ -8778,7 +8834,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 126
+            "line": 127
           },
           "name": "logRetention",
           "optional": true,
@@ -9833,7 +9889,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/windows-components.ts",
-            "line": 99
+            "line": 101
           },
           "name": "docker",
           "parameters": [
@@ -9863,7 +9919,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/windows-components.ts",
-            "line": 119
+            "line": 121
           },
           "name": "extraCertificates",
           "parameters": [
@@ -9959,7 +10015,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/windows-components.ts",
-            "line": 72
+            "line": 74
           },
           "name": "githubRunner",
           "parameters": [
@@ -9994,6 +10050,6 @@
       "symbolId": "src/providers/image-builders/windows-components:WindowsComponents"
     }
   },
-  "version": "0.7.4",
-  "fingerprint": "3UVhk5ng35wJIwrOZROcnXMz+h05AAzyrjETi7b4/50="
+  "version": "0.7.6",
+  "fingerprint": "ZZyPQhyjY7Cdx+RPoiCGbrij9KNR68fpSulMzukmnhg="
 }

package/API.md

@@ -2379,6 +2379,7 @@ const amiBuilderProps: AmiBuilderProps = { ... }
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.AmiBuilderProps.property.architecture">architecture</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.Architecture">Architecture</a></code> | Image architecture. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.AmiBuilderProps.property.installDocker">installDocker</a></code> | <code>boolean</code> | Install Docker inside the image, so it can be used by the runner. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.AmiBuilderProps.property.instanceType">instanceType</a></code> | <code>aws-cdk-lib.aws_ec2.InstanceType</code> | The instance type used to build the image. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.AmiBuilderProps.property.logRemovalPolicy">logRemovalPolicy</a></code> | <code>aws-cdk-lib.RemovalPolicy</code> | Removal policy for logs of image builds. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.AmiBuilderProps.property.logRetention">logRetention</a></code> | <code>aws-cdk-lib.aws_logs.RetentionDays</code> | The number of days log events are kept in CloudWatch Logs. |
@@ -2405,6 +2406,21 @@ Image architecture.
 
 ---
 
+##### `installDocker`<sup>Optional</sup> <a name="installDocker" id="@cloudsnorkel/cdk-github-runners.AmiBuilderProps.property.installDocker"></a>
+
+```typescript
+public readonly installDocker: boolean;
+```
+
+- *Type:* boolean
+- *Default:* true
+
+Install Docker inside the image, so it can be used by the runner.
+
+You may want to disable this if you are building a Windows image and don't have a Docker Desktop license.
+
+---
+
 ##### `instanceType`<sup>Optional</sup> <a name="instanceType" id="@cloudsnorkel/cdk-github-runners.AmiBuilderProps.property.instanceType"></a>
 
 ```typescript
@@ -5691,7 +5707,7 @@ Log group name for the image builder where history of image builds can be analyz
 
 ### IRunnerProvider <a name="IRunnerProvider" id="@cloudsnorkel/cdk-github-runners.IRunnerProvider"></a>
 
-- *Extends:* aws-cdk-lib.aws_ec2.IConnectable, aws-cdk-lib.aws_iam.IGrantable
+- *Extends:* aws-cdk-lib.aws_ec2.IConnectable, aws-cdk-lib.aws_iam.IGrantable, constructs.IConstruct
 
 - *Implemented By:* <a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunner">CodeBuildRunner</a>, <a href="#@cloudsnorkel/cdk-github-runners.Ec2Runner">Ec2Runner</a>, <a href="#@cloudsnorkel/cdk-github-runners.FargateRunner">FargateRunner</a>, <a href="#@cloudsnorkel/cdk-github-runners.LambdaRunner">LambdaRunner</a>, <a href="#@cloudsnorkel/cdk-github-runners.IRunnerProvider">IRunnerProvider</a>
 
@@ -5770,6 +5786,7 @@ grantable for the status function.
 | --- | --- | --- |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProvider.property.connections">connections</a></code> | <code>aws-cdk-lib.aws_ec2.Connections</code> | The network connections associated with this resource. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProvider.property.grantPrincipal">grantPrincipal</a></code> | <code>aws-cdk-lib.aws_iam.IPrincipal</code> | The principal to grant permissions to. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProvider.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProvider.property.labels">labels</a></code> | <code>string[]</code> | GitHub Actions labels used for this provider. |
 
 ---
@@ -5798,6 +5815,18 @@ The principal to grant permissions to.
 
 ---
 
+##### `node`<sup>Required</sup> <a name="node" id="@cloudsnorkel/cdk-github-runners.IRunnerProvider.property.node"></a>
+
+```typescript
+public readonly node: Node;
+```
+
+- *Type:* constructs.Node
+
+The tree node.
+
+---
+
 ##### `labels`<sup>Required</sup> <a name="labels" id="@cloudsnorkel/cdk-github-runners.IRunnerProvider.property.labels"></a>
 
 ```typescript

package/lib/lambdas/aws-image-builder-versioner/index.js

@@ -21,6 +21,10 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));
@@ -31,7 +35,8 @@ var require_constants = __commonJS({
   "node_modules/semver/internal/constants.js"(exports, module2) {
     var SEMVER_SPEC_VERSION = "2.0.0";
     var MAX_LENGTH = 256;
-    var MAX_SAFE_INTEGER = Number.MAX_SAFE_INTEGER || 9007199254740991;
+    var MAX_SAFE_INTEGER = Number.MAX_SAFE_INTEGER || /* istanbul ignore next */
+    9007199254740991;
     var MAX_SAFE_COMPONENT_LENGTH = 16;
     module2.exports = {
       SEMVER_SPEC_VERSION,
@@ -289,6 +294,8 @@ var require_semver = __commonJS({
           }
         } while (++i);
       }
+      // preminor will bump the version up to the next minor release, and immediately
+      // down to pre-release. premajor and prepatch work the same way.
       inc(release, identifier) {
         switch (release) {
           case "premajor":
@@ -1137,6 +1144,7 @@ var require_lru_cache = __commonJS({
         this[UPDATE_AGE_ON_GET] = options.updateAgeOnGet || false;
         this.reset();
       }
+      // resize the cache when the max changes.
       set max(mL) {
         if (typeof mL !== "number" || mL < 0)
           throw new TypeError("max must be a non-negative number");
@@ -1161,6 +1169,7 @@ var require_lru_cache = __commonJS({
       get maxAge() {
         return this[MAX_AGE];
       }
+      // resize the cache when the lengthCalculator changes.
       set lengthCalculator(lC) {
         if (typeof lC !== "function")
           lC = naiveLength;
@@ -1475,6 +1484,7 @@ var require_range = __commonJS({
           });
         });
       }
+      // if ANY of the sets match ALL of its comparators, then pass
       test(version) {
         if (!version) {
           return false;

package/lib/lambdas/build-image/index.js

@@ -18,6 +18,10 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));

package/lib/lambdas/delete-ami/index.js

@@ -14,6 +14,10 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));