@cloudsnorkel/cdk-github-runners 0.14.22 → 0.14.24

package/API.md

@@ -3447,7 +3447,7 @@ Creates CloudWatch Logs Insights saved queries that can be used to debug issues
 ##### `failedImageBuildsTopic` <a name="failedImageBuildsTopic" id="@cloudsnorkel/cdk-github-runners.GitHubRunners.failedImageBuildsTopic"></a>
 
 ```typescript
-public failedImageBuildsTopic(): Topic
+public failedImageBuildsTopic(scope?: Construct): Topic
 ```
 
 Creates a topic for notifications when a runner image build fails.
@@ -3456,6 +3456,18 @@ Runner images are rebuilt every week by default. This provides the latest GitHub
 
 If you want to be sure you are using the latest runner version, you can use this topic to be notified when a build fails.
 
+When the image builder is defined in a separate stack (e.g. in a split-stacks setup), pass that stack or construct
+as the optional scope so the topic and failure-notification aspects are created in the same stack as the image
+builder. Otherwise the aspects may not find the image builder resources.
+
+###### `scope`<sup>Optional</sup> <a name="scope" id="@cloudsnorkel/cdk-github-runners.GitHubRunners.failedImageBuildsTopic.parameter.scope"></a>
+
+- *Type:* constructs.Construct
+
+Optional scope (e.g. the image builder stack) where the topic and aspects will be created. Defaults to this construct.
+
+---
+
 ##### `metricFailed` <a name="metricFailed" id="@cloudsnorkel/cdk-github-runners.GitHubRunners.metricFailed"></a>
 
 ```typescript
@@ -10437,7 +10449,7 @@ Returns true if the image builder should be rebooted after this component is ins
 | <code><a href="#@cloudsnorkel/cdk-github-runners.RunnerImageComponent.dockerInDocker">dockerInDocker</a></code> | A component to install Docker-in-Docker. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.RunnerImageComponent.environmentVariables">environmentVariables</a></code> | A component to add environment variables for jobs the runner executes. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.RunnerImageComponent.extraCertificates">extraCertificates</a></code> | A component to add a trusted certificate authority. |
-| <code><a href="#@cloudsnorkel/cdk-github-runners.RunnerImageComponent.git">git</a></code> | A component to install the GitHub CLI. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.RunnerImageComponent.git">git</a></code> | A component to install Git. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.RunnerImageComponent.githubCli">githubCli</a></code> | A component to install the GitHub CLI. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.RunnerImageComponent.githubRunner">githubRunner</a></code> | A component to install the GitHub Actions Runner. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.RunnerImageComponent.lambdaEntrypoint">lambdaEntrypoint</a></code> | A component to set up the required Lambda entrypoint for Lambda runners. |
@@ -10451,11 +10463,19 @@ Returns true if the image builder should be rebooted after this component is ins
 ```typescript
 import { RunnerImageComponent } from '@cloudsnorkel/cdk-github-runners'
 
-RunnerImageComponent.awsCli()
+RunnerImageComponent.awsCli(version?: string)
 ```
 
 A component to install the AWS CLI.
 
+###### `version`<sup>Optional</sup> <a name="version" id="@cloudsnorkel/cdk-github-runners.RunnerImageComponent.awsCli.parameter.version"></a>
+
+- *Type:* string
+
+Software version to install (e.g. '2.15.0'). Default: latest.
+
+---
+
 ##### `cloudWatchAgent` <a name="cloudWatchAgent" id="@cloudsnorkel/cdk-github-runners.RunnerImageComponent.cloudWatchAgent"></a>
 
 ```typescript
@@ -10493,23 +10513,39 @@ Use this to customize the image for the runner.
 ```typescript
 import { RunnerImageComponent } from '@cloudsnorkel/cdk-github-runners'
 
-RunnerImageComponent.docker()
+RunnerImageComponent.docker(version?: string)
 ```
 
 A component to install Docker.
 
 On Windows this sets up dockerd for Windows containers without Docker Desktop. If you need Linux containers on Windows, you'll need to install Docker Desktop which doesn't seem to play well with servers (PRs welcome).
 
