@cloudsnorkel/cdk-github-runners 0.7.3 → 0.7.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/API.md CHANGED
@@ -2771,7 +2771,9 @@ const codeBuildRunnerProps: CodeBuildRunnerProps = { ... }
2771
2771
  | **Name** | **Type** | **Description** |
2772
2772
  | --- | --- | --- |
2773
2773
  | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.logRetention">logRetention</a></code> | <code>aws-cdk-lib.aws_logs.RetentionDays</code> | The number of days log events are kept in CloudWatch Logs. |
2774
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.retryOptions">retryOptions</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.ProviderRetryOptions">ProviderRetryOptions</a></code> | Options to retry operation in case of failure like missing capacity, or API quota issues. |
2774
2775
  | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.computeType">computeType</a></code> | <code>aws-cdk-lib.aws_codebuild.ComputeType</code> | The type of compute to use for this build. |
2776
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.dockerInDocker">dockerInDocker</a></code> | <code>boolean</code> | Support building and running Docker images by enabling Docker-in-Docker (dind) and the required CodeBuild privileged mode. |
2775
2777
  | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.imageBuilder">imageBuilder</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.IImageBuilder">IImageBuilder</a></code> | Image builder for CodeBuild image with GitHub runner pre-configured. |
2776
2778
  | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.label">label</a></code> | <code>string</code> | GitHub Actions label used for this provider. |
2777
2779
  | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.labels">labels</a></code> | <code>string[]</code> | GitHub Actions labels used for this provider. |
@@ -2800,6 +2802,19 @@ remove the retention policy, set the value to `INFINITE`.
2800
2802
 
2801
2803
  ---
2802
2804
 
2805
+ ##### `retryOptions`<sup>Optional</sup> <a name="retryOptions" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.retryOptions"></a>
2806
+
2807
+ ```typescript
2808
+ public readonly retryOptions: ProviderRetryOptions;
2809
+ ```
2810
+
2811
+ - *Type:* <a href="#@cloudsnorkel/cdk-github-runners.ProviderRetryOptions">ProviderRetryOptions</a>
2812
+ - *Default:* retry 10 times up to about 45 minutes
2813
+
2814
+ Options to retry operation in case of failure like missing capacity, or API quota issues.
2815
+
2816
+ ---
2817
+
2803
2818
  ##### `computeType`<sup>Optional</sup> <a name="computeType" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.computeType"></a>
2804
2819
 
2805
2820
  ```typescript
@@ -2815,6 +2830,22 @@ See the {@link ComputeType} enum for the possible values.
2815
2830
 
2816
2831
  ---
2817
2832
 
2833
+ ##### `dockerInDocker`<sup>Optional</sup> <a name="dockerInDocker" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.dockerInDocker"></a>
2834
+
2835
+ ```typescript
2836
+ public readonly dockerInDocker: boolean;
2837
+ ```
2838
+
2839
+ - *Type:* boolean
2840
+ - *Default:* true
2841
+
2842
+ Support building and running Docker images by enabling Docker-in-Docker (dind) and the required CodeBuild privileged mode.
2843
+
2844
+ Disabling this can
2845
+ speed up provisioning of CodeBuild runners. If you don't intend on running or building Docker images, disable this for faster start-up times.
2846
+
2847
+ ---
2848
+
2818
2849
  ##### `imageBuilder`<sup>Optional</sup> <a name="imageBuilder" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.imageBuilder"></a>
2819
2850
 
2820
2851
  ```typescript
@@ -3152,6 +3183,7 @@ const ec2RunnerProps: Ec2RunnerProps = { ... }
3152
3183
  | **Name** | **Type** | **Description** |
3153
3184
  | --- | --- | --- |
3154
3185
  | <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.logRetention">logRetention</a></code> | <code>aws-cdk-lib.aws_logs.RetentionDays</code> | The number of days log events are kept in CloudWatch Logs. |
3186
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.retryOptions">retryOptions</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.ProviderRetryOptions">ProviderRetryOptions</a></code> | Options to retry operation in case of failure like missing capacity, or API quota issues. |
3155
3187
  | <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.amiBuilder">amiBuilder</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.IAmiBuilder">IAmiBuilder</a></code> | AMI builder that creates AMIs with GitHub runner pre-configured. |
