cloudsnorkel.cdk-github-runners 0.13.4__py3-none-any.whl → 0.14.1__py3-none-any.whl

cloudsnorkel/cdk_github_runners/__init__.py

@@ -1,4 +1,4 @@
-'''
+r'''
 # GitHub Self-Hosted Runners CDK Constructs
 
 [![NPM](https://img.shields.io/npm/v/@cloudsnorkel/cdk-github-runners?label=npm&logo=npm)](https://www.npmjs.com/package/@cloudsnorkel/cdk-github-runners)
@@ -71,9 +71,14 @@ You can also create your own provider by implementing `IRunnerProvider`.
    ### Use
 
    ```python
+   from aws_cdk import App, Stack
    from cloudsnorkel.cdk_github_runners import GitHubRunners
 
-   GitHubRunners(self, "runners")
+   app = App()
+   stack = Stack(app, "github-runners")
+   GitHubRunners(stack, "runners")
+
+   app.synth()
    ```
 
    </details>
@@ -90,9 +95,14 @@ You can also create your own provider by implementing `IRunnerProvider`.
    ### Use
 
    ```python
+   import { App, Stack } from 'aws-cdk-lib';
    import { GitHubRunners } from '@cloudsnorkel/cdk-github-runners';
 
-   new GitHubRunners(this, "runners");
+   const app = new App();
+   const stack = new Stack(app, 'github-runners');
+   new GitHubRunners(stack, 'runners');
+
+   app.synth();
    ```
 
    </details>
@@ -112,9 +122,19 @@ You can also create your own provider by implementing `IRunnerProvider`.
    ### Use
 
    ```java
+   import software.amazon.awscdk.App;
+   import software.amazon.awscdk.Stack;
    import com.cloudsnorkel.cdk.github.runners.GitHubRunners;
 
-   GitHubRunners.Builder.create(this, "runners").build();
+   public class Example {
+     public static void main(String[] args){
+       App app = new App();
+       Stack stack = new Stack(app, "github-runners");
+       GitHubRunners.Builder.create(stack, "runners").build();
+
+       app.synth();
+     }
+   }
    ```
 
    </details>
@@ -131,9 +151,21 @@ You can also create your own provider by implementing `IRunnerProvider`.
    ### Use
 
    ```go
-   import "github.com/CloudSnorkel/cdk-github-runners-go/cloudsnorkelcdkgithubrunners"
+   package main
+
+   import (
+     "github.com/CloudSnorkel/cdk-github-runners-go/cloudsnorkelcdkgithubrunners"
+     "github.com/aws/aws-cdk-go/awscdk/v2"
+     "github.com/aws/jsii-runtime-go"
+   )
 
-   NewGitHubRunners(this, jsii.String("runners"))
+   func main() {
+     app := awscdk.NewApp(nil)
+     stack := awscdk.NewStack(app, jsii.String("github-runners"), &awscdk.StackProps{})
+     cloudsnorkelcdkgithubrunners.NewGitHubRunners(stack, jsii.String("runners"), &cloudsnorkelcdkgithubrunners.GitHubRunnersProps{})
+
+     app.Synth(nil)
+   }
    ```
 
    </details>
@@ -150,9 +182,22 @@ You can also create your own provider by implementing `IRunnerProvider`.
    ### Use
 
    ```csharp
+   using Amazon.CDK;
    using CloudSnorkel;
 
-   new GitHubRunners(this, "runners");
+   namespace Example
+   {
+     sealed class Program
+     {
+       public static void Main(string[] args)
+       {
+         var app = new App();
+         var stack = new Stack(app, "github-runners");
+         new GitHubRunners(stack, "runners");
+         app.Synth();
+       }
+     }
+   }
    ```
 
    </details>
@@ -3492,7 +3537,7 @@ class LambdaRunnerProvider(
 
         You can add components to the image builder by calling ``imageBuilder.addComponent()``.
 
-        The default OS is Amazon Linux 2 running on x64 architecture.
+        The default OS is Amazon Linux 2023 running on x64 architecture.
 
         Included components:
 
@@ -3504,8 +3549,6 @@ class LambdaRunnerProvider(
         - ``RunnerImageComponent.githubRunner()``
         - ``RunnerImageComponent.lambdaEntrypoint()``
 
-        Base Docker image: ``public.ecr.aws/lambda/nodejs:20-x86_64`` or ``public.ecr.aws/lambda/nodejs:20-arm64``
-
         :param scope: -
         :param id: -
         :param architecture: (experimental) Image architecture. Default: Architecture.X86_64
@@ -5908,7 +5951,7 @@ class AmiBuilder(
 ):
     '''(deprecated) An AMI builder that uses AWS Image Builder to build AMIs pre-baked with all the GitHub Actions runner requirements.
 
-    Builders can be used with {@link Ec2Runner }.
+    Builders can be used with {@link Ec2RunnerProvider }.
 
     Each builder re-runs automatically at a set interval to make sure the AMIs contain the latest versions of everything.
 
@@ -5933,7 +5976,7 @@ class AmiBuilder(
            amiBuilder: builder,
        });
 
-    :deprecated: use RunnerImageBuilder
+    :deprecated: use RunnerImageBuilder, e.g. with Ec2RunnerProvider.imageBuilder()
 
     :stability: deprecated
     '''

cloudsnorkel/cdk_github_runners/_jsii/__init__.py

@@ -18,9 +18,9 @@ import constructs._jsii
 
 __jsii_assembly__ = jsii.JSIIAssembly.load(
     "@cloudsnorkel/cdk-github-runners",
-    "0.13.4",
+    "0.14.1",
     __name__[0:-6],
-    "cdk-github-runners@0.13.4.jsii.tgz",
+    "cdk-github-runners@0.14.1.jsii.tgz",
 )
 
 __all__ = [

{cloudsnorkel.cdk_github_runners-0.13.4.dist-info → cloudsnorkel.cdk_github_runners-0.14.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cloudsnorkel.cdk-github-runners
-Version: 0.13.4
+Version: 0.14.1
 Summary: CDK construct to create GitHub Actions self-hosted runners. A webhook listens to events and creates ephemeral runners on the fly.
 Home-page: https://github.com/CloudSnorkel/cdk-github-runners.git
 Author: Amir Szekely<amir@cloudsnorkel.com>
@@ -22,7 +22,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: aws-cdk-lib <3.0.0,>=2.123.0
 Requires-Dist: constructs <11.0.0,>=10.0.5
-Requires-Dist: jsii <2.0.0,>=1.98.0
+Requires-Dist: jsii <2.0.0,>=1.100.0
 Requires-Dist: publication >=0.0.3
 Requires-Dist: typeguard ~=2.13.3
 
@@ -98,9 +98,14 @@ You can also create your own provider by implementing `IRunnerProvider`.
    ### Use
 
    ```python
+   from aws_cdk import App, Stack
    from cloudsnorkel.cdk_github_runners import GitHubRunners
 
-   GitHubRunners(self, "runners")
+   app = App()
+   stack = Stack(app, "github-runners")
+   GitHubRunners(stack, "runners")
+
+   app.synth()
    ```
 
    </details>
@@ -117,9 +122,14 @@ You can also create your own provider by implementing `IRunnerProvider`.
    ### Use
 
    ```python
+   import { App, Stack } from 'aws-cdk-lib';
    import { GitHubRunners } from '@cloudsnorkel/cdk-github-runners';
 
-   new GitHubRunners(this, "runners");
+   const app = new App();
+   const stack = new Stack(app, 'github-runners');
+   new GitHubRunners(stack, 'runners');
+
+   app.synth();
    ```
 
    </details>
@@ -139,9 +149,19 @@ You can also create your own provider by implementing `IRunnerProvider`.
    ### Use
 
    ```java
+   import software.amazon.awscdk.App;
+   import software.amazon.awscdk.Stack;
    import com.cloudsnorkel.cdk.github.runners.GitHubRunners;
 
-   GitHubRunners.Builder.create(this, "runners").build();
+   public class Example {
+     public static void main(String[] args){
+       App app = new App();
+       Stack stack = new Stack(app, "github-runners");
+       GitHubRunners.Builder.create(stack, "runners").build();
+
+       app.synth();
+     }
+   }
    ```
 
    </details>
@@ -158,9 +178,21 @@ You can also create your own provider by implementing `IRunnerProvider`.
    ### Use
 
    ```go
-   import "github.com/CloudSnorkel/cdk-github-runners-go/cloudsnorkelcdkgithubrunners"
+   package main
+
+   import (
+     "github.com/CloudSnorkel/cdk-github-runners-go/cloudsnorkelcdkgithubrunners"
+     "github.com/aws/aws-cdk-go/awscdk/v2"
+     "github.com/aws/jsii-runtime-go"
+   )
+
+   func main() {
+     app := awscdk.NewApp(nil)
+     stack := awscdk.NewStack(app, jsii.String("github-runners"), &awscdk.StackProps{})
+     cloudsnorkelcdkgithubrunners.NewGitHubRunners(stack, jsii.String("runners"), &cloudsnorkelcdkgithubrunners.GitHubRunnersProps{})
 
-   NewGitHubRunners(this, jsii.String("runners"))
+     app.Synth(nil)
+   }
    ```
 
    </details>
@@ -177,9 +209,22 @@ You can also create your own provider by implementing `IRunnerProvider`.
    ### Use
 
    ```csharp
+   using Amazon.CDK;
    using CloudSnorkel;
 
-   new GitHubRunners(this, "runners");
+   namespace Example
+   {
+     sealed class Program
+     {
+       public static void Main(string[] args)
+       {
+         var app = new App();
+         var stack = new Stack(app, "github-runners");
+         new GitHubRunners(stack, "runners");
+         app.Synth();
+       }
+     }
+   }
    ```
 
    </details>

cloudsnorkel.cdk_github_runners-0.14.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+cloudsnorkel/cdk_github_runners/__init__.py,sha256=6bIUJaprZZXAlX26Jl4P4cdgvZPXD6GW1HD50dm61gU,604268
+cloudsnorkel/cdk_github_runners/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+cloudsnorkel/cdk_github_runners/_jsii/__init__.py,sha256=44LlieecBsvQr_KQMm5CtApbbHxrZ3fW_T6uk_rIZ38,508
+cloudsnorkel/cdk_github_runners/_jsii/cdk-github-runners@0.14.1.jsii.tgz,sha256=Mc680IvqJupGTq-rhM33vZW9p6EYkCzrcuP5-tLJEsE,1441548
+cloudsnorkel.cdk_github_runners-0.14.1.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+cloudsnorkel.cdk_github_runners-0.14.1.dist-info/METADATA,sha256=eSdLfrzMx_6GXtcTrgN5_h-oPBh1kThU4ioUCEcTUEc,17610
+cloudsnorkel.cdk_github_runners-0.14.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+cloudsnorkel.cdk_github_runners-0.14.1.dist-info/top_level.txt,sha256=6vUrT-dcGOiRMT4Q6gEQPznoyS7nHOJ269MHpo4DEd8,13
+cloudsnorkel.cdk_github_runners-0.14.1.dist-info/RECORD,,

cloudsnorkel.cdk_github_runners-0.13.4.dist-info/RECORD

@@ -1,9 +0,0 @@
-cloudsnorkel/cdk_github_runners/__init__.py,sha256=LK6JUJoDoPN5IJHTroRibrmP9Bqr1hj3DPk3Pk34mf4,603186
-cloudsnorkel/cdk_github_runners/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-cloudsnorkel/cdk_github_runners/_jsii/__init__.py,sha256=3MSZtQ-RSyro2E7LPMIKhFqb9Z2ujXpdl-UJtVwItCk,508
-cloudsnorkel/cdk_github_runners/_jsii/cdk-github-runners@0.13.4.jsii.tgz,sha256=15HmL5aA6i9V9c1idvBcFnyq8MjVlWndCyj7zUXR3jE,1438707
-cloudsnorkel.cdk_github_runners-0.13.4.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-cloudsnorkel.cdk_github_runners-0.13.4.dist-info/METADATA,sha256=97zZc8NSnAGc6PygNVp5lMnGlq26iMV7dJvTk5XmE0s,16467
-cloudsnorkel.cdk_github_runners-0.13.4.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-cloudsnorkel.cdk_github_runners-0.13.4.dist-info/top_level.txt,sha256=6vUrT-dcGOiRMT4Q6gEQPznoyS7nHOJ269MHpo4DEd8,13
-cloudsnorkel.cdk_github_runners-0.13.4.dist-info/RECORD,,