@cloudsnorkel/cdk-github-runners 0.9.5 → 0.9.7

package/API.md

@@ -29,8 +29,8 @@ builder.addComponent(new ImageBuilderComponent(scope, id, {
     'apt-get install p7zip',
   ],
 }));
-new Ec2Runner(this, 'EC2 provider', {
-    label: 'custom-ec2',
+new Ec2RunnerProvider(this, 'EC2 provider', {
+    labels: ['custom-ec2'],
     amiBuilder: builder,
 });
 ```
@@ -240,13 +240,13 @@ For example, to set a specific runner version, rebuild the image every 2 weeks,
 
 ```
 const builder = new CodeBuildImageBuilder(this, 'Builder', {
-    dockerfilePath: FargateProvider.LINUX_X64_DOCKERFILE_PATH,
+    dockerfilePath: FargateRunnerProvider.LINUX_X64_DOCKERFILE_PATH,
     runnerVersion: RunnerVersion.specific('2.293.0'),
     rebuildInterval: Duration.days(14),
 });
 builder.setBuildArg('EXTRA_PACKAGES', 'nginx xz-utils');
-new FargateRunner(this, 'Fargate provider', {
-    label: 'customized-fargate',
+new FargateRunnerProvider(this, 'Fargate provider', {
+    labels: ['customized-fargate'],
     imageBuilder: builder,
 });
 ```
@@ -1221,8 +1221,8 @@ const builder = new ContainerImageBuilder(this, 'Builder', {
     runnerVersion: RunnerVersion.specific('2.293.0'),
     rebuildInterval: Duration.days(14),
 });
-new CodeBuildRunner(this, 'CodeBuild provider', {
-    label: 'custom-codebuild',
+new CodeBuildRunnerProvider(this, 'CodeBuild provider', {
+    labels: ['custom-codebuild'],
     imageBuilder: builder,
 });
 ```
@@ -3039,12 +3039,12 @@ const dbSg = ec2.SecurityGroup.fromSecurityGroupId(this, 'database security grou
 const bucket = new s3.Bucket(this, 'runner bucket');
 
 // create a custom CodeBuild provider
-const myProvider = new CodeBuildRunner(
+const myProvider = new CodeBuildRunnerProvider(
   this, 'codebuild runner',
   {
-     label: 'my-codebuild',
+     labels: ['my-codebuild'],
      vpc: vpc,
-     securityGroup: runnerSg,
+     securityGroups: [runnerSg],
   },
 );
 // grant some permissions to the provider
@@ -5693,7 +5693,7 @@ public readonly imageBuilder: IRunnerImageBuilder;
 ```
 
 - *Type:* <a href="#@cloudsnorkel/cdk-github-runners.IRunnerImageBuilder">IRunnerImageBuilder</a>
-- *Default:* Ec2ProviderProps.imageBuilder()
+- *Default:* Ec2RunnerProvider.imageBuilder()
 
 Runner image builder used to build AMI containing GitHub Runner and all requirements.
 
@@ -5875,7 +5875,8 @@ const ecsRunnerProviderProps: EcsRunnerProviderProps = { ... }
 | <code><a href="#@cloudsnorkel/cdk-github-runners.EcsRunnerProviderProps.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.EcsRunnerProviderProps.property.minInstances">minInstances</a></code> | <code>number</code> | The minimum number of instances to run in the cluster. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.EcsRunnerProviderProps.property.securityGroups">securityGroups</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup[]</code> | Security groups to assign to the task. |
-| <code><a href="#@cloudsnorkel/cdk-github-runners.EcsRunnerProviderProps.property.spotMaxPrice">spotMaxPrice</a></code> | <code>string</code> | Use spot capacity and set a maximum price for spot instances. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.EcsRunnerProviderProps.property.spot">spot</a></code> | <code>boolean</code> | Use spot capacity. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.EcsRunnerProviderProps.property.spotMaxPrice">spotMaxPrice</a></code> | <code>string</code> | Maximum price for spot instances. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.EcsRunnerProviderProps.property.storageSize">storageSize</a></code> | <code>aws-cdk-lib.Size</code> | Size of volume available for launched cluster instances. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.EcsRunnerProviderProps.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.EcsRunnerProviderProps.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | VPC to launch the runners in. |
@@ -6087,6 +6088,19 @@ Security groups to assign to the task.
 
 ---
 
+##### `spot`<sup>Optional</sup> <a name="spot" id="@cloudsnorkel/cdk-github-runners.EcsRunnerProviderProps.property.spot"></a>
+
+```typescript
+public readonly spot: boolean;
+```
+
+- *Type:* boolean
+- *Default:* false (true if spotMaxPrice is specified)
+
+Use spot capacity.
+
+---
+
 ##### `spotMaxPrice`<sup>Optional</sup> <a name="spotMaxPrice" id="@cloudsnorkel/cdk-github-runners.EcsRunnerProviderProps.property.spotMaxPrice"></a>
 
 ```typescript
@@ -6094,9 +6108,8 @@ public readonly spotMaxPrice: string;
 ```
 
 - *Type:* string
-- *Default:* no spot capacity
 
-Use spot capacity and set a maximum price for spot instances.
+Maximum price for spot instances.
 
 ---
 
@@ -7545,7 +7558,7 @@ public readonly os: Os;
 ```
 
 - *Type:* <a href="#@cloudsnorkel/cdk-github-runners.Os">Os</a>
-- *Default:* OS.LINUX
+- *Default:* OS.LINUX_UBUNTU
 
 Image OS.
 

package/README.md

@@ -55,39 +55,96 @@ You can also create your own provider by implementing `IRunnerProvider`.
 
 ## Installation
 
-1. Confirm you're using CDK v2
-2. Install the appropriate package
-   1. [Python][6]
-      ```
-      pip install cloudsnorkel.cdk-github-runners
-      ```
-   2. [TypeScript or JavaScript][7]
-      ```
-      npm i @cloudsnorkel/cdk-github-runners
-      ```
-   3. [Java][8]
-      ```xml
-      <dependency>
+1. Install and use the appropriate package
+   <details><summary>Python</summary>
+
+   ### Install
+   Available on [PyPI][6].
+   ```bash
+   pip install cloudsnorkel.cdk-github-runners
+   ```
+   ### Use
+   ```python
+   from cloudsnorkel.cdk_github_runners import GitHubRunners
+   
+   GitHubRunners(self, "runners")
+   ```
+   </details>
+   <details><summary>TypeScript or JavaScript</summary>
+
+   ### Install
+   Available on [npm][7].
+   ```bash
+   npm i @cloudsnorkel/cdk-github-runners
+   ```
+   ### Use
+   ```typescript
+   import { GitHubRunners } from '@cloudsnorkel/cdk-github-runners';
+   
+   new GitHubRunners(this, "runners");
+   ```
+   </details>
+   <details><summary>Java</summary>
+
+   ### Install
+   Available on [Maven][8].
+   ```xml
+   <dependency>
       <groupId>com.cloudsnorkel</groupId>
       <artifactId>cdk.github.runners</artifactId>
-      </dependency>
-      ```
-   4. [Go][11]
-      ```
-      go get github.com/CloudSnorkel/cdk-github-runners-go/cloudsnorkelcdkgithubrunners
-      ```
-   5. [.NET][12]
-      ```
-      dotnet add package CloudSnorkel.Cdk.Github.Runners
-      ```
-3. Use `GitHubRunners` construct in your code (starting with default arguments is fine)
-4. Deploy your stack
-5. Look for the status command output similar to `aws --region us-east-1 lambda invoke --function-name status-XYZ123 status.json`
-6. Execute the status command (you may need to specify `--profile` too) and open the resulting `status.json` file
-7. Open the URL in `github.setup.url` from `status.json` or [manually setup GitHub](SETUP_GITHUB.md) integration as an app or with personal access token
-8. Run status command again to confirm `github.auth.status` and `github.webhook.status` are OK
-9. Trigger a GitHub action that has a `self-hosted` label with `runs-on: [self-hosted, linux, codebuild]` or similar
-10. If the action is not successful, see [troubleshooting](#Troubleshooting)
+   </dependency>
+   ```
+   ### Use
+   ```java
+   import com.cloudsnorkel.cdk.github.runners.GitHubRunners;
+   
+   GitHubRunners.Builder.create(this, "runners").build();
+   ```
+   </details>
+   <details><summary>Go</summary>
+
+   ### Install
+   Available on [GitHub][11].
+   ```bash
+   go get github.com/CloudSnorkel/cdk-github-runners-go/cloudsnorkelcdkgithubrunners
+   ```
+   ### Use
+   ```go
+   import "github.com/CloudSnorkel/cdk-github-runners-go/cloudsnorkelcdkgithubrunners"
+   
+   NewGitHubRunners(this, jsii.String("runners"))
+   ```
+   </details>
+   <details><summary>.NET</summary>
+
+   ### Install
+   Available on [Nuget][12].
+   ```bash
+   dotnet add package CloudSnorkel.Cdk.Github.Runners
+   ```
+   ### Use
+   ```csharp
+   using CloudSnorkel;
+   
+   new GitHubRunners(this, "runners");
+   ```
+   </details>
+2. Use `GitHubRunners` construct in your code (starting with default arguments is fine)
+3. Deploy your stack
+4. Look for the status command output similar to `aws --region us-east-1 lambda invoke --function-name status-XYZ123 status.json`
+   ```
+    ✅  github-runners-test
+
+   ✨  Deployment time: 260.01s
+   
+   Outputs:
+   github-runners-test.runnersstatuscommand4A30F0F5 = aws --region us-east-1 lambda invoke --function-name github-runners-test-runnersstatus1A5771C0-mvttg8oPQnQS status.json
+   ```
+5. Execute the status command (you may need to specify `--profile` too) and open the resulting `status.json` file
+6. Open the URL in `github.setup.url` from `status.json` or [manually setup GitHub](SETUP_GITHUB.md) integration as an app or with personal access token
+7. Run status command again to confirm `github.auth.status` and `github.webhook.status` are OK
+8. Trigger a GitHub action that has a `self-hosted` label with `runs-on: [self-hosted, linux, codebuild]` or similar
+9. If the action is not successful, see [troubleshooting](#Troubleshooting)
 
 [![Demo](demo-thumbnail.jpg)](https://youtu.be/wlyv_3V8lIw)
 
@@ -104,10 +161,10 @@ let dbSg: ec2.SecurityGroup;
 let bucket: s3.Bucket;
 
 // create a custom CodeBuild provider
-const myProvider = new CodeBuildRunnerProvider(this, 'codebuild runner', { 
-  label: 'my-codebuild',
-  vpc: vpc,
-  securityGroup: runnerSg,
+const myProvider = new CodeBuildRunnerProvider(this, 'codebuild runner', {
+   labels: ['my-codebuild'],
+   vpc: vpc,
+   securityGroups: [runnerSg],
 });
 // grant some permissions to the provider
 bucket.grantReadWrite(myProvider);
@@ -132,9 +189,9 @@ myBuilder.addComponent(
 );
 
 const myProvider = new FargateRunnerProvider(this, 'fargate runner', {
-   label: 'customized-fargate',
+   labels: ['customized-fargate'],
    vpc: vpc,
-   securityGroup: runnerSg,
+   securityGroups: [runnerSg],
    imageBuilder: myBuilder,
 });
 
@@ -160,31 +217,31 @@ Windows images can also be customized the same way.
 
 ```typescript
 const myWindowsBuilder = FargateRunnerProvider.imageBuilder(this, 'Windows image builder', {
-  architecture: Architecture.X86_64,
-  os: Os.WINDOWS,
-  runnerVersion: RunnerVersion.specific('2.291.0'),
-  rebuildInterval: Duration.days(14),    
+   architecture: Architecture.X86_64,
+   os: Os.WINDOWS,
+   runnerVersion: RunnerVersion.specific('2.291.0'),
+   rebuildInterval: Duration.days(14),
 });
 myWindowsBuilder.addComponent(
-  RunnerImageComponent.custom({
-    name: 'Ninja',
-    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',
-    ],
-  })
+        RunnerImageComponent.custom({
+           name: 'Ninja',
+           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 FargateRunnerProvider(this, 'fargate runner', {
-  label: 'customized-windows-fargate',
-  vpc: vpc,
-  securityGroup: runnerSg,
-  imageBuidler: myWindowsBuilder,
+   labels: ['customized-windows-fargate'],
+   vpc: vpc,
+   securityGroups: [runnerSg],
+   imageBuidler: myWindowsBuilder,
 });
 
 new GitHubRunners(this, 'runners', {
-  providers: [myProvider],
+   providers: [myProvider],
 });
 ```
 
@@ -192,15 +249,15 @@ The runner OS and architecture is determined by the image it is set to use. For
 
 ```typescript
 new GitHubRunners(this, 'runners', {
-  providers: [
-    new FargateRunnerProvider(this, 'fargate runner', {
-      labels: ['arm64', 'fargate'],
-      imageBuidler: FargateRunnerProvider.imageBuilder(this, 'image builder', {
-        architecture: Architecture.ARM64,
-        os: Os.LINUX,
+   providers: [
+      new FargateRunnerProvider(this, 'fargate runner', {
+         labels: ['arm64', 'fargate'],
+         imageBuidler: FargateRunnerProvider.imageBuilder(this, 'image builder', {
+            architecture: Architecture.ARM64,
+            os: Os.LINUX_UBUNTU,
+         }),
       }),
-    }),
-  ],
+   ],
 });
 ```
 
@@ -247,7 +304,7 @@ Other useful metrics to track:
 [5]: https://github.com/actions/runner
 [6]: https://pypi.org/project/cloudsnorkel.cdk-github-runners
 [7]: https://www.npmjs.com/package/@cloudsnorkel/cdk-github-runners
-[8]: https://search.maven.org/search?q=g:%22com.cloudsnorkel%22%20AND%20a:%22cdk.github.runners%22
+[8]: https://central.sonatype.com/artifact/com.cloudsnorkel/cdk.github.runners/
 [9]: https://docs.github.com/en/developers/apps/getting-started-with-apps/about-apps
 [10]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
 [11]: https://pkg.go.dev/github.com/CloudSnorkel/cdk-github-runners-go/cloudsnorkelcdkgithubrunners

package/assets/delete-runner.lambda/index.js

@@ -10322,7 +10322,7 @@ var require_semver = __commonJS({
             version = version.version;
           }
         } else if (typeof version !== "string") {
-          throw new TypeError(`Invalid Version: ${version}`);
+          throw new TypeError(`Invalid Version: ${require("util").inspect(version)}`);
         }
         if (version.length > MAX_LENGTH) {
           throw new TypeError(
@@ -10495,9 +10495,13 @@ var require_semver = __commonJS({
             }
             this.prerelease = [];
             break;
-          case "pre":
+          case "pre": {
+            const base = Number(identifierBase) ? 1 : 0;
+            if (!identifier && identifierBase === false) {
+              throw new Error("invalid increment argument: identifier is empty");
+            }
             if (this.prerelease.length === 0) {
-              this.prerelease = [0];
+              this.prerelease = [base];
             } else {
               let i = this.prerelease.length;
               while (--i >= 0) {
@@ -10507,20 +10511,27 @@ var require_semver = __commonJS({
                 }
               }
               if (i === -1) {
-                this.prerelease.push(0);
+                if (identifier === this.prerelease.join(".") && identifierBase === false) {
+                  throw new Error("invalid increment argument: identifier already exists");
+                }
+                this.prerelease.push(base);
               }
             }
             if (identifier) {
-              const base = Number(identifierBase) ? 1 : 0;
+              let prerelease = [identifier, base];
+              if (identifierBase === false) {
+                prerelease = [identifier];
+              }
               if (compareIdentifiers(this.prerelease[0], identifier) === 0) {
                 if (isNaN(this.prerelease[1])) {
-                  this.prerelease = [identifier, base];
+                  this.prerelease = prerelease;
                 }
               } else {
-                this.prerelease = [identifier, base];
+                this.prerelease = prerelease;
               }
             }
             break;
+          }
           default:
             throw new Error(`invalid increment argument: ${release}`);
         }
@@ -10536,22 +10547,18 @@ var require_semver = __commonJS({
 // node_modules/semver/functions/parse.js
 var require_parse = __commonJS({
   "node_modules/semver/functions/parse.js"(exports2, module2) {
-    var { MAX_LENGTH } = require_constants();
     var SemVer = require_semver();
-    var parse = (version, options) => {
+    var parse = (version, options, throwErrors = false) => {
       if (version instanceof SemVer) {
         return version;
       }
-      if (typeof version !== "string") {
-        return null;
-      }
-      if (version.length > MAX_LENGTH) {
-        return null;
-      }
       try {
         return new SemVer(version, options);
       } catch (er) {
-        return null;
+        if (!throwErrors) {
+          return null;
+        }
+        throw er;
       }
     };
     module2.exports = parse;
@@ -10605,60 +10612,41 @@ var require_inc = __commonJS({
   }
 });
 
-// node_modules/semver/functions/compare.js
-var require_compare = __commonJS({
-  "node_modules/semver/functions/compare.js"(exports2, module2) {
-    var SemVer = require_semver();
-    var compare = (a, b, loose) => new SemVer(a, loose).compare(new SemVer(b, loose));
-    module2.exports = compare;
-  }
-});
-
-// node_modules/semver/functions/eq.js
-var require_eq = __commonJS({
-  "node_modules/semver/functions/eq.js"(exports2, module2) {
-    var compare = require_compare();
-    var eq = (a, b, loose) => compare(a, b, loose) === 0;
-    module2.exports = eq;
-  }
-});
-
 // node_modules/semver/functions/diff.js
 var require_diff = __commonJS({
   "node_modules/semver/functions/diff.js"(exports2, module2) {
     var parse = require_parse();
-    var eq = require_eq();
     var diff = (version1, version2) => {
-      const v1 = parse(version1);
-      const v2 = parse(version2);
-      if (eq(v1, v2)) {
+      const v1 = parse(version1, null, true);
+      const v2 = parse(version2, null, true);
+      const comparison = v1.compare(v2);
+      if (comparison === 0) {
         return null;
-      } else {
-        const hasPre = v1.prerelease.length || v2.prerelease.length;
-        const prefix = hasPre ? "pre" : "";
-        const defaultResult = hasPre ? "prerelease" : "";
-        if (v1.major !== v2.major) {
-          return prefix + "major";
-        }
-        if (v1.minor !== v2.minor) {
-          return prefix + "minor";
-        }
-        if (v1.patch !== v2.patch) {
-          return prefix + "patch";
-        }
-        if (!v1.prerelease.length || !v2.prerelease.length) {
-          if (v1.patch) {
-            return "patch";
-          }
-          if (v1.minor) {
-            return "minor";
-          }
-          if (v1.major) {
-            return "major";
-          }
-        }
-        return defaultResult;
       }
+      const v1Higher = comparison > 0;
+      const highVersion = v1Higher ? v1 : v2;
+      const lowVersion = v1Higher ? v2 : v1;
+      const highHasPre = !!highVersion.prerelease.length;
+      const prefix = highHasPre ? "pre" : "";
+      if (v1.major !== v2.major) {
+        return prefix + "major";
+      }
+      if (v1.minor !== v2.minor) {
+        return prefix + "minor";
+      }
+      if (v1.patch !== v2.patch) {
+        return prefix + "patch";
+      }
+      if (highHasPre) {
+        return "prerelease";
+      }
+      if (lowVersion.patch) {
+        return "patch";
+      }
+      if (lowVersion.minor) {
+        return "minor";
+      }
+      return "major";
     };
     module2.exports = diff;
   }
@@ -10703,6 +10691,15 @@ var require_prerelease = __commonJS({
   }
 });
 
+// node_modules/semver/functions/compare.js
+var require_compare = __commonJS({
+  "node_modules/semver/functions/compare.js"(exports2, module2) {
+    var SemVer = require_semver();
+    var compare = (a, b, loose) => new SemVer(a, loose).compare(new SemVer(b, loose));
+    module2.exports = compare;
+  }
+});
+
 // node_modules/semver/functions/rcompare.js
 var require_rcompare = __commonJS({
   "node_modules/semver/functions/rcompare.js"(exports2, module2) {
@@ -10770,6 +10767,15 @@ var require_lt = __commonJS({
   }
 });
 
+// node_modules/semver/functions/eq.js
+var require_eq = __commonJS({
+  "node_modules/semver/functions/eq.js"(exports2, module2) {
+    var compare = require_compare();
+    var eq = (a, b, loose) => compare(a, b, loose) === 0;
+    module2.exports = eq;
+  }
+});
+
 // node_modules/semver/functions/neq.js
 var require_neq = __commonJS({
   "node_modules/semver/functions/neq.js"(exports2, module2) {