3156
3188
  | <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.instanceType">instanceType</a></code> | <code>aws-cdk-lib.aws_ec2.InstanceType</code> | Instance type for launched runner instances. |
3157
3189
  | <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.labels">labels</a></code> | <code>string[]</code> | GitHub Actions labels used for this provider. |
@@ -3183,6 +3215,19 @@ remove the retention policy, set the value to `INFINITE`.
3183
3215
 
3184
3216
  ---
3185
3217
 
3218
+ ##### `retryOptions`<sup>Optional</sup> <a name="retryOptions" id="@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.retryOptions"></a>
3219
+
3220
+ ```typescript
3221
+ public readonly retryOptions: ProviderRetryOptions;
3222
+ ```
3223
+
3224
+ - *Type:* <a href="#@cloudsnorkel/cdk-github-runners.ProviderRetryOptions">ProviderRetryOptions</a>
3225
+ - *Default:* retry 10 times up to about 45 minutes
3226
+
3227
+ Options to retry operation in case of failure like missing capacity, or API quota issues.
3228
+
3229
+ ---
3230
+
3186
3231
  ##### `amiBuilder`<sup>Optional</sup> <a name="amiBuilder" id="@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.amiBuilder"></a>
3187
3232
 
3188
3233
  ```typescript
@@ -3359,6 +3404,7 @@ const fargateRunnerProps: FargateRunnerProps = { ... }
3359
3404
  | **Name** | **Type** | **Description** |
3360
3405
  | --- | --- | --- |
3361
3406
  | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.logRetention">logRetention</a></code> | <code>aws-cdk-lib.aws_logs.RetentionDays</code> | The number of days log events are kept in CloudWatch Logs. |
3407
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.retryOptions">retryOptions</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.ProviderRetryOptions">ProviderRetryOptions</a></code> | Options to retry operation in case of failure like missing capacity, or API quota issues. |
3362
3408
  | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.assignPublicIp">assignPublicIp</a></code> | <code>boolean</code> | Assign public IP to the runner task. |
3363
3409
  | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.cluster">cluster</a></code> | <code>aws-cdk-lib.aws_ecs.Cluster</code> | Existing Fargate cluster to use. |
3364
3410
  | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.cpu">cpu</a></code> | <code>number</code> | The number of cpu units used by the task. |
@@ -3392,6 +3438,19 @@ remove the retention policy, set the value to `INFINITE`.
3392
3438
 
3393
3439
  ---
3394
3440
 
3441
+ ##### `retryOptions`<sup>Optional</sup> <a name="retryOptions" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.retryOptions"></a>
3442
+
3443
+ ```typescript
3444
+ public readonly retryOptions: ProviderRetryOptions;
3445
+ ```
3446
+
3447
+ - *Type:* <a href="#@cloudsnorkel/cdk-github-runners.ProviderRetryOptions">ProviderRetryOptions</a>
3448
+ - *Default:* retry 10 times up to about 45 minutes
3449
+
3450
+ Options to retry operation in case of failure like missing capacity, or API quota issues.
3451
+
3452
+ ---
3453
+
3395
3454
  ##### `assignPublicIp`<sup>Optional</sup> <a name="assignPublicIp" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.assignPublicIp"></a>
3396
3455
 
3397
3456
  ```typescript
@@ -3626,6 +3685,7 @@ const gitHubRunnersProps: GitHubRunnersProps = { ... }
3626
3685
  | <code><a href="#@cloudsnorkel/cdk-github-runners.GitHubRunnersProps.property.allowPublicSubnet">allowPublicSubnet</a></code> | <code>boolean</code> | Allow management functions to run in public subnets. |
3627
3686
  | <code><a href="#@cloudsnorkel/cdk-github-runners.GitHubRunnersProps.property.extraCertificates">extraCertificates</a></code> | <code>string</code> | Path to a directory containing a file named certs.pem containing any additional certificates required to trust GitHub Enterprise Server. Use this when GitHub Enterprise Server certificates are self-signed. |
3628
3687
  | <code><a href="#@cloudsnorkel/cdk-github-runners.GitHubRunnersProps.property.idleTimeout">idleTimeout</a></code> | <code>aws-cdk-lib.Duration</code> | Time to wait before stopping a runner that remains idle. |
