@cloudsnorkel/cdk-github-runners 0.13.0 → 0.13.2

package/.jsii

@@ -4654,7 +4654,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/image-builders/aws-image-builder/builder.ts",
-        "line": 32
+        "line": 33
       },
       "name": "AwsImageBuilderRunnerImageBuilderProps",
       "properties": [
@@ -4669,7 +4669,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 47
+            "line": 48
           },
           "name": "fastLaunchOptions",
           "optional": true,
@@ -4687,7 +4687,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 38
+            "line": 39
           },
           "name": "instanceType",
           "optional": true,
@@ -5238,7 +5238,7 @@
         },
         "locationInModule": {
           "filename": "src/providers/codebuild.ts",
-          "line": 226
+          "line": 227
         },
         "parameters": [
           {
@@ -5265,7 +5265,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/providers/codebuild.ts",
-        "line": 432
+        "line": 445
       },
       "name": "CodeBuildRunner",
       "symbolId": "src/providers/codebuild:CodeBuildRunner"
@@ -5359,7 +5359,7 @@
         },
         "locationInModule": {
           "filename": "src/providers/codebuild.ts",
-          "line": 226
+          "line": 227
         },
         "parameters": [
           {
@@ -5389,7 +5389,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/providers/codebuild.ts",
-        "line": 124
+        "line": 125
       },
       "methods": [
         {
@@ -5400,7 +5400,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 173
+            "line": 174
           },
           "name": "imageBuilder",
           "parameters": [
@@ -5439,7 +5439,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 359
+            "line": 372
           },
           "name": "getStepFunctionTask",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -5468,7 +5468,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 400
+            "line": 413
           },
           "name": "grantStateMachine",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -5537,7 +5537,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 403
+            "line": 416
           },
           "name": "status",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -5569,7 +5569,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 153
+            "line": 154
           },
           "name": "LINUX_ARM64_DOCKERFILE_PATH",
           "static": true,
@@ -5588,7 +5588,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 138
+            "line": 139
           },
           "name": "LINUX_X64_DOCKERFILE_PATH",
           "static": true,
@@ -5604,7 +5604,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 424
+            "line": 437
           },
           "name": "connections",
           "overrides": "aws-cdk-lib.aws_ec2.IConnectable",
@@ -5620,7 +5620,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 203
+            "line": 204
           },
           "name": "grantPrincipal",
           "overrides": "aws-cdk-lib.aws_iam.IGrantable",
@@ -5637,7 +5637,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 208
+            "line": 209
           },
           "name": "image",
           "type": {
@@ -5652,7 +5652,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 198
+            "line": 199
           },
           "name": "labels",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -5674,7 +5674,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 215
+            "line": 216
           },
           "name": "logGroup",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -5690,7 +5690,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 193
+            "line": 194
           },
           "name": "project",
           "type": {
@@ -5705,7 +5705,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 217
+            "line": 218
           },
           "name": "retryableErrors",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -5734,7 +5734,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/providers/codebuild.ts",
-        "line": 30
+        "line": 31
       },
       "name": "CodeBuildRunnerProviderProps",
       "properties": [
@@ -5749,7 +5749,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 97
+            "line": 98
           },
           "name": "computeType",
           "optional": true,
@@ -5768,7 +5768,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 114
+            "line": 115
           },
           "name": "dockerInDocker",
           "optional": true,
@@ -5787,7 +5787,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 40
+            "line": 41
           },
           "name": "imageBuilder",
           "optional": true,
@@ -5806,7 +5806,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 48
+            "line": 49
           },
           "name": "label",
           "optional": true,
@@ -5825,7 +5825,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 59
+            "line": 60
           },
           "name": "labels",
           "optional": true,
@@ -5849,7 +5849,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 75
+            "line": 76
           },
           "name": "securityGroup",
           "optional": true,
@@ -5867,7 +5867,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 82
+            "line": 83
           },
           "name": "securityGroups",
           "optional": true,
@@ -5890,7 +5890,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 89
+            "line": 90
           },
           "name": "subnetSelection",
           "optional": true,
@@ -5909,7 +5909,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 106
+            "line": 107
           },
           "name": "timeout",
           "optional": true,
@@ -5927,7 +5927,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 66
+            "line": 67
           },
           "name": "vpc",
           "optional": true,
@@ -8689,7 +8689,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/image-builders/aws-image-builder/builder.ts",
-        "line": 53
+        "line": 54
       },
       "name": "FastLaunchOptions",
       "properties": [
@@ -8707,7 +8707,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 64
+            "line": 65
           },
           "name": "enabled",
           "optional": true,
@@ -8726,7 +8726,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 73
+            "line": 74
           },
           "name": "maxParallelLaunches",
           "optional": true,