+###### `version`<sup>Optional</sup> <a name="version" id="@cloudsnorkel/cdk-github-runners.RunnerImageComponent.docker.parameter.version"></a>
+
+- *Type:* string
+
+Software version to install (e.g. '29.1.5'). Default: latest. Only used on Windows; on Linux (Ubuntu, Amazon Linux 2 and Amazon Linux 2023) the package version format is not reliably predictable so latest is always used.
+
+---
+
 ##### ~~`dockerInDocker`~~ <a name="dockerInDocker" id="@cloudsnorkel/cdk-github-runners.RunnerImageComponent.dockerInDocker"></a>
 
 ```typescript
 import { RunnerImageComponent } from '@cloudsnorkel/cdk-github-runners'
 
-RunnerImageComponent.dockerInDocker()
+RunnerImageComponent.dockerInDocker(version?: string)
 ```
 
 A component to install Docker-in-Docker.
 
+###### `version`<sup>Optional</sup> <a name="version" id="@cloudsnorkel/cdk-github-runners.RunnerImageComponent.dockerInDocker.parameter.version"></a>
+
+- *Type:* string
+
+Software version to install (e.g. '29.1.5'). Default: latest.
+
+---
+
 ##### `environmentVariables` <a name="environmentVariables" id="@cloudsnorkel/cdk-github-runners.RunnerImageComponent.environmentVariables"></a>
 
 ```typescript
@@ -10565,21 +10601,37 @@ unique certificate name to be used on runner file system.
 ```typescript
 import { RunnerImageComponent } from '@cloudsnorkel/cdk-github-runners'
 
-RunnerImageComponent.git()
+RunnerImageComponent.git(version?: string)
 ```
 
-A component to install the GitHub CLI.
+A component to install Git.
+
+###### `version`<sup>Optional</sup> <a name="version" id="@cloudsnorkel/cdk-github-runners.RunnerImageComponent.git.parameter.version"></a>
+
+- *Type:* string
+
+Software version to install (e.g. '2.43.0.windows.1'). Default: latest. Only used on Windows; on Linux the package manager is used.
+
+---
 
 ##### `githubCli` <a name="githubCli" id="@cloudsnorkel/cdk-github-runners.RunnerImageComponent.githubCli"></a>
 
 ```typescript
 import { RunnerImageComponent } from '@cloudsnorkel/cdk-github-runners'
 
-RunnerImageComponent.githubCli()
+RunnerImageComponent.githubCli(version?: string)
 ```
 
 A component to install the GitHub CLI.
 
+###### `version`<sup>Optional</sup> <a name="version" id="@cloudsnorkel/cdk-github-runners.RunnerImageComponent.githubCli.parameter.version"></a>
+
+- *Type:* string
+
+Software version to install (e.g. '2.40.0'). Default: latest. Only used on Windows (x64/windows_amd64); on Linux the package manager is used.
+
+---
+
 ##### `githubRunner` <a name="githubRunner" id="@cloudsnorkel/cdk-github-runners.RunnerImageComponent.githubRunner"></a>
 
 ```typescript

package/README.md