3688
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.GitHubRunnersProps.property.logOptions">logOptions</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.LogOptions">LogOptions</a></code> | Logging options for the state machine that manages the runners. |
3629
3689
  | <code><a href="#@cloudsnorkel/cdk-github-runners.GitHubRunnersProps.property.providers">providers</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProvider">IRunnerProvider</a>[]</code> | List of runner providers to use. |
3630
3690
  | <code><a href="#@cloudsnorkel/cdk-github-runners.GitHubRunnersProps.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | Security group attached to all management functions. |
3631
3691
  | <code><a href="#@cloudsnorkel/cdk-github-runners.GitHubRunnersProps.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | VPC used for all management functions. |
@@ -3697,6 +3757,19 @@ If the user cancelled the job, or if another runner stole it, this stops the run
3697
3757
 
3698
3758
  ---
3699
3759
 
3760
+ ##### `logOptions`<sup>Optional</sup> <a name="logOptions" id="@cloudsnorkel/cdk-github-runners.GitHubRunnersProps.property.logOptions"></a>
3761
+
3762
+ ```typescript
3763
+ public readonly logOptions: LogOptions;
3764
+ ```
3765
+
3766
+ - *Type:* <a href="#@cloudsnorkel/cdk-github-runners.LogOptions">LogOptions</a>
3767
+ - *Default:* no logs
3768
+
3769
+ Logging options for the state machine that manages the runners.
3770
+
3771
+ ---
3772
+
3700
3773
  ##### `providers`<sup>Optional</sup> <a name="providers" id="@cloudsnorkel/cdk-github-runners.GitHubRunnersProps.property.providers"></a>
3701
3774
 
3702
3775
  ```typescript
@@ -3902,6 +3975,7 @@ const lambdaRunnerProps: LambdaRunnerProps = { ... }
3902
3975
  | **Name** | **Type** | **Description** |
3903
3976
  | --- | --- | --- |
3904
3977
  | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.logRetention">logRetention</a></code> | <code>aws-cdk-lib.aws_logs.RetentionDays</code> | The number of days log events are kept in CloudWatch Logs. |
3978
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.retryOptions">retryOptions</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.ProviderRetryOptions">ProviderRetryOptions</a></code> | Options to retry operation in case of failure like missing capacity, or API quota issues. |
3905
3979
  | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.ephemeralStorageSize">ephemeralStorageSize</a></code> | <code>aws-cdk-lib.Size</code> | The size of the function’s /tmp directory in MiB. |
3906
3980
  | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.imageBuilder">imageBuilder</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.IImageBuilder">IImageBuilder</a></code> | Provider running an image to run inside CodeBuild with GitHub runner pre-configured. |
3907
3981
  | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.label">label</a></code> | <code>string</code> | GitHub Actions label used for this provider. |
@@ -3932,6 +4006,19 @@ remove the retention policy, set the value to `INFINITE`.
3932
4006
 
3933
4007
  ---
3934
4008
 
4009
+ ##### `retryOptions`<sup>Optional</sup> <a name="retryOptions" id="@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.retryOptions"></a>
4010
+
4011
+ ```typescript
4012
+ public readonly retryOptions: ProviderRetryOptions;
4013
+ ```
4014
+
4015
+ - *Type:* <a href="#@cloudsnorkel/cdk-github-runners.ProviderRetryOptions">ProviderRetryOptions</a>
4016
+ - *Default:* retry 10 times up to about 45 minutes
4017
+
4018
+ Options to retry operation in case of failure like missing capacity, or API quota issues.
4019
+
4020
+ ---
4021
+
3935
4022
  ##### `ephemeralStorageSize`<sup>Optional</sup> <a name="ephemeralStorageSize" id="@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.ephemeralStorageSize"></a>
3936
4023
 
3937
4024
  ```typescript
@@ -4081,6 +4168,165 @@ VPC to launch the runners in.
4081
4168
 
4082
4169
  ---
4083
4170
 
