@cloudsnorkel/cdk-github-runners 0.5.1 → 0.5.3

package/API.md

@@ -963,7 +963,7 @@ Any object.
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunner.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
-| <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunner.property.assignPublicIp">assignPublicIp</a></code> | <code>boolean</code> | Whether task will have a public IP. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunner.property.assignPublicIp">assignPublicIp</a></code> | <code>boolean</code> | Whether runner task will have a public IP. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunner.property.cluster">cluster</a></code> | <code>aws-cdk-lib.aws_ecs.Cluster</code> | Cluster hosting the task hosting the runner. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunner.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.FargateRunner.property.container">container</a></code> | <code>aws-cdk-lib.aws_ecs.ContainerDefinition</code> | Container definition hosting the runner. |
@@ -973,7 +973,8 @@ Any object.
 | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunner.property.spot">spot</a></code> | <code>boolean</code> | Use spot pricing for Fargate tasks. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunner.property.task">task</a></code> | <code>aws-cdk-lib.aws_ecs.FargateTaskDefinition</code> | Fargate task hosting the runner. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunner.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | Security group attached to the task. |
-| <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunner.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | VPC used for hosting the task. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunner.property.subnetSelection">subnetSelection</a></code> | <code>aws-cdk-lib.aws_ec2.SubnetSelection</code> | Subnets used for hosting the runner task. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunner.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | VPC used for hosting the runner task. |
 
 ---
 
@@ -997,7 +998,7 @@ public readonly assignPublicIp: boolean;
 
 - *Type:* boolean
 
-Whether task will have a public IP.
+Whether runner task will have a public IP.
 
 ---
 
@@ -1109,6 +1110,18 @@ Security group attached to the task.
 
 ---
 
+##### `subnetSelection`<sup>Optional</sup> <a name="subnetSelection" id="@cloudsnorkel/cdk-github-runners.FargateRunner.property.subnetSelection"></a>
+
+```typescript
+public readonly subnetSelection: SubnetSelection;
+```
+
+- *Type:* aws-cdk-lib.aws_ec2.SubnetSelection
+
+Subnets used for hosting the runner task.
+
+---
+
 ##### `vpc`<sup>Optional</sup> <a name="vpc" id="@cloudsnorkel/cdk-github-runners.FargateRunner.property.vpc"></a>
 
 ```typescript
@@ -1117,7 +1130,7 @@ public readonly vpc: IVpc;
 
 - *Type:* aws-cdk-lib.aws_ec2.IVpc
 
-VPC used for hosting the task.
+VPC used for hosting the runner task.
 
 ---
 
@@ -2523,6 +2536,7 @@ const fargateRunnerProps: FargateRunnerProps = { ... }
 | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.memoryLimitMiB">memoryLimitMiB</a></code> | <code>number</code> | The amount (in MiB) of memory used by the task. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | Security Group to assign to the task. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.spot">spot</a></code> | <code>boolean</code> | Use Fargate spot capacity provider to save money. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.subnetSelection">subnetSelection</a></code> | <code>aws-cdk-lib.aws_ec2.SubnetSelection</code> | Subnets to run the runners in. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | VPC to launch the runners in. |
 
 ---
@@ -2629,16 +2643,6 @@ Provider running an image to run inside CodeBuild with GitHub runner pre-configu
 
 A user named `runner` is expected to exist.
 
-The entry point should start GitHub runner. For example:
-
-```
-#!/bin/bash
-set -e -u -o pipefail
-
-/home/runner/config.sh --unattended --url "https://${GITHUB_DOMAIN}/${OWNER}/${REPO}" --token "${RUNNER_TOKEN}" --ephemeral --work _work --labels "${RUNNER_LABEL}" --disableupdate --name "${RUNNER_NAME}"
-/home/runner/run.sh
-```
-
 ---
 
 ##### `label`<sup>Optional</sup> <a name="label" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.label"></a>
@@ -2709,6 +2713,19 @@ Use Fargate spot capacity provider to save money.
 
 ---
 
+##### `subnetSelection`<sup>Optional</sup> <a name="subnetSelection" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.subnetSelection"></a>
+
+```typescript
+public readonly subnetSelection: SubnetSelection;
+```
+
+- *Type:* aws-cdk-lib.aws_ec2.SubnetSelection
+- *Default:* Fargate default
+
+Subnets to run the runners in.
+
+---
+
 ##### `vpc`<sup>Optional</sup> <a name="vpc" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.vpc"></a>
 
 ```typescript