@@ -6,6 +6,7 @@
 [![Go](https://img.shields.io/github/v/tag/CloudSnorkel/cdk-github-runners?color=red&label=go&logo=go)][11]
 [![Nuget](https://img.shields.io/nuget/v/CloudSnorkel.Cdk.Github.Runners?color=red&&logo=nuget)][12]
 [![Release](https://github.com/CloudSnorkel/cdk-github-runners/actions/workflows/release.yml/badge.svg)](https://github.com/CloudSnorkel/cdk-github-runners/actions/workflows/release.yml)
+[![Discord](https://img.shields.io/badge/Discord-5865F2?logo=discord&logoColor=white)][20]
 [![License](https://img.shields.io/badge/license-Apache--2.0-blue)](https://github.com/CloudSnorkel/cdk-github-runners/blob/main/LICENSE)
 
 Use this CDK construct to create ephemeral [self-hosted GitHub runners][1] on-demand inside your AWS account.
@@ -25,6 +26,23 @@ Self-hosted runners in AWS are useful when:
 
 Ephemeral (or on-demand) runners are the [recommended way by GitHub][14] for auto-scaling, and they make sure all jobs run with a clean image. Runners are started on-demand. You don't pay unless a job is running.
 
+## Table of Contents
+
+- [API](#api)
+- [Providers](#providers)
+- [Installation](#installation)
+- [Customizing](#customizing)
+  - [Composite Providers](#composite-providers)
+  - [Custom Provider Selection](#custom-provider-selection)
+- [Examples](#examples)
+- [Architecture](#architecture)
+- [Troubleshooting](#troubleshooting)
+- [Monitoring](#monitoring)
+- [Getting Help](#getting-help)
+- [Contributing](#contributing)
+- [Sponsors](#sponsors)
+- [Other Options](#other-options)
+
 ## API
 
 The best way to browse API documentation is on [Constructs Hub][13]. It is available in all supported programming languages.
@@ -523,6 +541,14 @@ Other useful metrics to track:
 1. Use `GitHubRunners.metricJobCompleted()` to get a metric for the number of completed jobs broken down by labels and job success.
 2. Use `GitHubRunners.metricTime()` to get a metric for the total time a runner is running. This includes the overhead of starting the runner.
 
+## Getting Help
+
+Need help? We're here for you!
+
+* 💬 **GitHub Discussions**: Ask questions, share ideas, or get help from the community by opening a [discussion][18]
+* 🐛 **GitHub Issues**: Report bugs or request features by opening an [issue][16]
+* 💬 **Discord**: Join our [Discord community][20] for real-time help and discussions
+
 ## Contributing
 
 If you use and love this project, please consider contributing.
@@ -535,6 +561,43 @@ If you use and love this project, please consider contributing.
    * Allow edits from maintainers so small adjustments can be made easily.
 1. 💵 Consider [sponsoring][15] the project to show your support and optionally get your name listed below.
 
+## Sponsors
+
+Thanks to our generous sponsors who helped make this project possible!
+
+<table>
+  <tr>
+    <td align="center">
+      <a href="https://github.com/threat-down">
+        <img src="https://github.com/threat-down.png?size=100" width="100" height="100" alt="ThreatDown" />
+        <br />
+        <sub><b>ThreatDown</b></sub>
+      </a>
+    </td>
+    <td align="center">
+      <a href="https://github.com/magicbell">
+        <img src="https://github.com/magicbell.png?size=100" width="100" height="100" alt="MagicBell" />
+        <br />
+        <sub><b>MagicBell</b></sub>
+      </a>
+    </td>
+    <td align="center">
+      <a href="https://github.com/fragment-dev">
+        <img src="https://github.com/fragment-dev.png?size=100" width="100" height="100" alt="Fragment" />
+        <br />
+        <sub><b>Fragment</b></sub>
+      </a>
+    </td>
+    <td align="center">
+      <a href="https://github.com/andresionek91">
+        <img src="https://github.com/andresionek91.png?size=100" width="100" height="100" alt="Andre Sionek" />
+        <br />
+        <sub><b>Andre Sionek</b></sub>
+      </a>
+    </td>
+  </tr>
+</table>
+
 ## Other Options
 
 1. [github-aws-runners/terraform-aws-github-runner][3] if you're using Terraform
@@ -558,3 +621,5 @@ If you use and love this project, please consider contributing.
 [15]: https://github.com/sponsors/CloudSnorkel
 [16]: https://github.com/CloudSnorkel/cdk-github-runners/issues
 [17]: https://github.com/CloudSnorkel/cdk-github-runners/pulls
+[18]: https://github.com/CloudSnorkel/cdk-github-runners/discussions
+[20]: https://discord.gg/vdrTUTqQKv