4171
+ ### LogOptions <a name="LogOptions" id="@cloudsnorkel/cdk-github-runners.LogOptions"></a>
4172
+
4173
+ Defines what execution history events are logged and where they are logged.
4174
+
4175
+ #### Initializer <a name="Initializer" id="@cloudsnorkel/cdk-github-runners.LogOptions.Initializer"></a>
4176
+
4177
+ ```typescript
4178
+ import { LogOptions } from '@cloudsnorkel/cdk-github-runners'
4179
+
4180
+ const logOptions: LogOptions = { ... }
4181
+ ```
4182
+
4183
+ #### Properties <a name="Properties" id="Properties"></a>
4184
+
4185
+ | **Name** | **Type** | **Description** |
4186
+ | --- | --- | --- |
4187
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.LogOptions.property.includeExecutionData">includeExecutionData</a></code> | <code>boolean</code> | Determines whether execution data is included in your log. |
4188
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.LogOptions.property.level">level</a></code> | <code>aws-cdk-lib.aws_stepfunctions.LogLevel</code> | Defines which category of execution history events are logged. |
4189
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.LogOptions.property.logGroupName">logGroupName</a></code> | <code>string</code> | The log group where the execution history events will be logged. |
4190
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.LogOptions.property.logRetention">logRetention</a></code> | <code>aws-cdk-lib.aws_logs.RetentionDays</code> | The number of days log events are kept in CloudWatch Logs. |
4191
+
4192
+ ---
4193
+
4194
+ ##### `includeExecutionData`<sup>Optional</sup> <a name="includeExecutionData" id="@cloudsnorkel/cdk-github-runners.LogOptions.property.includeExecutionData"></a>
4195
+
4196
+ ```typescript
4197
+ public readonly includeExecutionData: boolean;
4198
+ ```
4199
+
4200
+ - *Type:* boolean
4201
+ - *Default:* false
4202
+
4203
+ Determines whether execution data is included in your log.
4204
+
4205
+ ---
4206
+
4207
+ ##### `level`<sup>Optional</sup> <a name="level" id="@cloudsnorkel/cdk-github-runners.LogOptions.property.level"></a>
4208
+
4209
+ ```typescript
4210
+ public readonly level: LogLevel;
4211
+ ```
4212
+
4213
+ - *Type:* aws-cdk-lib.aws_stepfunctions.LogLevel
4214
+ - *Default:* ERROR
4215
+
4216
+ Defines which category of execution history events are logged.
4217
+
4218
+ ---
4219
+
4220
+ ##### `logGroupName`<sup>Optional</sup> <a name="logGroupName" id="@cloudsnorkel/cdk-github-runners.LogOptions.property.logGroupName"></a>
4221
+
4222
+ ```typescript
4223
+ public readonly logGroupName: string;
4224
+ ```
4225
+
4226
+ - *Type:* string
4227
+
4228
+ The log group where the execution history events will be logged.
4229
+
4230
+ ---
4231
+
4232
+ ##### `logRetention`<sup>Optional</sup> <a name="logRetention" id="@cloudsnorkel/cdk-github-runners.LogOptions.property.logRetention"></a>
4233
+
4234
+ ```typescript
4235
+ public readonly logRetention: RetentionDays;
4236
+ ```
4237
+
4238
+ - *Type:* aws-cdk-lib.aws_logs.RetentionDays
4239
+ - *Default:* logs.RetentionDays.ONE_MONTH
4240
+
4241
+ The number of days log events are kept in CloudWatch Logs.
4242
+
4243
+ When updating
4244
+ this property, unsetting it doesn't remove the log retention policy. To
4245
+ remove the retention policy, set the value to `INFINITE`.
4246
+
4247
+ ---
4248
+
4249
+ ### ProviderRetryOptions <a name="ProviderRetryOptions" id="@cloudsnorkel/cdk-github-runners.ProviderRetryOptions"></a>
4250
+
4251
+ Retry options for providers.
4252
+
4253
+ The default is to retry 10 times for about 45 minutes with increasing interval.
4254
+
4255
+ #### Initializer <a name="Initializer" id="@cloudsnorkel/cdk-github-runners.ProviderRetryOptions.Initializer"></a>
4256
+
4257
+ ```typescript
4258
+ import { ProviderRetryOptions } from '@cloudsnorkel/cdk-github-runners'
4259
+
4260
+ const providerRetryOptions: ProviderRetryOptions = { ... }
4261
+ ```
4262
+
4263
+ #### Properties <a name="Properties" id="Properties"></a>
4264
+
4265
+ | **Name** | **Type** | **Description** |
4266
+ | --- | --- | --- |
4267
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.ProviderRetryOptions.property.backoffRate">backoffRate</a></code> | <code>number</code> | Multiplication for how much longer the wait interval gets on every retry. |
4268
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.ProviderRetryOptions.property.interval">interval</a></code> | <code>aws-cdk-lib.Duration</code> | How much time to wait after first retryable failure. |
4269
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.ProviderRetryOptions.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | How many times to retry. |
4270
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.ProviderRetryOptions.property.retry">retry</a></code> | <code>boolean</code> | Set to true to retry provider on supported failures. |
4271
+
4272
+ ---
4273
+
4274
+ ##### `backoffRate`<sup>Optional</sup> <a name="backoffRate" id="@cloudsnorkel/cdk-github-runners.ProviderRetryOptions.property.backoffRate"></a>
4275
+
4276
+ ```typescript
4277
+ public readonly backoffRate: number;
4278
+ ```
4279
+
4280
+ - *Type:* number
4281
+ - *Default:* 1.3
4282
+
4283
+ Multiplication for how much longer the wait interval gets on every retry.
4284
+
4285
+ ---
4286
+
4287
+ ##### `interval`<sup>Optional</sup> <a name="interval" id="@cloudsnorkel/cdk-github-runners.ProviderRetryOptions.property.interval"></a>
4288
+
4289
+ ```typescript
4290
+ public readonly interval: Duration;
4291
+ ```
4292
+
4293
+ - *Type:* aws-cdk-lib.Duration
4294
+ - *Default:* 1 minute
4295
+
4296
+ How much time to wait after first retryable failure.
4297
+
4298
+ This interval will be multiplied by {@link backoffRate} each retry.
4299
+
4300
+ ---
4301
+
4302
+ ##### `maxAttempts`<sup>Optional</sup> <a name="maxAttempts" id="@cloudsnorkel/cdk-github-runners.ProviderRetryOptions.property.maxAttempts"></a>
4303
+
4304
+ ```typescript
4305
+ public readonly maxAttempts: number;
4306
+ ```
4307
+
4308
+ - *Type:* number
4309
+ - *Default:* 10
4310
+
4311
+ How many times to retry.
4312
+
4313
+ ---
4314
+
4315
+ ##### `retry`<sup>Optional</sup> <a name="retry" id="@cloudsnorkel/cdk-github-runners.ProviderRetryOptions.property.retry"></a>
4316
+
4317
+ ```typescript
4318
+ public readonly retry: boolean;
4319
+ ```
4320
+
4321
+ - *Type:* boolean
4322
+ - *Default:* true
4323
+
4324
+ Set to true to retry provider on supported failures.
4325
+
4326
+ Which failures generate a retry depends on the specific provider.
4327
+
4328
+ ---
4329
+
4084
4330
  ### RunnerAmi <a name="RunnerAmi" id="@cloudsnorkel/cdk-github-runners.RunnerAmi"></a>
