@cloudsnorkel/cdk-github-runners 0.14.13 → 0.14.15
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/.jsii +123 -104
- package/API.md +328 -8
- package/assets/providers/lambda-runner.sh +2 -1
- package/assets/setup.lambda/index.html +7 -7
- package/lib/access.js +1 -1
- package/lib/image-builders/api.js +1 -1
- package/lib/image-builders/aws-image-builder/builder.js +3 -3
- package/lib/image-builders/aws-image-builder/deprecated/ami.js +1 -1
- package/lib/image-builders/aws-image-builder/deprecated/container.js +1 -1
- package/lib/image-builders/aws-image-builder/deprecated/linux-components.js +1 -1
- package/lib/image-builders/aws-image-builder/deprecated/windows-components.js +1 -1
- package/lib/image-builders/codebuild-deprecated.js +1 -1
- package/lib/image-builders/components.js +8 -6
- package/lib/image-builders/static.js +1 -1
- package/lib/providers/codebuild.d.ts +1 -0
- package/lib/providers/codebuild.js +12 -5
- package/lib/providers/common.d.ts +6 -0
- package/lib/providers/common.js +4 -4
- package/lib/providers/ec2.d.ts +1 -0
- package/lib/providers/ec2.js +16 -8
- package/lib/providers/ecs.d.ts +4 -0
- package/lib/providers/ecs.js +7 -2
- package/lib/providers/fargate.d.ts +1 -0
- package/lib/providers/fargate.js +10 -5
- package/lib/providers/lambda.d.ts +1 -0
- package/lib/providers/lambda.js +5 -3
- package/lib/runner.js +1 -1
- package/lib/secrets.js +1 -1
- package/package.json +16 -16
package/API.md
CHANGED
|
@@ -178,6 +178,20 @@ AmiBuilder.isConstruct(x: any)
|
|
|
178
178
|
|
|
179
179
|
Checks if `x` is a construct.
|
|
180
180
|
|
|
181
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
182
|
+
instances, even when the construct library is symlinked.
|
|
183
|
+
|
|
184
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
185
|
+
disk are seen as independent, completely different libraries. As a
|
|
186
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
187
|
+
is seen as a different class, and an instance of one class will not test as
|
|
188
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
189
|
+
like this, but users may manually symlink construct libraries together or
|
|
190
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
191
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
192
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
193
|
+
this type-testing method instead.
|
|
194
|
+
|
|
181
195
|
###### `x`<sup>Required</sup> <a name="x" id="@cloudsnorkel/cdk-github-runners.AmiBuilder.isConstruct.parameter.x"></a>
|
|
182
196
|
|
|
183
197
|
- *Type:* any
|
|
@@ -463,6 +477,20 @@ CodeBuildImageBuilder.isConstruct(x: any)
|
|
|
463
477
|
|
|
464
478
|
Checks if `x` is a construct.
|
|
465
479
|
|
|
480
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
481
|
+
instances, even when the construct library is symlinked.
|
|
482
|
+
|
|
483
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
484
|
+
disk are seen as independent, completely different libraries. As a
|
|
485
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
486
|
+
is seen as a different class, and an instance of one class will not test as
|
|
487
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
488
|
+
like this, but users may manually symlink construct libraries together or
|
|
489
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
490
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
491
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
492
|
+
this type-testing method instead.
|
|
493
|
+
|
|
466
494
|
###### `x`<sup>Required</sup> <a name="x" id="@cloudsnorkel/cdk-github-runners.CodeBuildImageBuilder.isConstruct.parameter.x"></a>
|
|
467
495
|
|
|
468
496
|
- *Type:* any
|
|
@@ -645,6 +673,20 @@ CodeBuildRunner.isConstruct(x: any)
|
|
|
645
673
|
|
|
646
674
|
Checks if `x` is a construct.
|
|
647
675
|
|
|
676
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
677
|
+
instances, even when the construct library is symlinked.
|
|
678
|
+
|
|
679
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
680
|
+
disk are seen as independent, completely different libraries. As a
|
|
681
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
682
|
+
is seen as a different class, and an instance of one class will not test as
|
|
683
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
684
|
+
like this, but users may manually symlink construct libraries together or
|
|
685
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
686
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
687
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
688
|
+
this type-testing method instead.
|
|
689
|
+
|
|
648
690
|
###### `x`<sup>Required</sup> <a name="x" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunner.isConstruct.parameter.x"></a>
|
|
649
691
|
|
|
650
692
|
- *Type:* any
|
|
@@ -1007,7 +1049,7 @@ Also gives the status function any needed permissions to query the Docker image
|
|
|
1007
1049
|
|
|
1008
1050
|
---
|
|
1009
1051
|
|
|
1010
|
-
#####
|
|
1052
|
+
##### `isConstruct` <a name="isConstruct" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProvider.isConstruct"></a>
|
|
1011
1053
|
|
|
1012
1054
|
```typescript
|
|
1013
1055
|
import { CodeBuildRunnerProvider } from '@cloudsnorkel/cdk-github-runners'
|
|
@@ -1017,6 +1059,20 @@ CodeBuildRunnerProvider.isConstruct(x: any)
|
|
|
1017
1059
|
|
|
1018
1060
|
Checks if `x` is a construct.
|
|
1019
1061
|
|
|
1062
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
1063
|
+
instances, even when the construct library is symlinked.
|
|
1064
|
+
|
|
1065
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
1066
|
+
disk are seen as independent, completely different libraries. As a
|
|
1067
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
1068
|
+
is seen as a different class, and an instance of one class will not test as
|
|
1069
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
1070
|
+
like this, but users may manually symlink construct libraries together or
|
|
1071
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
1072
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
1073
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
1074
|
+
this type-testing method instead.
|
|
1075
|
+
|
|
1020
1076
|
###### `x`<sup>Required</sup> <a name="x" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProvider.isConstruct.parameter.x"></a>
|
|
1021
1077
|
|
|
1022
1078
|
- *Type:* any
|
|
@@ -1408,6 +1464,20 @@ ContainerImageBuilder.isConstruct(x: any)
|
|
|
1408
1464
|
|
|
1409
1465
|
Checks if `x` is a construct.
|
|
1410
1466
|
|
|
1467
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
1468
|
+
instances, even when the construct library is symlinked.
|
|
1469
|
+
|
|
1470
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
1471
|
+
disk are seen as independent, completely different libraries. As a
|
|
1472
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
1473
|
+
is seen as a different class, and an instance of one class will not test as
|
|
1474
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
1475
|
+
like this, but users may manually symlink construct libraries together or
|
|
1476
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
1477
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
1478
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
1479
|
+
this type-testing method instead.
|
|
1480
|
+
|
|
1411
1481
|
###### `x`<sup>Required</sup> <a name="x" id="@cloudsnorkel/cdk-github-runners.ContainerImageBuilder.isConstruct.parameter.x"></a>
|
|
1412
1482
|
|
|
1413
1483
|
- *Type:* any
|
|
@@ -1592,6 +1662,20 @@ Ec2Runner.isConstruct(x: any)
|
|
|
1592
1662
|
|
|
1593
1663
|
Checks if `x` is a construct.
|
|
1594
1664
|
|
|
1665
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
1666
|
+
instances, even when the construct library is symlinked.
|
|
1667
|
+
|
|
1668
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
1669
|
+
disk are seen as independent, completely different libraries. As a
|
|
1670
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
1671
|
+
is seen as a different class, and an instance of one class will not test as
|
|
1672
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
1673
|
+
like this, but users may manually symlink construct libraries together or
|
|
1674
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
1675
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
1676
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
1677
|
+
this type-testing method instead.
|
|
1678
|
+
|
|
1595
1679
|
###### `x`<sup>Required</sup> <a name="x" id="@cloudsnorkel/cdk-github-runners.Ec2Runner.isConstruct.parameter.x"></a>
|
|
1596
1680
|
|
|
1597
1681
|
- *Type:* any
|
|
@@ -1865,7 +1949,7 @@ Also gives the status function any needed permissions to query the Docker image
|
|
|
1865
1949
|
|
|
1866
1950
|
---
|
|
1867
1951
|
|
|
1868
|
-
#####
|
|
1952
|
+
##### `isConstruct` <a name="isConstruct" id="@cloudsnorkel/cdk-github-runners.Ec2RunnerProvider.isConstruct"></a>
|
|
1869
1953
|
|
|
1870
1954
|
```typescript
|
|
1871
1955
|
import { Ec2RunnerProvider } from '@cloudsnorkel/cdk-github-runners'
|
|
@@ -1875,6 +1959,20 @@ Ec2RunnerProvider.isConstruct(x: any)
|
|
|
1875
1959
|
|
|
1876
1960
|
Checks if `x` is a construct.
|
|
1877
1961
|
|
|
1962
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
1963
|
+
instances, even when the construct library is symlinked.
|
|
1964
|
+
|
|
1965
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
1966
|
+
disk are seen as independent, completely different libraries. As a
|
|
1967
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
1968
|
+
is seen as a different class, and an instance of one class will not test as
|
|
1969
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
1970
|
+
like this, but users may manually symlink construct libraries together or
|
|
1971
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
1972
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
1973
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
1974
|
+
this type-testing method instead.
|
|
1975
|
+
|
|
1878
1976
|
###### `x`<sup>Required</sup> <a name="x" id="@cloudsnorkel/cdk-github-runners.Ec2RunnerProvider.isConstruct.parameter.x"></a>
|
|
1879
1977
|
|
|
1880
1978
|
- *Type:* any
|
|
@@ -2140,7 +2238,7 @@ Also gives the status function any needed permissions to query the Docker image
|
|
|
2140
2238
|
|
|
2141
2239
|
---
|
|
2142
2240
|
|
|
2143
|
-
#####
|
|
2241
|
+
##### `isConstruct` <a name="isConstruct" id="@cloudsnorkel/cdk-github-runners.EcsRunnerProvider.isConstruct"></a>
|
|
2144
2242
|
|
|
2145
2243
|
```typescript
|
|
2146
2244
|
import { EcsRunnerProvider } from '@cloudsnorkel/cdk-github-runners'
|
|
@@ -2150,6 +2248,20 @@ EcsRunnerProvider.isConstruct(x: any)
|
|
|
2150
2248
|
|
|
2151
2249
|
Checks if `x` is a construct.
|
|
2152
2250
|
|
|
2251
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
2252
|
+
instances, even when the construct library is symlinked.
|
|
2253
|
+
|
|
2254
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
2255
|
+
disk are seen as independent, completely different libraries. As a
|
|
2256
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
2257
|
+
is seen as a different class, and an instance of one class will not test as
|
|
2258
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
2259
|
+
like this, but users may manually symlink construct libraries together or
|
|
2260
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
2261
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
2262
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
2263
|
+
this type-testing method instead.
|
|
2264
|
+
|
|
2153
2265
|
###### `x`<sup>Required</sup> <a name="x" id="@cloudsnorkel/cdk-github-runners.EcsRunnerProvider.isConstruct.parameter.x"></a>
|
|
2154
2266
|
|
|
2155
2267
|
- *Type:* any
|
|
@@ -2414,6 +2526,20 @@ FargateRunner.isConstruct(x: any)
|
|
|
2414
2526
|
|
|
2415
2527
|
Checks if `x` is a construct.
|
|
2416
2528
|
|
|
2529
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
2530
|
+
instances, even when the construct library is symlinked.
|
|
2531
|
+
|
|
2532
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
2533
|
+
disk are seen as independent, completely different libraries. As a
|
|
2534
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
2535
|
+
is seen as a different class, and an instance of one class will not test as
|
|
2536
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
2537
|
+
like this, but users may manually symlink construct libraries together or
|
|
2538
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
2539
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
2540
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
2541
|
+
this type-testing method instead.
|
|
2542
|
+
|
|
2417
2543
|
###### `x`<sup>Required</sup> <a name="x" id="@cloudsnorkel/cdk-github-runners.FargateRunner.isConstruct.parameter.x"></a>
|
|
2418
2544
|
|
|
2419
2545
|
- *Type:* any
|
|
@@ -2857,7 +2983,7 @@ Also gives the status function any needed permissions to query the Docker image
|
|
|
2857
2983
|
|
|
2858
2984
|
---
|
|
2859
2985
|
|
|
2860
|
-
#####
|
|
2986
|
+
##### `isConstruct` <a name="isConstruct" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.isConstruct"></a>
|
|
2861
2987
|
|
|
2862
2988
|
```typescript
|
|
2863
2989
|
import { FargateRunnerProvider } from '@cloudsnorkel/cdk-github-runners'
|
|
@@ -2867,6 +2993,20 @@ FargateRunnerProvider.isConstruct(x: any)
|
|
|
2867
2993
|
|
|
2868
2994
|
Checks if `x` is a construct.
|
|
2869
2995
|
|
|
2996
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
2997
|
+
instances, even when the construct library is symlinked.
|
|
2998
|
+
|
|
2999
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
3000
|
+
disk are seen as independent, completely different libraries. As a
|
|
3001
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
3002
|
+
is seen as a different class, and an instance of one class will not test as
|
|
3003
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
3004
|
+
like this, but users may manually symlink construct libraries together or
|
|
3005
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
3006
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
3007
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
3008
|
+
this type-testing method instead.
|
|
3009
|
+
|
|
2870
3010
|
###### `x`<sup>Required</sup> <a name="x" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.isConstruct.parameter.x"></a>
|
|
2871
3011
|
|
|
2872
3012
|
- *Type:* any
|
|
@@ -3361,7 +3501,7 @@ This time may be longer than the time the runner took.
|
|
|
3361
3501
|
|
|
3362
3502
|
---
|
|
3363
3503
|
|
|
3364
|
-
#####
|
|
3504
|
+
##### `isConstruct` <a name="isConstruct" id="@cloudsnorkel/cdk-github-runners.GitHubRunners.isConstruct"></a>
|
|
3365
3505
|
|
|
3366
3506
|
```typescript
|
|
3367
3507
|
import { GitHubRunners } from '@cloudsnorkel/cdk-github-runners'
|
|
@@ -3371,6 +3511,20 @@ GitHubRunners.isConstruct(x: any)
|
|
|
3371
3511
|
|
|
3372
3512
|
Checks if `x` is a construct.
|
|
3373
3513
|
|
|
3514
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
3515
|
+
instances, even when the construct library is symlinked.
|
|
3516
|
+
|
|
3517
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
3518
|
+
disk are seen as independent, completely different libraries. As a
|
|
3519
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
3520
|
+
is seen as a different class, and an instance of one class will not test as
|
|
3521
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
3522
|
+
like this, but users may manually symlink construct libraries together or
|
|
3523
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
3524
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
3525
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
3526
|
+
this type-testing method instead.
|
|
3527
|
+
|
|
3374
3528
|
###### `x`<sup>Required</sup> <a name="x" id="@cloudsnorkel/cdk-github-runners.GitHubRunners.isConstruct.parameter.x"></a>
|
|
3375
3529
|
|
|
3376
3530
|
- *Type:* any
|
|
@@ -3601,6 +3755,20 @@ ImageBuilderComponent.isConstruct(x: any)
|
|
|
3601
3755
|
|
|
3602
3756
|
Checks if `x` is a construct.
|
|
3603
3757
|
|
|
3758
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
3759
|
+
instances, even when the construct library is symlinked.
|
|
3760
|
+
|
|
3761
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
3762
|
+
disk are seen as independent, completely different libraries. As a
|
|
3763
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
3764
|
+
is seen as a different class, and an instance of one class will not test as
|
|
3765
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
3766
|
+
like this, but users may manually symlink construct libraries together or
|
|
3767
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
3768
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
3769
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
3770
|
+
this type-testing method instead.
|
|
3771
|
+
|
|
3604
3772
|
###### `x`<sup>Required</sup> <a name="x" id="@cloudsnorkel/cdk-github-runners.ImageBuilderComponent.isConstruct.parameter.x"></a>
|
|
3605
3773
|
|
|
3606
3774
|
- *Type:* any
|
|
@@ -3856,6 +4024,20 @@ LambdaRunner.isConstruct(x: any)
|
|
|
3856
4024
|
|
|
3857
4025
|
Checks if `x` is a construct.
|
|
3858
4026
|
|
|
4027
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
4028
|
+
instances, even when the construct library is symlinked.
|
|
4029
|
+
|
|
4030
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
4031
|
+
disk are seen as independent, completely different libraries. As a
|
|
4032
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
4033
|
+
is seen as a different class, and an instance of one class will not test as
|
|
4034
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
4035
|
+
like this, but users may manually symlink construct libraries together or
|
|
4036
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
4037
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
4038
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
4039
|
+
this type-testing method instead.
|
|
4040
|
+
|
|
3859
4041
|
###### `x`<sup>Required</sup> <a name="x" id="@cloudsnorkel/cdk-github-runners.LambdaRunner.isConstruct.parameter.x"></a>
|
|
3860
4042
|
|
|
3861
4043
|
- *Type:* any
|
|
@@ -4210,7 +4392,7 @@ Also gives the status function any needed permissions to query the Docker image
|
|
|
4210
4392
|
|
|
4211
4393
|
---
|
|
4212
4394
|
|
|
4213
|
-
#####
|
|
4395
|
+
##### `isConstruct` <a name="isConstruct" id="@cloudsnorkel/cdk-github-runners.LambdaRunnerProvider.isConstruct"></a>
|
|
4214
4396
|
|
|
4215
4397
|
```typescript
|
|
4216
4398
|
import { LambdaRunnerProvider } from '@cloudsnorkel/cdk-github-runners'
|
|
@@ -4220,6 +4402,20 @@ LambdaRunnerProvider.isConstruct(x: any)
|
|
|
4220
4402
|
|
|
4221
4403
|
Checks if `x` is a construct.
|
|
4222
4404
|
|
|
4405
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
4406
|
+
instances, even when the construct library is symlinked.
|
|
4407
|
+
|
|
4408
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
4409
|
+
disk are seen as independent, completely different libraries. As a
|
|
4410
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
4411
|
+
is seen as a different class, and an instance of one class will not test as
|
|
4412
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
4413
|
+
like this, but users may manually symlink construct libraries together or
|
|
4414
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
4415
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
4416
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
4417
|
+
this type-testing method instead.
|
|
4418
|
+
|
|
4223
4419
|
###### `x`<sup>Required</sup> <a name="x" id="@cloudsnorkel/cdk-github-runners.LambdaRunnerProvider.isConstruct.parameter.x"></a>
|
|
4224
4420
|
|
|
4225
4421
|
- *Type:* any
|
|
@@ -4566,7 +4762,7 @@ Removal is done by component name. Multiple components with the same name will a
|
|
|
4566
4762
|
|
|
4567
4763
|
---
|
|
4568
4764
|
|
|
4569
|
-
#####
|
|
4765
|
+
##### `isConstruct` <a name="isConstruct" id="@cloudsnorkel/cdk-github-runners.RunnerImageBuilder.isConstruct"></a>
|
|
4570
4766
|
|
|
4571
4767
|
```typescript
|
|
4572
4768
|
import { RunnerImageBuilder } from '@cloudsnorkel/cdk-github-runners'
|
|
@@ -4576,6 +4772,20 @@ RunnerImageBuilder.isConstruct(x: any)
|
|
|
4576
4772
|
|
|
4577
4773
|
Checks if `x` is a construct.
|
|
4578
4774
|
|
|
4775
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
4776
|
+
instances, even when the construct library is symlinked.
|
|
4777
|
+
|
|
4778
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
4779
|
+
disk are seen as independent, completely different libraries. As a
|
|
4780
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
4781
|
+
is seen as a different class, and an instance of one class will not test as
|
|
4782
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
4783
|
+
like this, but users may manually symlink construct libraries together or
|
|
4784
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
4785
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
4786
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
4787
|
+
this type-testing method instead.
|
|
4788
|
+
|
|
4579
4789
|
###### `x`<sup>Required</sup> <a name="x" id="@cloudsnorkel/cdk-github-runners.RunnerImageBuilder.isConstruct.parameter.x"></a>
|
|
4580
4790
|
|
|
4581
4791
|
- *Type:* any
|
|
@@ -4716,7 +4926,7 @@ Returns a string representation of this construct.
|
|
|
4716
4926
|
|
|
4717
4927
|
---
|
|
4718
4928
|
|
|
4719
|
-
#####
|
|
4929
|
+
##### `isConstruct` <a name="isConstruct" id="@cloudsnorkel/cdk-github-runners.Secrets.isConstruct"></a>
|
|
4720
4930
|
|
|
4721
4931
|
```typescript
|
|
4722
4932
|
import { Secrets } from '@cloudsnorkel/cdk-github-runners'
|
|
@@ -4726,6 +4936,20 @@ Secrets.isConstruct(x: any)
|
|
|
4726
4936
|
|
|
4727
4937
|
Checks if `x` is a construct.
|
|
4728
4938
|
|
|
4939
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
4940
|
+
instances, even when the construct library is symlinked.
|
|
4941
|
+
|
|
4942
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
4943
|
+
disk are seen as independent, completely different libraries. As a
|
|
4944
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
4945
|
+
is seen as a different class, and an instance of one class will not test as
|
|
4946
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
4947
|
+
like this, but users may manually symlink construct libraries together or
|
|
4948
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
4949
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
4950
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
4951
|
+
this type-testing method instead.
|
|
4952
|
+
|
|
4729
4953
|
###### `x`<sup>Required</sup> <a name="x" id="@cloudsnorkel/cdk-github-runners.Secrets.isConstruct.parameter.x"></a>
|
|
4730
4954
|
|
|
4731
4955
|
- *Type:* any
|
|
@@ -5470,6 +5694,7 @@ const codeBuildRunnerProviderProps: CodeBuildRunnerProviderProps = { ... }
|
|
|
5470
5694
|
|
|
5471
5695
|
| **Name** | **Type** | **Description** |
|
|
5472
5696
|
| --- | --- | --- |
|
|
5697
|
+
| <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProviderProps.property.defaultLabels">defaultLabels</a></code> | <code>boolean</code> | Add default labels based on OS and architecture of the runner. |
|
|
5473
5698
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProviderProps.property.logRetention">logRetention</a></code> | <code>aws-cdk-lib.aws_logs.RetentionDays</code> | The number of days log events are kept in CloudWatch Logs. |
|
|
5474
5699
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProviderProps.property.retryOptions">retryOptions</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.ProviderRetryOptions">ProviderRetryOptions</a></code> | *No description.* |
|
|
5475
5700
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProviderProps.property.computeType">computeType</a></code> | <code>aws-cdk-lib.aws_codebuild.ComputeType</code> | The type of compute to use for this build. |
|
|
@@ -5486,6 +5711,21 @@ const codeBuildRunnerProviderProps: CodeBuildRunnerProviderProps = { ... }
|
|
|
5486
5711
|
|
|
5487
5712
|
---
|
|
5488
5713
|
|
|
5714
|
+
##### `defaultLabels`<sup>Optional</sup> <a name="defaultLabels" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProviderProps.property.defaultLabels"></a>
|
|
5715
|
+
|
|
5716
|
+
```typescript
|
|
5717
|
+
public readonly defaultLabels: boolean;
|
|
5718
|
+
```
|
|
5719
|
+
|
|
5720
|
+
- *Type:* boolean
|
|
5721
|
+
- *Default:* true
|
|
5722
|
+
|
|
5723
|
+
Add default labels based on OS and architecture of the runner.
|
|
5724
|
+
|
|
5725
|
+
This will tell GitHub Runner to add default labels like `self-hosted`, `linux`, `x64`, and `arm64`.
|
|
5726
|
+
|
|
5727
|
+
---
|
|
5728
|
+
|
|
5489
5729
|
##### `logRetention`<sup>Optional</sup> <a name="logRetention" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProviderProps.property.logRetention"></a>
|
|
5490
5730
|
|
|
5491
5731
|
```typescript
|
|
@@ -5904,6 +6144,7 @@ const ec2RunnerProviderProps: Ec2RunnerProviderProps = { ... }
|
|
|
5904
6144
|
|
|
5905
6145
|
| **Name** | **Type** | **Description** |
|
|
5906
6146
|
| --- | --- | --- |
|
|
6147
|
+
| <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProviderProps.property.defaultLabels">defaultLabels</a></code> | <code>boolean</code> | Add default labels based on OS and architecture of the runner. |
|
|
5907
6148
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProviderProps.property.logRetention">logRetention</a></code> | <code>aws-cdk-lib.aws_logs.RetentionDays</code> | The number of days log events are kept in CloudWatch Logs. |
|
|
5908
6149
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProviderProps.property.retryOptions">retryOptions</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.ProviderRetryOptions">ProviderRetryOptions</a></code> | *No description.* |
|
|
5909
6150
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProviderProps.property.amiBuilder">amiBuilder</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerImageBuilder">IRunnerImageBuilder</a></code> | *No description.* |
|
|
@@ -5923,6 +6164,21 @@ const ec2RunnerProviderProps: Ec2RunnerProviderProps = { ... }
|
|
|
5923
6164
|
|
|
5924
6165
|
---
|
|
5925
6166
|
|
|
6167
|
+
##### `defaultLabels`<sup>Optional</sup> <a name="defaultLabels" id="@cloudsnorkel/cdk-github-runners.Ec2RunnerProviderProps.property.defaultLabels"></a>
|
|
6168
|
+
|
|
6169
|
+
```typescript
|
|
6170
|
+
public readonly defaultLabels: boolean;
|
|
6171
|
+
```
|
|
6172
|
+
|
|
6173
|
+
- *Type:* boolean
|
|
6174
|
+
- *Default:* true
|
|
6175
|
+
|
|
6176
|
+
Add default labels based on OS and architecture of the runner.
|
|
6177
|
+
|
|
6178
|
+
This will tell GitHub Runner to add default labels like `self-hosted`, `linux`, `x64`, and `arm64`.
|
|
6179
|
+
|
|
6180
|
+
---
|
|
6181
|
+
|
|
5926
6182
|
##### `logRetention`<sup>Optional</sup> <a name="logRetention" id="@cloudsnorkel/cdk-github-runners.Ec2RunnerProviderProps.property.logRetention"></a>
|
|
5927
6183
|
|
|
5928
6184
|
```typescript
|
|
@@ -6171,6 +6427,7 @@ const ecsRunnerProviderProps: EcsRunnerProviderProps = { ... }
|
|
|
6171
6427
|
|
|
6172
6428
|
| **Name** | **Type** | **Description** |
|
|
6173
6429
|
| --- | --- | --- |
|
|
6430
|
+
| <code><a href="#@cloudsnorkel/cdk-github-runners.EcsRunnerProviderProps.property.defaultLabels">defaultLabels</a></code> | <code>boolean</code> | Add default labels based on OS and architecture of the runner. |
|
|
6174
6431
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.EcsRunnerProviderProps.property.logRetention">logRetention</a></code> | <code>aws-cdk-lib.aws_logs.RetentionDays</code> | The number of days log events are kept in CloudWatch Logs. |
|
|
6175
6432
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.EcsRunnerProviderProps.property.retryOptions">retryOptions</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.ProviderRetryOptions">ProviderRetryOptions</a></code> | *No description.* |
|
|
6176
6433
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.EcsRunnerProviderProps.property.assignPublicIp">assignPublicIp</a></code> | <code>boolean</code> | Assign public IP to the runner task. |
|
|
@@ -6198,6 +6455,21 @@ const ecsRunnerProviderProps: EcsRunnerProviderProps = { ... }
|
|
|
6198
6455
|
|
|
6199
6456
|
---
|
|
6200
6457
|
|
|
6458
|
+
##### `defaultLabels`<sup>Optional</sup> <a name="defaultLabels" id="@cloudsnorkel/cdk-github-runners.EcsRunnerProviderProps.property.defaultLabels"></a>
|
|
6459
|
+
|
|
6460
|
+
```typescript
|
|
6461
|
+
public readonly defaultLabels: boolean;
|
|
6462
|
+
```
|
|
6463
|
+
|
|
6464
|
+
- *Type:* boolean
|
|
6465
|
+
- *Default:* true
|
|
6466
|
+
|
|
6467
|
+
Add default labels based on OS and architecture of the runner.
|
|
6468
|
+
|
|
6469
|
+
This will tell GitHub Runner to add default labels like `self-hosted`, `linux`, `x64`, and `arm64`.
|
|
6470
|
+
|
|
6471
|
+
---
|
|
6472
|
+
|
|
6201
6473
|
##### `logRetention`<sup>Optional</sup> <a name="logRetention" id="@cloudsnorkel/cdk-github-runners.EcsRunnerProviderProps.property.logRetention"></a>
|
|
6202
6474
|
|
|
6203
6475
|
```typescript
|
|
@@ -6563,6 +6835,7 @@ const fargateRunnerProviderProps: FargateRunnerProviderProps = { ... }
|
|
|
6563
6835
|
|
|
6564
6836
|
| **Name** | **Type** | **Description** |
|
|
6565
6837
|
| --- | --- | --- |
|
|
6838
|
+
| <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProviderProps.property.defaultLabels">defaultLabels</a></code> | <code>boolean</code> | Add default labels based on OS and architecture of the runner. |
|
|
6566
6839
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProviderProps.property.logRetention">logRetention</a></code> | <code>aws-cdk-lib.aws_logs.RetentionDays</code> | The number of days log events are kept in CloudWatch Logs. |
|
|
6567
6840
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProviderProps.property.retryOptions">retryOptions</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.ProviderRetryOptions">ProviderRetryOptions</a></code> | *No description.* |
|
|
6568
6841
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProviderProps.property.assignPublicIp">assignPublicIp</a></code> | <code>boolean</code> | Assign public IP to the runner task. |
|
|
@@ -6582,6 +6855,21 @@ const fargateRunnerProviderProps: FargateRunnerProviderProps = { ... }
|
|
|
6582
6855
|
|
|
6583
6856
|
---
|
|
6584
6857
|
|
|
6858
|
+
##### `defaultLabels`<sup>Optional</sup> <a name="defaultLabels" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProviderProps.property.defaultLabels"></a>
|
|
6859
|
+
|
|
6860
|
+
```typescript
|
|
6861
|
+
public readonly defaultLabels: boolean;
|
|
6862
|
+
```
|
|
6863
|
+
|
|
6864
|
+
- *Type:* boolean
|
|
6865
|
+
- *Default:* true
|
|
6866
|
+
|
|
6867
|
+
Add default labels based on OS and architecture of the runner.
|
|
6868
|
+
|
|
6869
|
+
This will tell GitHub Runner to add default labels like `self-hosted`, `linux`, `x64`, and `arm64`.
|
|
6870
|
+
|
|
6871
|
+
---
|
|
6872
|
+
|
|
6585
6873
|
##### `logRetention`<sup>Optional</sup> <a name="logRetention" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProviderProps.property.logRetention"></a>
|
|
6586
6874
|
|
|
6587
6875
|
```typescript
|
|
@@ -7345,6 +7633,7 @@ const lambdaRunnerProviderProps: LambdaRunnerProviderProps = { ... }
|
|
|
7345
7633
|
|
|
7346
7634
|
| **Name** | **Type** | **Description** |
|
|
7347
7635
|
| --- | --- | --- |
|
|
7636
|
+
| <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProviderProps.property.defaultLabels">defaultLabels</a></code> | <code>boolean</code> | Add default labels based on OS and architecture of the runner. |
|
|
7348
7637
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProviderProps.property.logRetention">logRetention</a></code> | <code>aws-cdk-lib.aws_logs.RetentionDays</code> | The number of days log events are kept in CloudWatch Logs. |
|
|
7349
7638
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProviderProps.property.retryOptions">retryOptions</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.ProviderRetryOptions">ProviderRetryOptions</a></code> | *No description.* |
|
|
7350
7639
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProviderProps.property.ephemeralStorageSize">ephemeralStorageSize</a></code> | <code>aws-cdk-lib.Size</code> | The size of the function’s /tmp directory in MiB. |
|
|
@@ -7361,6 +7650,21 @@ const lambdaRunnerProviderProps: LambdaRunnerProviderProps = { ... }
|
|
|
7361
7650
|
|
|
7362
7651
|
---
|
|
7363
7652
|
|
|
7653
|
+
##### `defaultLabels`<sup>Optional</sup> <a name="defaultLabels" id="@cloudsnorkel/cdk-github-runners.LambdaRunnerProviderProps.property.defaultLabels"></a>
|
|
7654
|
+
|
|
7655
|
+
```typescript
|
|
7656
|
+
public readonly defaultLabels: boolean;
|
|
7657
|
+
```
|
|
7658
|
+
|
|
7659
|
+
- *Type:* boolean
|
|
7660
|
+
- *Default:* true
|
|
7661
|
+
|
|
7662
|
+
Add default labels based on OS and architecture of the runner.
|
|
7663
|
+
|
|
7664
|
+
This will tell GitHub Runner to add default labels like `self-hosted`, `linux`, `x64`, and `arm64`.
|
|
7665
|
+
|
|
7666
|
+
---
|
|
7667
|
+
|
|
7364
7668
|
##### `logRetention`<sup>Optional</sup> <a name="logRetention" id="@cloudsnorkel/cdk-github-runners.LambdaRunnerProviderProps.property.logRetention"></a>
|
|
7365
7669
|
|
|
7366
7670
|
```typescript
|
|
@@ -8319,11 +8623,27 @@ const runnerProviderProps: RunnerProviderProps = { ... }
|
|
|
8319
8623
|
|
|
8320
8624
|
| **Name** | **Type** | **Description** |
|
|
8321
8625
|
| --- | --- | --- |
|
|
8626
|
+
| <code><a href="#@cloudsnorkel/cdk-github-runners.RunnerProviderProps.property.defaultLabels">defaultLabels</a></code> | <code>boolean</code> | Add default labels based on OS and architecture of the runner. |
|
|
8322
8627
|
| <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. |
|
|
8323
8628
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.RunnerProviderProps.property.retryOptions">retryOptions</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.ProviderRetryOptions">ProviderRetryOptions</a></code> | *No description.* |
|
|
8324
8629
|
|
|
8325
8630
|
---
|
|
8326
8631
|
|
|
8632
|
+
##### `defaultLabels`<sup>Optional</sup> <a name="defaultLabels" id="@cloudsnorkel/cdk-github-runners.RunnerProviderProps.property.defaultLabels"></a>
|
|
8633
|
+
|
|
8634
|
+
```typescript
|
|
8635
|
+
public readonly defaultLabels: boolean;
|
|
8636
|
+
```
|
|
8637
|
+
|
|
8638
|
+
- *Type:* boolean
|
|
8639
|
+
- *Default:* true
|
|
8640
|
+
|
|
8641
|
+
Add default labels based on OS and architecture of the runner.
|
|
8642
|
+
|
|
8643
|
+
This will tell GitHub Runner to add default labels like `self-hosted`, `linux`, `x64`, and `arm64`.
|
|
8644
|
+
|
|
8645
|
+
---
|
|
8646
|
+
|
|
8327
8647
|
##### `logRetention`<sup>Optional</sup> <a name="logRetention" id="@cloudsnorkel/cdk-github-runners.RunnerProviderProps.property.logRetention"></a>
|
|
8328
8648
|
|
|
8329
8649
|
```typescript
|
|
@@ -17,6 +17,7 @@ RUNNER_NAME=$(echo "$1" | jq -r .runnerName)
|
|
|
17
17
|
RUNNER_LABEL=$(echo "$1" | jq -r .label)
|
|
18
18
|
REGISTRATION_URL=$(echo "$1" | jq -r .registrationUrl)
|
|
19
19
|
RUNNER_GROUP=$(echo "$1" | jq -r .group)
|
|
20
|
+
DEFAULT_LABELS=$(echo "$1" | jq -r .defaultLabels)
|
|
20
21
|
|
|
21
22
|
# copy runner code (it needs a writable directory)
|
|
22
23
|
cp -r /home/runner /tmp/
|
|
@@ -28,7 +29,7 @@ export HOME=/tmp/home
|
|
|
28
29
|
|
|
29
30
|
# start runner
|
|
30
31
|
if [ "${RUNNER_VERSION}" = "latest" ]; then RUNNER_FLAGS=""; else RUNNER_FLAGS="--disableupdate"; fi
|
|
31
|
-
./config.sh --unattended --url "${REGISTRATION_URL}" --token "${RUNNER_TOKEN}" --ephemeral --work _work --labels "${RUNNER_LABEL},cdkghr:started:`date +%s`" --name "${RUNNER_NAME}" ${RUNNER_FLAGS} ${RUNNER_GROUP}
|
|
32
|
+
./config.sh --unattended --url "${REGISTRATION_URL}" --token "${RUNNER_TOKEN}" --ephemeral --work _work --labels "${RUNNER_LABEL},cdkghr:started:`date +%s`" --name "${RUNNER_NAME}" ${RUNNER_FLAGS} ${RUNNER_GROUP} ${DEFAULT_LABELS}
|
|
32
33
|
echo Config done
|
|
33
34
|
./run.sh
|
|
34
35
|
echo Run done
|