@cloudsnorkel/cdk-github-runners 0.11.1 → 0.11.3

package/.jsii

@@ -5113,7 +5113,7 @@
       "methods": [
         {
           "docs": {
-            "remarks": "Included components:\n * `RunnerImageComponent.requiredPackages()`\n * `RunnerImageComponent.runnerUser()`\n * `RunnerImageComponent.git()`\n * `RunnerImageComponent.githubCli()`\n * `RunnerImageComponent.awsCli()`\n * `RunnerImageComponent.dockerInDocker()`\n * `RunnerImageComponent.githubRunner()`",
+            "remarks": "Included components:\n * `RunnerImageComponent.requiredPackages()`\n * `RunnerImageComponent.runnerUser()`\n * `RunnerImageComponent.git()`\n * `RunnerImageComponent.githubCli()`\n * `RunnerImageComponent.awsCli()`\n * `RunnerImageComponent.docker()`\n * `RunnerImageComponent.githubRunner()`",
             "stability": "experimental",
             "summary": "Create new image builder that builds CodeBuild specific runner images using Ubuntu."
           },
@@ -5499,7 +5499,7 @@
           "abstract": true,
           "docs": {
             "default": "CodeBuildRunnerProvider.imageBuilder()",
-            "remarks": "The image builder must contain the {@link RunnerImageComponent.dockerInDocker} component unless `dockerInDocker` is set to false.\n\nThe image builder determines the OS and architecture of the runner.",
+            "remarks": "The image builder must contain the {@link RunnerImageComponent.docker} component unless `dockerInDocker` is set to false.\n\nThe image builder determines the OS and architecture of the runner.",
             "stability": "experimental",
             "summary": "Runner image builder used to build Docker images containing GitHub Runner and all requirements."
           },
@@ -6986,7 +6986,7 @@
       "methods": [
         {
           "docs": {
-            "remarks": "Included components:\n * `RunnerImageComponent.requiredPackages()`\n * `RunnerImageComponent.runnerUser()`\n * `RunnerImageComponent.git()`\n * `RunnerImageComponent.githubCli()`\n * `RunnerImageComponent.awsCli()`\n * `RunnerImageComponent.dockerInDocker()`\n * `RunnerImageComponent.githubRunner()`",
+            "remarks": "Included components:\n * `RunnerImageComponent.requiredPackages()`\n * `RunnerImageComponent.runnerUser()`\n * `RunnerImageComponent.git()`\n * `RunnerImageComponent.githubCli()`\n * `RunnerImageComponent.awsCli()`\n * `RunnerImageComponent.docker()`\n * `RunnerImageComponent.githubRunner()`",
             "stability": "experimental",
             "summary": "Create new image builder that builds ECS specific runner images using Ubuntu."
           },
@@ -12120,12 +12120,13 @@
         },
         {
           "docs": {
-            "stability": "experimental",
+            "deprecated": "use `docker()`",
+            "stability": "deprecated",
             "summary": "A component to install Docker-in-Docker."
           },
           "locationInModule": {
             "filename": "src/image-builders/components.ts",
-            "line": 397
+            "line": 399
           },
           "name": "dockerInDocker",
           "returns": {
@@ -12143,7 +12144,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/components.ts",
-            "line": 445
+            "line": 409
           },
           "name": "extraCertificates",
           "parameters": [
@@ -12244,7 +12245,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/components.ts",
-            "line": 495
+            "line": 459
           },
           "name": "lambdaEntrypoint",
           "returns": {
@@ -12296,7 +12297,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/components.ts",
-            "line": 544
+            "line": 508
           },
           "name": "getAssets",
           "parameters": [
@@ -12333,7 +12334,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/components.ts",
-            "line": 539
+            "line": 503
           },
           "name": "getCommands",
           "parameters": [
@@ -12369,7 +12370,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/components.ts",
-            "line": 553
+            "line": 517
           },
           "name": "getDockerCommands",
           "parameters": [
@@ -12404,7 +12405,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/components.ts",
-            "line": 560
+            "line": 524
           },
           "name": "shouldReboot",
           "parameters": [
@@ -12440,7 +12441,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/components.ts",
-            "line": 534
+            "line": 498
           },
           "name": "name",
           "type": {
@@ -13324,6 +13325,6 @@
       "symbolId": "src/image-builders/aws-image-builder/deprecated/windows-components:WindowsComponents"
     }
   },
-  "version": "0.11.1",
-  "fingerprint": "mTC5uTa9W4WUsRC7U4/9pMkGsZF1IjnX7GFhUnpMLgM="
+  "version": "0.11.3",
+  "fingerprint": "L8i2LNt6SHuebgwUjIMYui+ilaqzrput7YJ3zRA3bCk="
 }

package/API.md

@@ -669,7 +669,7 @@ Included components:
  * `RunnerImageComponent.git()`
  * `RunnerImageComponent.githubCli()`
  * `RunnerImageComponent.awsCli()`
- * `RunnerImageComponent.dockerInDocker()`
+ * `RunnerImageComponent.docker()`
  * `RunnerImageComponent.githubRunner()`
 
 ###### `scope`<sup>Required</sup> <a name="scope" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunner.imageBuilder.parameter.scope"></a>
@@ -1035,7 +1035,7 @@ Included components:
  * `RunnerImageComponent.git()`
  * `RunnerImageComponent.githubCli()`
  * `RunnerImageComponent.awsCli()`
- * `RunnerImageComponent.dockerInDocker()`
+ * `RunnerImageComponent.docker()`
  * `RunnerImageComponent.githubRunner()`
 
 ###### `scope`<sup>Required</sup> <a name="scope" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProvider.imageBuilder.parameter.scope"></a>
@@ -2148,7 +2148,7 @@ Included components:
  * `RunnerImageComponent.git()`
  * `RunnerImageComponent.githubCli()`
  * `RunnerImageComponent.awsCli()`
- * `RunnerImageComponent.dockerInDocker()`
+ * `RunnerImageComponent.docker()`
  * `RunnerImageComponent.githubRunner()`
 
 ###### `scope`<sup>Required</sup> <a name="scope" id="@cloudsnorkel/cdk-github-runners.EcsRunnerProvider.imageBuilder.parameter.scope"></a>
@@ -5476,7 +5476,7 @@ public readonly imageBuilder: IRunnerImageBuilder;
 
 Runner image builder used to build Docker images containing GitHub Runner and all requirements.
 
-The image builder must contain the {@link RunnerImageComponent.dockerInDocker} component unless `dockerInDocker` is set to false.
+The image builder must contain the {@link RunnerImageComponent.docker} component unless `dockerInDocker` is set to false.
 
 The image builder determines the OS and architecture of the runner.
 
@@ -8873,7 +8873,7 @@ 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).
 
-##### `dockerInDocker` <a name="dockerInDocker" id="@cloudsnorkel/cdk-github-runners.RunnerImageComponent.dockerInDocker"></a>
+##### ~~`dockerInDocker`~~ <a name="dockerInDocker" id="@cloudsnorkel/cdk-github-runners.RunnerImageComponent.dockerInDocker"></a>
 
 ```typescript
 import { RunnerImageComponent } from '@cloudsnorkel/cdk-github-runners'

package/SETUP_GITHUB.md

@@ -30,6 +30,7 @@ Integration with GitHub can be done using an [app](#app-authentication) or [pers
 4. In the repository permissions section enable:
     1. Actions: Read and write
     2. Administration: Read and write
+    3. Deployments: Read-only
 5. In the event subscription section enable:
     1. Workflow job
 6. Under "Where can this GitHub App be installed?" select "Only on this account"