4085
4331
 
4086
4332
  Description of a AMI built by {@link IAmiBuilder}.
@@ -4279,6 +4525,7 @@ const runnerProviderProps: RunnerProviderProps = { ... }
4279
4525
  | **Name** | **Type** | **Description** |
4280
4526
  | --- | --- | --- |
4281
4527
  | <code><a href="#@cloudsnorkel/cdk-github-runners.RunnerProviderProps.property.logRetention">logRetention</a></code> | <code>aws-cdk-lib.aws_logs.RetentionDays</code> | The number of days log events are kept in CloudWatch Logs. |
4528
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.RunnerProviderProps.property.retryOptions">retryOptions</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.ProviderRetryOptions">ProviderRetryOptions</a></code> | Options to retry operation in case of failure like missing capacity, or API quota issues. |
4282
4529
 
4283
4530
  ---
4284
4531
 
@@ -4299,6 +4546,19 @@ remove the retention policy, set the value to `INFINITE`.
4299
4546
 
4300
4547
  ---
4301
4548
 
4549
+ ##### `retryOptions`<sup>Optional</sup> <a name="retryOptions" id="@cloudsnorkel/cdk-github-runners.RunnerProviderProps.property.retryOptions"></a>
4550
+
4551
+ ```typescript
4552
+ public readonly retryOptions: ProviderRetryOptions;
4553
+ ```
4554
+
4555
+ - *Type:* <a href="#@cloudsnorkel/cdk-github-runners.ProviderRetryOptions">ProviderRetryOptions</a>
4556
+ - *Default:* retry 10 times up to about 45 minutes
4557
+
4558
+ Options to retry operation in case of failure like missing capacity, or API quota issues.
4559
+
4560
+ ---
4561
+
4302
4562
  ### RunnerRuntimeParameters <a name="RunnerRuntimeParameters" id="@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters"></a>
