deployable-awscdk-app-ts 0.1.683 → 0.1.684

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.
Files changed (7) hide show
  1. package/.jsii +957 -12
  2. package/API.md +643 -0
  3. package/lib/index.d.ts +1 -0
  4. package/lib/index.js +3 -2
  5. package/lib/steps.d.ts +7 -1
  6. package/lib/steps.js +13 -3
  7. package/package.json +1 -1
package/.jsii CHANGED
@@ -420,7 +420,7 @@
420
420
  },
421
421
  "locationInModule": {
422
422
  "filename": "src/index.ts",
423
- "line": 27
423
+ "line": 28
424
424
  },
425
425
  "parameters": [
426
426
  {
@@ -434,7 +434,7 @@
434
434
  "kind": "class",
435
435
  "locationInModule": {
436
436
  "filename": "src/index.ts",
437
- "line": 10
437
+ "line": 11
438
438
  },
439
439
  "methods": [
440
440
  {
@@ -444,7 +444,7 @@
444
444
  },
445
445
  "locationInModule": {
446
446
  "filename": "src/index.ts",
447
- "line": 90
447
+ "line": 91
448
448
  },
449
449
  "name": "addEnvironments",
450
450
  "parameters": [
@@ -469,7 +469,7 @@
469
469
  },
470
470
  "locationInModule": {
471
471
  "filename": "src/index.ts",
472
- "line": 74
472
+ "line": 75
473
473
  },
474
474
  "name": "synth",
475
475
  "overrides": "projen.Project"
@@ -481,7 +481,7 @@
481
481
  },
482
482
  "locationInModule": {
483
483
  "filename": "src/index.ts",
484
- "line": 154
484
+ "line": 155
485
485
  },
486
486
  "name": "updateEnvironmentDeploymentDependencies",
487
487
  "parameters": [
@@ -513,7 +513,7 @@
513
513
  },
514
514
  "locationInModule": {
515
515
  "filename": "src/index.ts",
516
- "line": 106
516
+ "line": 107
517
517
  },
518
518
  "name": "updatePostDeployWorkflowScriptToEnvironments",
519
519
  "parameters": [
@@ -550,7 +550,7 @@
550
550
  },
551
551
  "locationInModule": {
552
552
  "filename": "src/index.ts",
553
- "line": 123
553
+ "line": 124
554
554
  },
555
555
  "name": "updatePreDeployWorkflowScriptToEnvironments",
556
556
  "parameters": [
@@ -591,7 +591,7 @@
591
591
  "immutable": true,
592
592
  "locationInModule": {
593
593
  "filename": "src/index.ts",
594
- "line": 15
594
+ "line": 16
595
595
  },
596
596
  "name": "deployWorkflowTask",
597
597
  "type": {
@@ -607,7 +607,7 @@
607
607
  "immutable": true,
608
608
  "locationInModule": {
609
609
  "filename": "src/index.ts",
610
- "line": 66
610
+ "line": 67
611
611
  },
612
612
  "name": "majorNodeVersion",
613
613
  "type": {
@@ -620,7 +620,7 @@
620
620
  },
621
621
  "locationInModule": {
622
622
  "filename": "src/index.ts",
623
- "line": 21
623
+ "line": 22
624
624
  },
625
625
  "name": "deployOptions",
626
626
  "protected": true,
@@ -705,6 +705,951 @@
705
705
  ],
706
706
  "symbolId": "src/types:DeployableAwsCdkTypeScriptAppOptions"
707
707
  },
708
+ "deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppStepsFactory": {
709
+ "assembly": "deployable-awscdk-app-ts",
710
+ "docs": {
711
+ "stability": "experimental",
712
+ "summary": "Factory to create reusable steps for the deployment workflow."
713
+ },
714
+ "fqn": "deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppStepsFactory",
715
+ "initializer": {
716
+ "docs": {
717
+ "stability": "experimental",
718
+ "summary": "Create a new DeployableAwsCdkTypeScriptAppStepsFactory."
719
+ },
720
+ "locationInModule": {
721
+ "filename": "src/steps.ts",
722
+ "line": 87
723
+ },
724
+ "parameters": [
725
+ {
726
+ "docs": {
727
+ "summary": "The project."
728
+ },
729
+ "name": "project",
730
+ "type": {
731
+ "fqn": "projen.javascript.NodeProject"
732
+ }
733
+ },
734
+ {
735
+ "docs": {
736
+ "summary": "The factory properties."
737
+ },
738
+ "name": "props",
739
+ "type": {
740
+ "fqn": "deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppStepsFactoryProps"
741
+ }
742
+ }
743
+ ]
744
+ },
745
+ "kind": "class",
746
+ "locationInModule": {
747
+ "filename": "src/steps.ts",
748
+ "line": 52
749
+ },
750
+ "methods": [
751
+ {
752
+ "docs": {
753
+ "stability": "experimental",
754
+ "summary": "Validate that the provided environment deployment dependencies are valid."
755
+ },
756
+ "locationInModule": {
757
+ "filename": "src/steps.ts",
758
+ "line": 59
759
+ },
760
+ "name": "validateEnvironmentDeploymentDependencies",
761
+ "parameters": [
762
+ {
763
+ "docs": {
764
+ "summary": "The deployment options."
765
+ },
766
+ "name": "deployOptions",
767
+ "type": {
768
+ "fqn": "deployable-awscdk-app-ts.DeployOptions"
769
+ }
770
+ },
771
+ {
772
+ "docs": {
773
+ "summary": "The environment deployment dependencies to validate."
774
+ },
775
+ "name": "environmentDependencies",
776
+ "type": {
777
+ "collection": {
778
+ "elementtype": {
779
+ "collection": {
780
+ "elementtype": {
781
+ "primitive": "string"
782
+ },
783
+ "kind": "array"
784
+ }
785
+ },
786
+ "kind": "map"
787
+ }
788
+ }
789
+ }
790
+ ],
791
+ "static": true
792
+ },
793
+ {
794
+ "docs": {
795
+ "returns": "JobStep or undefined if assumeRoleFlag is boolean and false\nif assumeRoleFlag is string will always return a JobStep (for matrix strategy)",
796
+ "stability": "experimental",
797
+ "summary": "Step to assume an AWS role for a specific environment."
798
+ },
799
+ "locationInModule": {
800
+ "filename": "src/steps.ts",
801
+ "line": 293
802
+ },
803
+ "name": "getAssumeAwsRoleStepForEnvironment",
804
+ "parameters": [
805
+ {
806
+ "docs": {
807
+ "summary": "Whether to assume a role, can be a boolean or a string for matrix strategy."
808
+ },
809
+ "name": "assumeRoleFlag",
810
+ "type": {
811
+ "union": {
812
+ "types": [
813
+ {
814
+ "primitive": "string"
815
+ },
816
+ {
817
+ "primitive": "boolean"
818
+ }
819
+ ]
820
+ }
821
+ }
822
+ },
823
+ {
824
+ "docs": {
825
+ "summary": "The GitHub secret name for the access key ID."
826
+ },
827
+ "name": "accessKeyIdSecretName",
828
+ "type": {
829
+ "primitive": "string"
830
+ }
831
+ },
832
+ {
833
+ "docs": {
834
+ "summary": "The GitHub secret name for the secret access key."
835
+ },
836
+ "name": "secretAccessKeySecretName",
837
+ "type": {
838
+ "primitive": "string"
839
+ }
840
+ },
841
+ {
842
+ "docs": {
843
+ "summary": "The region."
844
+ },
845
+ "name": "region",
846
+ "type": {
847
+ "primitive": "string"
848
+ }
849
+ },
850
+ {
851
+ "docs": {
852
+ "summary": "The role to assume."
853
+ },
854
+ "name": "roleToAssume",
855
+ "type": {
856
+ "primitive": "string"
857
+ }
858
+ },
859
+ {
860
+ "docs": {
861
+ "summary": "The duration for assuming the role."
862
+ },
863
+ "name": "assumeRoleDurationSeconds",
864
+ "optional": true,
865
+ "type": {
866
+ "union": {
867
+ "types": [
868
+ {
869
+ "primitive": "string"
870
+ },
871
+ {
872
+ "primitive": "number"
873
+ }
874
+ ]
875
+ }
876
+ }
877
+ }
878
+ ],
879
+ "returns": {
880
+ "optional": true,
881
+ "type": {
882
+ "fqn": "projen.github.workflows.JobStep"
883
+ }
884
+ }
885
+ },
886
+ {
887
+ "docs": {
888
+ "returns": "JobStep",
889
+ "stability": "experimental",
890
+ "summary": "Step to check if there is an active deployment for a specific environment."
891
+ },
892
+ "locationInModule": {
893
+ "filename": "src/steps.ts",
894
+ "line": 138
895
+ },
896
+ "name": "getCheckActiveDeploymentStepForEnvironment",
897
+ "parameters": [
898
+ {
899
+ "docs": {
900
+ "summary": "The environment to check."
901
+ },
902
+ "name": "environment",
903
+ "type": {
904
+ "primitive": "string"
905
+ }
906
+ }
907
+ ],
908
+ "returns": {
909
+ "optional": true,
910
+ "type": {
911
+ "fqn": "projen.github.workflows.JobStep"
912
+ }
913
+ }
914
+ },
915
+ {
916
+ "docs": {
917
+ "returns": "An array of job IDs",
918
+ "stability": "experimental",
919
+ "summary": "Get the IDs of the jobs that must be completed before the specified environment's deployment job."
920
+ },
921
+ "locationInModule": {
922
+ "filename": "src/steps.ts",
923
+ "line": 592
924
+ },
925
+ "name": "getDeploymentJobPrerequisiteJobIds",
926
+ "parameters": [
927
+ {
928
+ "docs": {
929
+ "summary": "The name of the environment."
930
+ },
931
+ "name": "environmentName",
932
+ "type": {
933
+ "primitive": "string"
934
+ }
935
+ }
936
+ ],
937
+ "returns": {
938
+ "type": {
939
+ "collection": {
940
+ "elementtype": {
941
+ "primitive": "string"
942
+ },
943
+ "kind": "array"
944
+ }
945
+ }
946
+ }
947
+ },
948
+ {
949
+ "docs": {
950
+ "returns": "The job definition for the environment",
951
+ "stability": "experimental",
952
+ "summary": "Get the job definition for a specific environment."
953
+ },
954
+ "locationInModule": {
955
+ "filename": "src/steps.ts",
956
+ "line": 629
957
+ },
958
+ "name": "getJobForEnvironment",
959
+ "parameters": [
960
+ {
961
+ "docs": {
962
+ "summary": "The environment options."
963
+ },
964
+ "name": "environmentOptions",
965
+ "type": {
966
+ "fqn": "deployable-awscdk-app-ts.EnvironmentOptions"
967
+ }
968
+ },
969
+ {
970
+ "docs": {
971
+ "summary": "The name of the environment variable to set with the environment name, if any."
972
+ },
973
+ "name": "environmentVariableName",
974
+ "optional": true,
975
+ "type": {
976
+ "primitive": "string"
977
+ }
978
+ }
979
+ ],
980
+ "returns": {
981
+ "type": {
982
+ "fqn": "projen.github.workflows.Job"
983
+ }
984
+ }
985
+ },
986
+ {
987
+ "docs": {
988
+ "returns": "The job step to run the post-deployment script or undefined if not applicable\nIf hasPostDeployTaskFlag is boolean and false will return undefined\nIf hasPostDeployTaskFlag is string will always return a JobStep (for matrix strategy)",
989
+ "stability": "experimental",
990
+ "summary": "Get the post-deployment step for a specific environment."
991
+ },
992
+ "locationInModule": {
993
+ "filename": "src/steps.ts",
994
+ "line": 463
995
+ },
996
+ "name": "getPostDeploymentStepForEnvironment",
997
+ "parameters": [
998
+ {
999
+ "docs": {
1000
+ "summary": "Whether the post-deployment task should be run."
1001
+ },
1002
+ "name": "hasPostDeployTaskFlag",
1003
+ "type": {
1004
+ "union": {
1005
+ "types": [
1006
+ {
1007
+ "primitive": "string"
1008
+ },
1009
+ {
1010
+ "primitive": "boolean"
1011
+ }
1012
+ ]
1013
+ }
1014
+ }
1015
+ },
1016
+ {
1017
+ "docs": {
1018
+ "summary": "The script to run."
1019
+ },
1020
+ "name": "postDeploymentScript",
1021
+ "type": {
1022
+ "primitive": "string"
1023
+ }
1024
+ }
1025
+ ],
1026
+ "returns": {
1027
+ "optional": true,
1028
+ "type": {
1029
+ "fqn": "projen.github.workflows.JobStep"
1030
+ }
1031
+ }
1032
+ },
1033
+ {
1034
+ "docs": {
1035
+ "returns": "The job step to run the pre-deployment script or undefined if not applicable\nIf hasPreDeployTaskFlag is boolean and false will return undefined\nIf hasPreDeployTaskFlag is string will always return a JobStep (for matrix strategy)",
1036
+ "stability": "experimental",
1037
+ "summary": "Get the pre-deployment step for a specific environment."
1038
+ },
1039
+ "locationInModule": {
1040
+ "filename": "src/steps.ts",
1041
+ "line": 432
1042
+ },
1043
+ "name": "getPreDeploymentStepForEnvironment",
1044
+ "parameters": [
1045
+ {
1046
+ "docs": {
1047
+ "summary": "Whether the pre-deployment task should be run."
1048
+ },
1049
+ "name": "hasPreDeployTaskFlag",
1050
+ "type": {
1051
+ "union": {
1052
+ "types": [
1053
+ {
1054
+ "primitive": "string"
1055
+ },
1056
+ {
1057
+ "primitive": "boolean"
1058
+ }
1059
+ ]
1060
+ }
1061
+ }
1062
+ },
1063
+ {
1064
+ "docs": {
1065
+ "summary": "The script to run."
1066
+ },
1067
+ "name": "preDeploymentScript",
1068
+ "type": {
1069
+ "primitive": "string"
1070
+ }
1071
+ }
1072
+ ],
1073
+ "returns": {
1074
+ "optional": true,
1075
+ "type": {
1076
+ "fqn": "projen.github.workflows.JobStep"
1077
+ }
1078
+ }
1079
+ },
1080
+ {
1081
+ "docs": {
1082
+ "returns": "The job step to run the script or undefined if not applicable\nIf hasScriptFlag is boolean and false will return undefined\nIf hasScriptFlag is string will always return a JobStep (for matrix strategy)",
1083
+ "stability": "experimental",
1084
+ "summary": "Get the step to run a specific script."
1085
+ },
1086
+ "locationInModule": {
1087
+ "filename": "src/steps.ts",
1088
+ "line": 372
1089
+ },
1090
+ "name": "getRunScriptStep",
1091
+ "parameters": [
1092
+ {
1093
+ "docs": {
1094
+ "summary": "The name of the script to run."
1095
+ },
1096
+ "name": "scriptName",
1097
+ "type": {
1098
+ "primitive": "string"
1099
+ }
1100
+ },
1101
+ {
1102
+ "docs": {
1103
+ "summary": "The name of the step in the workflow."
1104
+ },
1105
+ "name": "stepName",
1106
+ "type": {
1107
+ "primitive": "string"
1108
+ }
1109
+ },
1110
+ {
1111
+ "docs": {
1112
+ "summary": "Whether the script should be run."
1113
+ },
1114
+ "name": "hasScriptFlag",
1115
+ "type": {
1116
+ "union": {
1117
+ "types": [
1118
+ {
1119
+ "primitive": "string"
1120
+ },
1121
+ {
1122
+ "primitive": "boolean"
1123
+ }
1124
+ ]
1125
+ }
1126
+ }
1127
+ }
1128
+ ],
1129
+ "returns": {
1130
+ "optional": true,
1131
+ "type": {
1132
+ "fqn": "projen.github.workflows.JobStep"
1133
+ }
1134
+ }
1135
+ },
1136
+ {
1137
+ "docs": {
1138
+ "returns": "JobStep or undefined if no AWS credentials are provided,\nif assumeRoleFlag is boolean will be evaluated and return a JobStep only if false\nif assumeRoleFlag is string will always return a JobStep (for matrix strategy)",
1139
+ "stability": "experimental",
1140
+ "summary": "Step to setup AWS credentials in the environment for a specific environment."
1141
+ },
1142
+ "locationInModule": {
1143
+ "filename": "src/steps.ts",
1144
+ "line": 224
1145
+ },
1146
+ "name": "getSetupAwsCredentialsInEnvironmentForEnvironment",
1147
+ "parameters": [
1148
+ {
1149
+ "docs": {
1150
+ "summary": "Whether to assume a role, can be a boolean or a string for matrix strategy."
1151
+ },
1152
+ "name": "assumeRoleFlag",
1153
+ "type": {
1154
+ "union": {
1155
+ "types": [
1156
+ {
1157
+ "primitive": "string"
1158
+ },
1159
+ {
1160
+ "primitive": "boolean"
1161
+ }
1162
+ ]
1163
+ }
1164
+ }
1165
+ },
1166
+ {
1167
+ "docs": {
1168
+ "summary": "The GitHub secret name for the access key ID."
1169
+ },
1170
+ "name": "accessKeyIdSecretName",
1171
+ "type": {
1172
+ "primitive": "string"
1173
+ }
1174
+ },
1175
+ {
1176
+ "docs": {
1177
+ "summary": "The GitHub secret name for the secret access key."
1178
+ },
1179
+ "name": "secretAccessKeySecretName",
1180
+ "type": {
1181
+ "primitive": "string"
1182
+ }
1183
+ },
1184
+ {
1185
+ "docs": {
1186
+ "summary": "The region."
1187
+ },
1188
+ "name": "region",
1189
+ "type": {
1190
+ "primitive": "string"
1191
+ }
1192
+ }
1193
+ ],
1194
+ "returns": {
1195
+ "optional": true,
1196
+ "type": {
1197
+ "fqn": "projen.github.workflows.JobStep"
1198
+ }
1199
+ }
1200
+ },
1201
+ {
1202
+ "docs": {
1203
+ "returns": "JobStep[]",
1204
+ "stability": "experimental",
1205
+ "summary": "Get the steps to setup AWS credentials for a specific environment."
1206
+ },
1207
+ "locationInModule": {
1208
+ "filename": "src/steps.ts",
1209
+ "line": 171
1210
+ },
1211
+ "name": "getSetupAwsCredentialsStepsForEnvironment",
1212
+ "parameters": [
1213
+ {
1214
+ "docs": {
1215
+ "summary": "The environment options."
1216
+ },
1217
+ "name": "environmentOptions",
1218
+ "type": {
1219
+ "fqn": "deployable-awscdk-app-ts.EnvironmentOptions"
1220
+ }
1221
+ }
1222
+ ],
1223
+ "returns": {
1224
+ "type": {
1225
+ "collection": {
1226
+ "elementtype": {
1227
+ "fqn": "projen.github.workflows.JobStep"
1228
+ },
1229
+ "kind": "array"
1230
+ }
1231
+ }
1232
+ }
1233
+ },
1234
+ {
1235
+ "docs": {
1236
+ "stability": "experimental"
1237
+ },
1238
+ "locationInModule": {
1239
+ "filename": "src/steps.ts",
1240
+ "line": 346
1241
+ },
1242
+ "name": "getSetupNpmConfigForEnvironment",
1243
+ "parameters": [
1244
+ {
1245
+ "name": "environment",
1246
+ "type": {
1247
+ "primitive": "string"
1248
+ }
1249
+ }
1250
+ ],
1251
+ "returns": {
1252
+ "optional": true,
1253
+ "type": {
1254
+ "fqn": "projen.github.workflows.JobStep"
1255
+ }
1256
+ }
1257
+ }
1258
+ ],
1259
+ "name": "DeployableAwsCdkTypeScriptAppStepsFactory",
1260
+ "properties": [
1261
+ {
1262
+ "docs": {
1263
+ "returns": "JobStep",
1264
+ "stability": "experimental",
1265
+ "summary": "Step to assume an AWS role for the matrix strategy."
1266
+ },
1267
+ "immutable": true,
1268
+ "locationInModule": {
1269
+ "filename": "src/steps.ts",
1270
+ "line": 271
1271
+ },
1272
+ "name": "assumeAwsRoleStepForMatrix",
1273
+ "type": {
1274
+ "fqn": "projen.github.workflows.JobStep"
1275
+ }
1276
+ },
1277
+ {
1278
+ "docs": {
1279
+ "stability": "experimental"
1280
+ },
1281
+ "immutable": true,
1282
+ "locationInModule": {
1283
+ "filename": "src/steps.ts",
1284
+ "line": 100
1285
+ },
1286
+ "name": "checkoutStep",
1287
+ "type": {
1288
+ "fqn": "projen.github.workflows.JobStep"
1289
+ }
1290
+ },
1291
+ {
1292
+ "docs": {
1293
+ "returns": "Record of jobs",
1294
+ "stability": "experimental",
1295
+ "summary": "Get all deployment jobs whether for matrix strategy or not."
1296
+ },
1297
+ "immutable": true,
1298
+ "locationInModule": {
1299
+ "filename": "src/steps.ts",
1300
+ "line": 479
1301
+ },
1302
+ "name": "deploymentJobs",
1303
+ "type": {
1304
+ "collection": {
1305
+ "elementtype": {
1306
+ "fqn": "projen.github.workflows.Job"
1307
+ },
1308
+ "kind": "map"
1309
+ }
1310
+ }
1311
+ },
1312
+ {
1313
+ "docs": {
1314
+ "returns": "Record of jobs",
1315
+ "stability": "experimental",
1316
+ "summary": "Get deployment jobs for matrix strategy."
1317
+ },
1318
+ "immutable": true,
1319
+ "locationInModule": {
1320
+ "filename": "src/steps.ts",
1321
+ "line": 491
1322
+ },
1323
+ "name": "deploymentJobsForMatrix",
1324
+ "type": {
1325
+ "collection": {
1326
+ "elementtype": {
1327
+ "fqn": "projen.github.workflows.Job"
1328
+ },
1329
+ "kind": "map"
1330
+ }
1331
+ }
1332
+ },
1333
+ {
1334
+ "docs": {
1335
+ "returns": "Record of jobs",
1336
+ "stability": "experimental",
1337
+ "summary": "Get deployment jobs for multi-job strategy."
1338
+ },
1339
+ "immutable": true,
1340
+ "locationInModule": {
1341
+ "filename": "src/steps.ts",
1342
+ "line": 615
1343
+ },
1344
+ "name": "deploymentJobsForMultiJob",
1345
+ "type": {
1346
+ "collection": {
1347
+ "elementtype": {
1348
+ "fqn": "projen.github.workflows.Job"
1349
+ },
1350
+ "kind": "map"
1351
+ }
1352
+ }
1353
+ },
1354
+ {
1355
+ "docs": {
1356
+ "returns": "JobStep",
1357
+ "stability": "experimental",
1358
+ "summary": "Step to deploy the workflow."
1359
+ },
1360
+ "immutable": true,
1361
+ "locationInModule": {
1362
+ "filename": "src/steps.ts",
1363
+ "line": 405
1364
+ },
1365
+ "name": "deploymentStep",
1366
+ "type": {
1367
+ "fqn": "projen.github.workflows.JobStep"
1368
+ }
1369
+ },
1370
+ {
1371
+ "docs": {
1372
+ "returns": "JobStep",
1373
+ "stability": "experimental",
1374
+ "summary": "Step to run post deployment script in matrix strategy."
1375
+ },
1376
+ "immutable": true,
1377
+ "locationInModule": {
1378
+ "filename": "src/steps.ts",
1379
+ "line": 448
1380
+ },
1381
+ "name": "postDeploymentStepForMatrix",
1382
+ "type": {
1383
+ "fqn": "projen.github.workflows.JobStep"
1384
+ }
1385
+ },
1386
+ {
1387
+ "docs": {
1388
+ "returns": "JobStep",
1389
+ "stability": "experimental",
1390
+ "summary": "Step to run post deployment script in matrix strategy."
1391
+ },
1392
+ "immutable": true,
1393
+ "locationInModule": {
1394
+ "filename": "src/steps.ts",
1395
+ "line": 417
1396
+ },
1397
+ "name": "preDeploymentStepForMatrix",
1398
+ "type": {
1399
+ "fqn": "projen.github.workflows.JobStep"
1400
+ }
1401
+ },
1402
+ {
1403
+ "docs": {
1404
+ "returns": "JobStep",
1405
+ "stability": "experimental",
1406
+ "summary": "Step to setup AWS credentials in the environment for the matrix strategy."
1407
+ },
1408
+ "immutable": true,
1409
+ "locationInModule": {
1410
+ "filename": "src/steps.ts",
1411
+ "line": 205
1412
+ },
1413
+ "name": "setupAwsCredentialsInEnvironmentForMatrix",
1414
+ "type": {
1415
+ "fqn": "projen.github.workflows.JobStep"
1416
+ }
1417
+ },
1418
+ {
1419
+ "docs": {
1420
+ "returns": "JobStep[]",
1421
+ "stability": "experimental",
1422
+ "summary": "Step to setup AWS credentials in the environment for the matrix strategy."
1423
+ },
1424
+ "immutable": true,
1425
+ "locationInModule": {
1426
+ "filename": "src/steps.ts",
1427
+ "line": 159
1428
+ },
1429
+ "name": "setupAwsCredentialsStepsForMatrix",
1430
+ "type": {
1431
+ "collection": {
1432
+ "elementtype": {
1433
+ "fqn": "projen.github.workflows.JobStep"
1434
+ },
1435
+ "kind": "array"
1436
+ }
1437
+ }
1438
+ },
1439
+ {
1440
+ "docs": {
1441
+ "returns": "JobStep",
1442
+ "stability": "experimental",
1443
+ "summary": "Step to check if there is an active deployment for the environment in the matrix strategy."
1444
+ },
1445
+ "immutable": true,
1446
+ "locationInModule": {
1447
+ "filename": "src/steps.ts",
1448
+ "line": 129
1449
+ },
1450
+ "name": "checkActiveDeploymentStepForMatrix",
1451
+ "optional": true,
1452
+ "type": {
1453
+ "fqn": "projen.github.workflows.JobStep"
1454
+ }
1455
+ },
1456
+ {
1457
+ "docs": {
1458
+ "returns": "JobStep or undefined if no preInstallTaskName is provided",
1459
+ "stability": "experimental",
1460
+ "summary": "Step to run before installing dependencies if exists."
1461
+ },
1462
+ "immutable": true,
1463
+ "locationInModule": {
1464
+ "filename": "src/steps.ts",
1465
+ "line": 113
1466
+ },
1467
+ "name": "preInstallDependenciesStep",
1468
+ "optional": true,
1469
+ "type": {
1470
+ "fqn": "projen.github.workflows.JobStep"
1471
+ }
1472
+ },
1473
+ {
1474
+ "docs": {
1475
+ "returns": "JobStep or undefined if no npmConfig is provided",
1476
+ "stability": "experimental",
1477
+ "summary": "Step to setup NPM config if provided."
1478
+ },
1479
+ "immutable": true,
1480
+ "locationInModule": {
1481
+ "filename": "src/steps.ts",
1482
+ "line": 342
1483
+ },
1484
+ "name": "setupNpmConfigForMatrix",
1485
+ "optional": true,
1486
+ "type": {
1487
+ "fqn": "projen.github.workflows.JobStep"
1488
+ }
1489
+ },
1490
+ {
1491
+ "docs": {
1492
+ "returns": "JobStep condition or undefined if checkActiveDeployment is false",
1493
+ "stability": "experimental",
1494
+ "summary": "Condition to skip a step if an active deployment is already present."
1495
+ },
1496
+ "immutable": true,
1497
+ "locationInModule": {
1498
+ "filename": "src/steps.ts",
1499
+ "line": 96
1500
+ },
1501
+ "name": "skipIfAlreadyActiveDeploymentCondition",
1502
+ "optional": true,
1503
+ "type": {
1504
+ "fqn": "projen.github.workflows.JobStep"
1505
+ }
1506
+ }
1507
+ ],
1508
+ "symbolId": "src/steps:DeployableAwsCdkTypeScriptAppStepsFactory"
1509
+ },
1510
+ "deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppStepsFactoryProps": {
1511
+ "assembly": "deployable-awscdk-app-ts",
1512
+ "datatype": true,
1513
+ "docs": {
1514
+ "stability": "stable"
1515
+ },
1516
+ "fqn": "deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppStepsFactoryProps",
1517
+ "kind": "interface",
1518
+ "locationInModule": {
1519
+ "filename": "src/steps.ts",
1520
+ "line": 10
1521
+ },
1522
+ "name": "DeployableAwsCdkTypeScriptAppStepsFactoryProps",
1523
+ "properties": [
1524
+ {
1525
+ "abstract": true,
1526
+ "docs": {
1527
+ "stability": "stable",
1528
+ "summary": "Whether to check for active deployments before proceeding with deployment."
1529
+ },
1530
+ "immutable": true,
1531
+ "locationInModule": {
1532
+ "filename": "src/steps.ts",
1533
+ "line": 19
1534
+ },
1535
+ "name": "checkActiveDeployment",
1536
+ "type": {
1537
+ "primitive": "boolean"
1538
+ }
1539
+ },
1540
+ {
1541
+ "abstract": true,
1542
+ "docs": {
1543
+ "stability": "stable",
1544
+ "summary": "Deployment options."
1545
+ },
1546
+ "immutable": true,
1547
+ "locationInModule": {
1548
+ "filename": "src/steps.ts",
1549
+ "line": 14
1550
+ },
1551
+ "name": "deployOptions",
1552
+ "type": {
1553
+ "fqn": "deployable-awscdk-app-ts.DeployOptions"
1554
+ }
1555
+ },
1556
+ {
1557
+ "abstract": true,
1558
+ "docs": {
1559
+ "stability": "stable",
1560
+ "summary": "Deployment job strategy, whether to use a matrix job or multiple jobs for each environment."
1561
+ },
1562
+ "immutable": true,
1563
+ "locationInModule": {
1564
+ "filename": "src/steps.ts",
1565
+ "line": 40
1566
+ },
1567
+ "name": "jobStrategy",
1568
+ "type": {
1569
+ "fqn": "deployable-awscdk-app-ts.DeployJobStrategy"
1570
+ }
1571
+ },
1572
+ {
1573
+ "abstract": true,
1574
+ "docs": {
1575
+ "stability": "stable",
1576
+ "summary": "The authentication provider for CodeArtifact, if any."
1577
+ },
1578
+ "immutable": true,
1579
+ "locationInModule": {
1580
+ "filename": "src/steps.ts",
1581
+ "line": 29
1582
+ },
1583
+ "name": "authProvider",
1584
+ "optional": true,
1585
+ "type": {
1586
+ "fqn": "projen.javascript.CodeArtifactAuthProvider"
1587
+ }
1588
+ },
1589
+ {
1590
+ "abstract": true,
1591
+ "docs": {
1592
+ "stability": "stable",
1593
+ "summary": "Environment deployment dependencies, if any."
1594
+ },
1595
+ "immutable": true,
1596
+ "locationInModule": {
1597
+ "filename": "src/steps.ts",
1598
+ "line": 45
1599
+ },
1600
+ "name": "environmentDependencies",
1601
+ "optional": true,
1602
+ "type": {
1603
+ "collection": {
1604
+ "elementtype": {
1605
+ "collection": {
1606
+ "elementtype": {
1607
+ "primitive": "string"
1608
+ },
1609
+ "kind": "array"
1610
+ }
1611
+ },
1612
+ "kind": "map"
1613
+ }
1614
+ }
1615
+ },
1616
+ {
1617
+ "abstract": true,
1618
+ "docs": {
1619
+ "stability": "stable",
1620
+ "summary": "The npm config to set with the environment that is being deployed, if any Note: This is not supported for node versions above 18."
1621
+ },
1622
+ "immutable": true,
1623
+ "locationInModule": {
1624
+ "filename": "src/steps.ts",
1625
+ "line": 35
1626
+ },
1627
+ "name": "npmConfigEnvironment",
1628
+ "optional": true,
1629
+ "type": {
1630
+ "primitive": "string"
1631
+ }
1632
+ },
1633
+ {
1634
+ "abstract": true,
1635
+ "docs": {
1636
+ "stability": "stable",
1637
+ "summary": "The name of the task to run before installing dependencies, if any."
1638
+ },
1639
+ "immutable": true,
1640
+ "locationInModule": {
1641
+ "filename": "src/steps.ts",
1642
+ "line": 24
1643
+ },
1644
+ "name": "preInstallTaskName",
1645
+ "optional": true,
1646
+ "type": {
1647
+ "primitive": "string"
1648
+ }
1649
+ }
1650
+ ],
1651
+ "symbolId": "src/steps:DeployableAwsCdkTypeScriptAppStepsFactoryProps"
1652
+ },
708
1653
  "deployable-awscdk-app-ts.EnvironmentOptions": {
709
1654
  "assembly": "deployable-awscdk-app-ts",
710
1655
  "datatype": true,
@@ -791,6 +1736,6 @@
791
1736
  "symbolId": "src/types:EnvironmentOptions"
792
1737
  }
793
1738
  },
794
- "version": "0.1.683",
795
- "fingerprint": "GtqaSkDdWoJzeACtO54K5zltl5qUo1jFVp7cht2OQXk="
1739
+ "version": "0.1.684",
1740
+ "fingerprint": "Ai1YwM4A2TDsz0wY3hLraPd3LPZBVFaHIXNycmI1CPE="
796
1741
  }