@@ -8744,7 +8744,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 80
+            "line": 81
           },
           "name": "targetResourceCount",
           "optional": true,
@@ -9314,7 +9314,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/image-builders/common.ts",
-        "line": 297
+        "line": 308
       },
       "methods": [
         {
@@ -9326,7 +9326,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 303
+            "line": 314
           },
           "name": "addComponent",
           "parameters": [
@@ -9350,7 +9350,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 310
+            "line": 321
           },
           "name": "removeComponent",
           "parameters": [
@@ -9430,7 +9430,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/image-builders/common.ts",
-        "line": 270
+        "line": 281
       },
       "methods": [
         {
@@ -9442,7 +9442,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 289
+            "line": 300
           },
           "name": "bindAmi",
           "returns": {
@@ -9460,7 +9460,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 280
+            "line": 291
           },
           "name": "bindDockerImage",
           "returns": {
@@ -9879,7 +9879,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/image-builders/aws-image-builder/builder.ts",
-        "line": 86
+        "line": 87
       },
       "name": "ImageBuilderAsset",
       "properties": [
@@ -9892,7 +9892,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 95
+            "line": 96
           },
           "name": "asset",
           "type": {
@@ -9908,7 +9908,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 90
+            "line": 91
           },
           "name": "path",
           "type": {
@@ -9934,7 +9934,7 @@
         },
         "locationInModule": {
           "filename": "src/image-builders/aws-image-builder/builder.ts",
-          "line": 169
+          "line": 170
         },
         "parameters": [
           {
@@ -9960,7 +9960,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/image-builders/aws-image-builder/builder.ts",
-        "line": 156
+        "line": 157
       },
       "methods": [
         {
@@ -10006,7 +10006,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 271
+            "line": 272
           },
           "name": "grantAssetsRead",
           "parameters": [
@@ -10024,7 +10024,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 277
+            "line": 278
           },
           "name": "prefixCommandsWithErrorHandling",
           "parameters": [
@@ -10068,7 +10068,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 160
+            "line": 161
           },
           "name": "arn",
           "type": {
@@ -10083,7 +10083,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 165
+            "line": 166
           },
           "name": "platform",
           "type": {
@@ -10104,7 +10104,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/image-builders/aws-image-builder/builder.ts",
-        "line": 101
+        "line": 102
       },
       "name": "ImageBuilderComponentProperties",
       "properties": [
@@ -10118,7 +10118,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 122
+            "line": 123
           },
           "name": "commands",
           "type": {
@@ -10139,7 +10139,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 115
+            "line": 116
           },
           "name": "description",
           "type": {
@@ -10155,7 +10155,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 110
+            "line": 111
           },
           "name": "displayName",
           "type": {
@@ -10172,7 +10172,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 105
+            "line": 106
           },
           "name": "platform",
           "type": {
@@ -10188,7 +10188,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 127
+            "line": 128
           },
           "name": "assets",
           "optional": true,
@@ -10211,7 +10211,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 134
+            "line": 135
           },
           "name": "reboot",
           "optional": true,
@@ -11971,7 +11971,7 @@
         },
         "locationInModule": {
           "filename": "src/image-builders/common.ts",
-          "line": 319
+          "line": 330
         },
         "parameters": [
           {
@@ -12052,7 +12052,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 334
+            "line": 345
           },
           "name": "addComponent",
           "overrides": "@cloudsnorkel/cdk-github-runners.IConfigurableRunnerImageBuilder",
@@ -12074,7 +12074,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 329
+            "line": 340
           },
           "name": "bindAmi",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerImageBuilder",
@@ -12093,7 +12093,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 327
+            "line": 338
           },
           "name": "bindDockerImage",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerImageBuilder",
@@ -12111,7 +12111,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 338
+            "line": 349
           },
           "name": "removeComponent",
           "overrides": "@cloudsnorkel/cdk-github-runners.IConfigurableRunnerImageBuilder",
@@ -12136,7 +12136,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 331
+            "line": 342
           },
           "name": "connections",
           "overrides": "aws-cdk-lib.aws_ec2.IConnectable",
@@ -12153,7 +12153,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 332
+            "line": 343
           },
           "name": "grantPrincipal",
           "overrides": "aws-cdk-lib.aws_iam.IGrantable",
@@ -12167,7 +12167,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 317
+            "line": 328
           },
           "name": "components",
           "protected": true,
@@ -12225,7 +12225,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 235
+            "line": 246
           },
           "name": "awsImageBuilderOptions",
           "optional": true,
@@ -12244,7 +12244,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 160
+            "line": 171
           },
           "name": "baseAmi",
           "optional": true,