4303
4563
 
4304
4564
  Workflow job parameters as parsed from the webhook event. Pass these into your runner executor and run something like:.
@@ -21,6 +21,10 @@ var __copyProps = (to, from, except, desc) => {
21
21
  return to;
22
22
  };
23
23
  var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
24
+ // If the importer is in node compatibility mode or this is not an ESM
25
+ // file that has been converted to a CommonJS file using a Babel-
26
+ // compatible transform (i.e. "__esModule" has not been set), then set
27
+ // "default" to the CommonJS "module.exports" for node compatibility.
24
28
  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
25
29
  mod
26
30
  ));
@@ -31,7 +35,8 @@ var require_constants = __commonJS({
31
35
  "node_modules/semver/internal/constants.js"(exports, module2) {
32
36
  var SEMVER_SPEC_VERSION = "2.0.0";
33
37
  var MAX_LENGTH = 256;
34
- var MAX_SAFE_INTEGER = Number.MAX_SAFE_INTEGER || 9007199254740991;
38
+ var MAX_SAFE_INTEGER = Number.MAX_SAFE_INTEGER || /* istanbul ignore next */
39
+ 9007199254740991;
35
40
  var MAX_SAFE_COMPONENT_LENGTH = 16;
36
41
  module2.exports = {
37
42
  SEMVER_SPEC_VERSION,
@@ -289,6 +294,8 @@ var require_semver = __commonJS({
289
294
  }
290
295
  } while (++i);
291
296
  }
297
+ // preminor will bump the version up to the next minor release, and immediately
298
+ // down to pre-release. premajor and prepatch work the same way.
292
299
  inc(release, identifier) {
293
300
  switch (release) {
294
301
  case "premajor":
@@ -1137,6 +1144,7 @@ var require_lru_cache = __commonJS({
1137
1144
  this[UPDATE_AGE_ON_GET] = options.updateAgeOnGet || false;
1138
1145
  this.reset();
1139
1146
  }
1147
+ // resize the cache when the max changes.
1140
1148
  set max(mL) {
1141
1149
  if (typeof mL !== "number" || mL < 0)
1142
1150
  throw new TypeError("max must be a non-negative number");
@@ -1161,6 +1169,7 @@ var require_lru_cache = __commonJS({
1161
1169
  get maxAge() {
1162
1170
  return this[MAX_AGE];
1163
1171
  }
1172
+ // resize the cache when the lengthCalculator changes.
1164
1173
  set lengthCalculator(lC) {
1165
1174
  if (typeof lC !== "function")
1166
1175
  lC = naiveLength;
@@ -1475,6 +1484,7 @@ var require_range = __commonJS({
1475
1484
  });
1476
1485
  });
1477
1486
  }
1487
+ // if ANY of the sets match ALL of its comparators, then pass
1478
1488
  test(version) {
1479
1489
  if (!version) {
1480
1490
  return false;
@@ -18,6 +18,10 @@ var __copyProps = (to, from, except, desc) => {
18
18
  return to;
19
19
  };
20
20
  var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
21
+ // If the importer is in node compatibility mode or this is not an ESM
22
+ // file that has been converted to a CommonJS file using a Babel-
23
+ // compatible transform (i.e. "__esModule" has not been set), then set
24
+ // "default" to the CommonJS "module.exports" for node compatibility.
21
25
  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
22
26
  mod
23
27
  ));
@@ -14,6 +14,10 @@ var __copyProps = (to, from, except, desc) => {
14
14
  return to;
15
15
  };
16
16
  var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
17
+ // If the importer is in node compatibility mode or this is not an ESM
18
+ // file that has been converted to a CommonJS file using a Babel-
19
+ // compatible transform (i.e. "__esModule" has not been set), then set
20
+ // "default" to the CommonJS "module.exports" for node compatibility.
17
21
  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
18
22
  mod
19
23
  ));