package/README.md

@@ -100,9 +100,9 @@ let bucket: s3.Bucket;
 
 // create a custom CodeBuild provider
 const myProvider = new CodeBuildRunner(this, 'codebuild runner', { 
-    label: 'my-codebuild',
-    vpc: vpc,
-    securityGroup: runnerSg,
+  label: 'my-codebuild',
+  vpc: vpc,
+  securityGroup: runnerSg,
 });
 // grant some permissions to the provider
 bucket.grantReadWrite(myProvider);
@@ -110,7 +110,7 @@ dbSg.connections.allowFrom(runnerSg, ec2.Port.tcp(3306), 'allow runners to conne
 
 // create the runner infrastructure
 new GitHubRunners(this, 'runners', {
-    providers: [myProvider],
+   providers: [myProvider],
 });
 ```
 
@@ -118,21 +118,22 @@ Another way to customize runners is by modifying the image used to spin them up.
 
 ```typescript
 const myBuilder = new CodeBuildImageBuilder(this, 'image builder', {
-   dockerfilePath: FargateProvider.LINUX_X64_DOCKERFILE_PATH,
-   runnerVersion: RunnerVersion.specific('2.291.0'),
-   rebuildInterval: Duration.days(14),    
+  dockerfilePath: FargateRunner.LINUX_X64_DOCKERFILE_PATH,
+  runnerVersion: RunnerVersion.specific('2.291.0'),
+  rebuildInterval: Duration.days(14),    
 });
 myBuilder.setBuildArg('EXTRA_PACKAGES', 'nginx xz-utils');
 
-const myProvider = new FargateProvider(this, 'fargate runner', {
-   label: 'customized-fargate',
-   vpc: vpc,
-   securityGroup: runnerSg,
+const myProvider = new FargateRunner(this, 'fargate runner', {
+  label: 'customized-fargate',
+  vpc: vpc,
+  securityGroup: runnerSg,
+  imageBuilder: myBuilder,
 });
 
 // create the runner infrastructure
 new GitHubRunners(stack, 'runners', {
-   providers: [myProvider],
+  providers: [myProvider],
 });
 ```
 
@@ -148,6 +149,41 @@ jobs:
       - run: echo hello world
 ```
 
+Windows images must be built with AWS Image Builder.
+
+```typescript
+const myWindowsBuilder = new ContainerImageBuilder(this, 'Windows image builder', {
+  architecture: Architecture.X86_64,
+  os: Os.WINDOWS,
+  runnerVersion: RunnerVersion.specific('2.291.0'),
+  rebuildInterval: Duration.days(14),    
+});
+myWindowsBuilder.addComponent(new ImageBuilderComponent(this, 'Ninja Component',
+  {
+    displayName: 'Ninja',
+    description: 'Download and install Ninja build system',
+    platform: 'Windows',
+    commands: [
+      'Invoke-WebRequest -UseBasicParsing -Uri "https://github.com/ninja-build/ninja/releases/download/v1.11.1/ninja-win.zip" -OutFile ninja.zip',
+      'Expand-Archive ninja.zip -DestinationPath C:\\actions',
+      'del ninja.zip',
+    ],
+  }
+));
+
+const myProvider = new FargateRunner(this, 'fargate runner', {
+  label: 'customized-windows-fargate',
+  vpc: vpc,
+  securityGroup: runnerSg,
+  imageBuiler: myWindowsBuilder,
+});
+
+// create the runner infrastructure
+new GitHubRunners(stack, 'runners', {
+  providers: [myProvider],
+});
+```
+
 ## Architecture
 
 ![Architecture diagram](architecture.svg)

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

@@ -2293,51 +2293,91 @@ var require_subset = __commonJS({
 var require_semver2 = __commonJS({
   "node_modules/semver/index.js"(exports, module2) {
     var internalRe = require_re();
+    var constants = require_constants();
+    var SemVer = require_semver();
+    var identifiers = require_identifiers();
+    var parse = require_parse();
+    var valid = require_valid();
+    var clean = require_clean();
+    var inc2 = require_inc();
+    var diff = require_diff();
+    var major = require_major();
+    var minor = require_minor();
+    var patch = require_patch();
+    var prerelease = require_prerelease();
+    var compare = require_compare();
+    var rcompare = require_rcompare();
+    var compareLoose = require_compare_loose();
+    var compareBuild = require_compare_build();
+    var sort = require_sort();
+    var rsort = require_rsort();
+    var gt = require_gt();
+    var lt = require_lt();
+    var eq = require_eq();
+    var neq = require_neq();
+    var gte = require_gte();
+    var lte = require_lte();
+    var cmp = require_cmp();
+    var coerce = require_coerce();
+    var Comparator = require_comparator();
+    var Range = require_range();
+    var satisfies = require_satisfies();
+    var toComparators = require_to_comparators();
+    var maxSatisfying2 = require_max_satisfying();
+    var minSatisfying = require_min_satisfying();
+    var minVersion = require_min_version();
+    var validRange = require_valid2();
+    var outside = require_outside();
+    var gtr = require_gtr();
+    var ltr = require_ltr();
+    var intersects = require_intersects();
+    var simplifyRange = require_simplify();
+    var subset = require_subset();
     module2.exports = {
+      parse,
+      valid,
+      clean,
+      inc: inc2,
+      diff,
+      major,
+      minor,
+      patch,
+      prerelease,
+      compare,
+      rcompare,
+      compareLoose,
+      compareBuild,
+      sort,
+      rsort,
+      gt,
+      lt,
+      eq,
+      neq,
+      gte,
+      lte,
+      cmp,
+      coerce,
+      Comparator,
+      Range,
+      satisfies,
+      toComparators,
+      maxSatisfying: maxSatisfying2,
+      minSatisfying,
+      minVersion,
+      validRange,
+      outside,
+      gtr,
+      ltr,
+      intersects,
+      simplifyRange,
+      subset,
+      SemVer,
       re: internalRe.re,
       src: internalRe.src,
       tokens: internalRe.t,
-      SEMVER_SPEC_VERSION: require_constants().SEMVER_SPEC_VERSION,
-      SemVer: require_semver(),
-      compareIdentifiers: require_identifiers().compareIdentifiers,
-      rcompareIdentifiers: require_identifiers().rcompareIdentifiers,
-      parse: require_parse(),
-      valid: require_valid(),
-      clean: require_clean(),
-      inc: require_inc(),
-      diff: require_diff(),
-      major: require_major(),
-      minor: require_minor(),
-      patch: require_patch(),
-      prerelease: require_prerelease(),
-      compare: require_compare(),
-      rcompare: require_rcompare(),
-      compareLoose: require_compare_loose(),
-      compareBuild: require_compare_build(),
-      sort: require_sort(),
-      rsort: require_rsort(),
-      gt: require_gt(),
-      lt: require_lt(),
-      eq: require_eq(),
-      neq: require_neq(),
-      gte: require_gte(),
-      lte: require_lte(),
-      cmp: require_cmp(),
-      coerce: require_coerce(),
-      Comparator: require_comparator(),
-      Range: require_range(),
-      satisfies: require_satisfies(),
-      toComparators: require_to_comparators(),
-      maxSatisfying: require_max_satisfying(),
-      minSatisfying: require_min_satisfying(),
-      minVersion: require_min_version(),
-      validRange: require_valid2(),
-      outside: require_outside(),
-      gtr: require_gtr(),
-      ltr: require_ltr(),
-      intersects: require_intersects(),
-      simplifyRange: require_simplify(),
-      subset: require_subset()
+      SEMVER_SPEC_VERSION: constants.SEMVER_SPEC_VERSION,
+      compareIdentifiers: identifiers.compareIdentifiers,
+      rcompareIdentifiers: identifiers.rcompareIdentifiers
     };
   }
 });

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

@@ -7432,7 +7432,7 @@ var require_dist_node6 = __commonJS({
         parse
       });
     }
-    var VERSION = "7.0.2";
+    var VERSION = "7.0.3";
     var userAgent = `octokit-endpoint.js/${VERSION} ${universalUserAgent.getUserAgent()}`;
     var DEFAULTS = {
       method: "GET",
@@ -7518,7 +7518,7 @@ var require_dist_node8 = __commonJS({
     var isPlainObject = require_is_plain_object();
     var nodeFetch = _interopDefault(require_lib3());
     var requestError = require_dist_node7();
-    var VERSION = "6.2.1";
+    var VERSION = "6.2.2";
     function getBufferResponse(response) {
       return response.arrayBuffer();
     }
@@ -7988,7 +7988,7 @@ var require_dist_node10 = __commonJS({
         parse
       });
     }
-    var VERSION = "7.0.2";
+    var VERSION = "7.0.3";
     var userAgent = `octokit-endpoint.js/${VERSION} ${universalUserAgent.getUserAgent()}`;
     var DEFAULTS = {
       method: "GET",
@@ -8074,7 +8074,7 @@ var require_dist_node12 = __commonJS({
     var isPlainObject = require_is_plain_object();
     var nodeFetch = _interopDefault(require_lib3());
     var requestError = require_dist_node11();
-    var VERSION = "6.2.1";
+    var VERSION = "6.2.2";
     function getBufferResponse(response) {
       return response.arrayBuffer();
     }
@@ -8228,7 +8228,7 @@ var require_dist_node13 = __commonJS({
     var request = require_dist_node12();
     var requestError = require_dist_node11();
     var btoa = _interopDefault(require_btoa_node());
-    var VERSION = "2.0.3";
+    var VERSION = "2.0.4";
     function requestToOAuthBaseUrl(request2) {
       const endpointDefaults = request2.endpoint.DEFAULTS;
       return /^https:\/\/(api\.)?github\.com$/.test(endpointDefaults.baseUrl) ? "https://github.com" : endpointDefaults.baseUrl.replace("/api/v3", "");
@@ -8395,17 +8395,14 @@ var require_dist_node13 = __commonJS({
         ...requestOptions
       } = options;
       const request$1 = optionsRequest || request.request;
-      const response = await request$1(
-        "POST /applications/{client_id}/token/scoped",
-        {
-          headers: {
-            authorization: `basic ${btoa(`${clientId}:${clientSecret}`)}`
-          },
-          client_id: clientId,
-          access_token: token,
-          ...requestOptions
-        }
-      );
+      const response = await request$1("POST /applications/{client_id}/token/scoped", {
+        headers: {
+          authorization: `basic ${btoa(`${clientId}:${clientSecret}`)}`
+        },
+        client_id: clientId,
+        access_token: token,
+        ...requestOptions
+      });
       const authentication = Object.assign({
         clientType,
         clientId,
@@ -8422,16 +8419,13 @@ var require_dist_node13 = __commonJS({
     async function resetToken(options) {
       const request$1 = options.request || request.request;
       const auth = btoa(`${options.clientId}:${options.clientSecret}`);
-      const response = await request$1(
-        "PATCH /applications/{client_id}/token",
-        {
-          headers: {
-            authorization: `basic ${auth}`
-          },
-          client_id: options.clientId,
-          access_token: options.token
-        }
-      );
+      const response = await request$1("PATCH /applications/{client_id}/token", {
+        headers: {
+          authorization: `basic ${auth}`
+        },
+        client_id: options.clientId,
+        access_token: options.token
+      });
       const authentication = {
         clientType: options.clientType,
         clientId: options.clientId,
@@ -8452,30 +8446,24 @@ var require_dist_node13 = __commonJS({
     async function deleteToken(options) {
       const request$1 = options.request || request.request;
       const auth = btoa(`${options.clientId}:${options.clientSecret}`);
-      return request$1(
-        "DELETE /applications/{client_id}/token",
-        {
-          headers: {
-            authorization: `basic ${auth}`
-          },
-          client_id: options.clientId,
-          access_token: options.token
-        }
-      );
+      return request$1("DELETE /applications/{client_id}/token", {
+        headers: {
+          authorization: `basic ${auth}`
+        },
+        client_id: options.clientId,
+        access_token: options.token
+      });
     }
     async function deleteAuthorization(options) {
       const request$1 = options.request || request.request;
       const auth = btoa(`${options.clientId}:${options.clientSecret}`);
-      return request$1(
-        "DELETE /applications/{client_id}/grant",
-        {
-          headers: {
-            authorization: `basic ${auth}`
-          },
-          client_id: options.clientId,
-          access_token: options.token
-        }
-      );
+      return request$1("DELETE /applications/{client_id}/grant", {
+        headers: {
+          authorization: `basic ${auth}`
+        },
+        client_id: options.clientId,
+        access_token: options.token
+      });
     }
     exports2.VERSION = VERSION;
     exports2.checkToken = checkToken;
@@ -8589,7 +8577,7 @@ var require_dist_node14 = __commonJS({
       endpoint.headers.authorization = `token ${token}`;
       return request2(endpoint);
     }
-    var VERSION = "4.0.2";
+    var VERSION = "4.0.3";
     function createOAuthDeviceAuth(options) {
       const requestWithDefaults = options.request || request.request.defaults({
         headers: {
@@ -8637,7 +8625,7 @@ var require_dist_node15 = __commonJS({
     var authOauthDevice = require_dist_node14();
     var oauthMethods = require_dist_node13();
     var btoa = _interopDefault(require_btoa_node());
-    var VERSION = "2.0.3";
+    var VERSION = "2.0.4";
     async function getAuthentication(state) {
       if ("code" in state.strategyOptions) {
         const {
@@ -12765,7 +12753,7 @@ var require_dist_node18 = __commonJS({
         parse
       });
     }
-    var VERSION = "7.0.2";
+    var VERSION = "7.0.3";
     var userAgent = `octokit-endpoint.js/${VERSION} ${universalUserAgent.getUserAgent()}`;
     var DEFAULTS = {
       method: "GET",
@@ -12851,7 +12839,7 @@ var require_dist_node20 = __commonJS({
     var isPlainObject = require_is_plain_object();
     var nodeFetch = _interopDefault(require_lib3());
     var requestError = require_dist_node19();
-    var VERSION = "6.2.1";
+    var VERSION = "6.2.2";
     function getBufferResponse(response) {
       return response.arrayBuffer();
     }
@@ -14372,7 +14360,10 @@ var require_before_after_hook = __commonJS({
     var bind = Function.bind;
     var bindable = bind.bind(bind);
     function bindApi(hook, state, name) {
-      var removeHookRef = bindable(removeHook, null).apply(null, name ? [state, name] : [state]);
+      var removeHookRef = bindable(removeHook, null).apply(
+        null,
+        name ? [state, name] : [state]
+      );
       hook.api = { remove: removeHookRef };
       hook.remove = removeHookRef;
       ["before", "error", "after", "wrap"].forEach(function(kind) {
@@ -14400,7 +14391,9 @@ var require_before_after_hook = __commonJS({
     var collectionHookDeprecationMessageDisplayed = false;
     function Hook() {
       if (!collectionHookDeprecationMessageDisplayed) {
-        console.warn('[before-after-hook]: "Hook()" repurposing warning, use "Hook.Collection()". Read more: https://git.io/upgrade-before-after-hook-to-1.4');
+        console.warn(
+          '[before-after-hook]: "Hook()" repurposing warning, use "Hook.Collection()". Read more: https://git.io/upgrade-before-after-hook-to-1.4'
+        );
         collectionHookDeprecationMessageDisplayed = true;
       }
       return HookCollection();