@@ -12256,13 +12256,14 @@
           "abstract": true,
           "docs": {
             "default": "public.ecr.aws/lts/ubuntu:22.04 for Os.LINUX_UBUNTU, public.ecr.aws/amazonlinux/amazonlinux:2 for Os.LINUX_AMAZON_2, mcr.microsoft.com/windows/servercore:ltsc2019-amd64 for Os.WINDOWS",
+            "remarks": "When using private images from a different account or not on ECR, you may need to include additional setup commands with {@link dockerSetupCommands}.",
             "stability": "experimental",
             "summary": "Base image from which Docker runner images will be built."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 151
+            "line": 153
           },
           "name": "baseDockerImage",
           "optional": true,
@@ -12279,7 +12280,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 225
+            "line": 236
           },
           "name": "builderType",
           "optional": true,
@@ -12297,7 +12298,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 230
+            "line": 241
           },
           "name": "codeBuildOptions",
           "optional": true,
@@ -12315,7 +12316,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 174
+            "line": 185
           },
           "name": "components",
           "optional": true,
@@ -12328,6 +12329,30 @@
             }
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "[]",
+            "remarks": "Use this to execute commands such as `docker login` or `aws ecr get-login-password` to pull private base images.",
+            "stability": "experimental",
+            "summary": "Additional commands to run on the build host before starting the Docker runner image build."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/image-builders/common.ts",
+            "line": 162
+          },
+          "name": "dockerSetupCommands",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -12339,7 +12364,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 220
+            "line": 231
           },
           "name": "logRemovalPolicy",
           "optional": true,
@@ -12358,7 +12383,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 211
+            "line": 222
           },
           "name": "logRetention",
           "optional": true,
@@ -12395,7 +12420,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 183
+            "line": 194
           },
           "name": "rebuildInterval",
           "optional": true,
@@ -12413,7 +12438,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 167
+            "line": 178
           },
           "name": "runnerVersion",
           "optional": true,
@@ -12430,7 +12455,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 195
+            "line": 206
           },
           "name": "securityGroups",
           "optional": true,
@@ -12453,7 +12478,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 202
+            "line": 213
           },
           "name": "subnetSelection",
           "optional": true,
@@ -12471,7 +12496,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 190
+            "line": 201
           },
           "name": "vpc",
           "optional": true,
@@ -12490,7 +12515,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/common.ts",
-            "line": 246
+            "line": 257
           },
           "name": "waitOnDeploy",
           "optional": true,
@@ -12510,7 +12535,7 @@
       "kind": "enum",
       "locationInModule": {
         "filename": "src/image-builders/common.ts",
-        "line": 249
+        "line": 260
       },
       "members": [
         {
@@ -12632,6 +12657,37 @@
           },
           "static": true
         },
+        {
+          "docs": {
+            "remarks": "These variables only affect the jobs ran by the runner. They are not global. They do not affect other components.\n\nIt is not recommended to use this component to pass secrets. Instead, use GitHub Secrets or AWS Secrets Manager.\n\nMust be used after the {@link githubRunner} component.",
+            "stability": "experimental",
+            "summary": "A component to add environment variables for jobs the runner executes."
+          },
+          "locationInModule": {
+            "filename": "src/image-builders/components.ts",
+            "line": 534
+          },
+          "name": "environmentVariables",
+          "parameters": [
+            {
+              "name": "vars",
+              "type": {
+                "collection": {
+                  "elementtype": {
+                    "primitive": "string"
+                  },
+                  "kind": "map"
+                }
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "@cloudsnorkel/cdk-github-runners.RunnerImageComponent"
+            }
+          },
+          "static": true
+        },
         {
           "docs": {
             "remarks": "This can be used to support GitHub Enterprise Server with self-signed certificate.",
@@ -12793,7 +12849,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/components.ts",
-            "line": 540
+            "line": 571
           },
           "name": "getAssets",
           "parameters": [
@@ -12830,7 +12886,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/components.ts",
-            "line": 535
+            "line": 566
           },
           "name": "getCommands",
           "parameters": [
@@ -12866,7 +12922,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/components.ts",
-            "line": 549
+            "line": 580
           },
           "name": "getDockerCommands",
           "parameters": [
@@ -12901,7 +12957,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/components.ts",
-            "line": 556
+            "line": 587
           },
           "name": "shouldReboot",
           "parameters": [
@@ -12937,7 +12993,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/components.ts",
-            "line": 530
+            "line": 561
           },
           "name": "name",
           "type": {
@@ -13837,6 +13893,6 @@
       "symbolId": "src/image-builders/aws-image-builder/deprecated/windows-components:WindowsComponents"
     }
   },
-  "version": "0.13.0",
-  "fingerprint": "VRBRcBp2OD2TKWfakcAjPyJ399RqA/UkFgrRPMWl5pA="
+  "version": "0.13.2",
+  "fingerprint": "1/Zq8tZ1+hABDznhB1yEpPLno92ej2vXxhWUafINqi8="
 }