projen-pipelines 0.2.6 → 0.2.8

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 (58) hide show
  1. package/.jsii +61 -59
  2. package/API.md +76 -64
  3. package/lib/awscdk/base.d.ts +5 -1
  4. package/lib/awscdk/base.js +33 -28
  5. package/lib/awscdk/bash.js +5 -3
  6. package/lib/awscdk/github.js +11 -9
  7. package/lib/awscdk/gitlab.js +1 -1
  8. package/lib/engines/github.js +3 -4
  9. package/lib/steps/artifact-steps.js +2 -2
  10. package/lib/steps/aws-assume-role.step.js +1 -1
  11. package/lib/steps/registries.js +2 -2
  12. package/lib/steps/step.js +4 -4
  13. package/node_modules/semver/README.md +14 -4
  14. package/node_modules/semver/bin/semver.js +2 -1
  15. package/node_modules/semver/classes/semver.js +22 -6
  16. package/node_modules/semver/functions/diff.js +5 -12
  17. package/node_modules/semver/internal/re.js +2 -0
  18. package/node_modules/semver/package.json +8 -7
  19. package/node_modules/spdx-license-ids/README.md +0 -1
  20. package/node_modules/spdx-license-ids/index.json +14 -0
  21. package/node_modules/spdx-license-ids/package.json +3 -13
  22. package/package.json +15 -14
  23. package/node_modules/color-convert/CHANGELOG.md +0 -54
  24. package/node_modules/get-pkg-repo/CHANGELOG.md +0 -17
  25. package/node_modules/get-pkg-repo/node_modules/cliui/CHANGELOG.md +0 -121
  26. package/node_modules/get-pkg-repo/node_modules/yargs/CHANGELOG.md +0 -88
  27. package/node_modules/js-tokens/CHANGELOG.md +0 -151
  28. package/node_modules/json-parse-better-errors/CHANGELOG.md +0 -46
  29. package/node_modules/json-parse-even-better-errors/CHANGELOG.md +0 -50
  30. package/node_modules/kind-of/CHANGELOG.md +0 -160
  31. package/node_modules/meow/node_modules/hosted-git-info/CHANGELOG.md +0 -151
  32. package/node_modules/q/CHANGES.md +0 -800
  33. package/node_modules/read-pkg/node_modules/hosted-git-info/CHANGELOG.md +0 -151
  34. package/node_modules/source-map/CHANGELOG.md +0 -301
  35. package/node_modules/standard-version/node_modules/cliui/CHANGELOG.md +0 -121
  36. package/node_modules/standard-version/node_modules/conventional-changelog/CHANGELOG.md +0 -933
  37. package/node_modules/standard-version/node_modules/conventional-changelog-angular/CHANGELOG.md +0 -408
  38. package/node_modules/standard-version/node_modules/conventional-changelog-atom/CHANGELOG.md +0 -192
  39. package/node_modules/standard-version/node_modules/conventional-changelog-codemirror/CHANGELOG.md +0 -197
  40. package/node_modules/standard-version/node_modules/conventional-changelog-conventionalcommits/CHANGELOG.md +0 -245
  41. package/node_modules/standard-version/node_modules/conventional-changelog-core/CHANGELOG.md +0 -573
  42. package/node_modules/standard-version/node_modules/conventional-changelog-ember/CHANGELOG.md +0 -249
  43. package/node_modules/standard-version/node_modules/conventional-changelog-eslint/CHANGELOG.md +0 -234
  44. package/node_modules/standard-version/node_modules/conventional-changelog-express/CHANGELOG.md +0 -148
  45. package/node_modules/standard-version/node_modules/conventional-changelog-jquery/CHANGELOG.md +0 -237
  46. package/node_modules/standard-version/node_modules/conventional-changelog-jshint/CHANGELOG.md +0 -208
  47. package/node_modules/standard-version/node_modules/conventional-changelog-preset-loader/CHANGELOG.md +0 -183
  48. package/node_modules/standard-version/node_modules/conventional-changelog-writer/CHANGELOG.md +0 -603
  49. package/node_modules/standard-version/node_modules/conventional-commits-filter/CHANGELOG.md +0 -119
  50. package/node_modules/standard-version/node_modules/conventional-commits-parser/CHANGELOG.md +0 -463
  51. package/node_modules/standard-version/node_modules/conventional-recommended-bump/CHANGELOG.md +0 -432
  52. package/node_modules/standard-version/node_modules/git-raw-commits/CHANGELOG.md +0 -182
  53. package/node_modules/standard-version/node_modules/git-semver-tags/CHANGELOG.md +0 -206
  54. package/node_modules/standard-version/node_modules/yargs/CHANGELOG.md +0 -88
  55. package/node_modules/stringify-package/CHANGELOG.md +0 -16
  56. package/node_modules/wrap-ansi/node_modules/color-convert/CHANGELOG.md +0 -54
  57. package/node_modules/y18n/CHANGELOG.md +0 -100
  58. package/node_modules/yargs-parser/CHANGELOG.md +0 -263
package/.jsii CHANGED
@@ -15,7 +15,7 @@
15
15
  },
16
16
  "dependencies": {
17
17
  "constructs": "^10.4.2",
18
- "projen": ">=0.86.7 <1.0.0"
18
+ "projen": ">=0.91.20 <1.0.0"
19
19
  },
20
20
  "dependencyClosure": {
21
21
  "constructs": {
@@ -88,7 +88,7 @@
88
88
  "stability": "stable"
89
89
  },
90
90
  "homepage": "https://github.com/open-constructs/projen-pipelines.git",
91
- "jsiiVersion": "5.4.47 (build f6e4570)",
91
+ "jsiiVersion": "5.8.4 (build 26beabf)",
92
92
  "keywords": [
93
93
  "aws",
94
94
  "cdk",
@@ -344,7 +344,7 @@
344
344
  },
345
345
  "locationInModule": {
346
346
  "filename": "src/awscdk/bash.ts",
347
- "line": 76
347
+ "line": 78
348
348
  },
349
349
  "name": "engineType",
350
350
  "overrides": "projen-pipelines.CDKPipeline",
@@ -431,7 +431,7 @@
431
431
  },
432
432
  "locationInModule": {
433
433
  "filename": "src/awscdk/base.ts",
434
- "line": 183
434
+ "line": 187
435
435
  },
436
436
  "parameters": [
437
437
  {
@@ -451,7 +451,7 @@
451
451
  "kind": "class",
452
452
  "locationInModule": {
453
453
  "filename": "src/awscdk/base.ts",
454
- "line": 179
454
+ "line": 183
455
455
  },
456
456
  "methods": [
457
457
  {
@@ -461,7 +461,7 @@
461
461
  },
462
462
  "locationInModule": {
463
463
  "filename": "src/awscdk/base.ts",
464
- "line": 360
464
+ "line": 367
465
465
  },
466
466
  "name": "createApplicationEntrypoint",
467
467
  "protected": true
@@ -473,7 +473,7 @@
473
473
  },
474
474
  "locationInModule": {
475
475
  "filename": "src/awscdk/base.ts",
476
- "line": 538
476
+ "line": 548
477
477
  },
478
478
  "name": "createFeatureStage",
479
479
  "protected": true
@@ -485,7 +485,7 @@
485
485
  },
486
486
  "locationInModule": {
487
487
  "filename": "src/awscdk/base.ts",
488
- "line": 583
488
+ "line": 593
489
489
  },
490
490
  "name": "createIndependentStage",
491
491
  "parameters": [
@@ -508,7 +508,7 @@
508
508
  },
509
509
  "locationInModule": {
510
510
  "filename": "src/awscdk/base.ts",
511
- "line": 515
511
+ "line": 525
512
512
  },
513
513
  "name": "createPersonalStage",
514
514
  "protected": true
@@ -520,7 +520,7 @@
520
520
  },
521
521
  "locationInModule": {
522
522
  "filename": "src/awscdk/base.ts",
523
- "line": 561
523
+ "line": 571
524
524
  },
525
525
  "name": "createPipelineStage",
526
526
  "parameters": [
@@ -543,7 +543,7 @@
543
543
  },
544
544
  "locationInModule": {
545
545
  "filename": "src/awscdk/base.ts",
546
- "line": 463
546
+ "line": 470
547
547
  },
548
548
  "name": "createReleaseTasks",
549
549
  "protected": true
@@ -554,7 +554,7 @@
554
554
  },
555
555
  "locationInModule": {
556
556
  "filename": "src/awscdk/base.ts",
557
- "line": 346
557
+ "line": 353
558
558
  },
559
559
  "name": "createSafeStageName",
560
560
  "parameters": [
@@ -579,7 +579,7 @@
579
579
  },
580
580
  "locationInModule": {
581
581
  "filename": "src/awscdk/base.ts",
582
- "line": 231
582
+ "line": 235
583
583
  },
584
584
  "name": "engineType",
585
585
  "returns": {
@@ -594,7 +594,7 @@
594
594
  },
595
595
  "locationInModule": {
596
596
  "filename": "src/awscdk/base.ts",
597
- "line": 601
597
+ "line": 611
598
598
  },
599
599
  "name": "getCliStackPattern",
600
600
  "parameters": [
@@ -618,7 +618,7 @@
618
618
  },
619
619
  "locationInModule": {
620
620
  "filename": "src/awscdk/base.ts",
621
- "line": 296
621
+ "line": 300
622
622
  },
623
623
  "name": "provideAssemblyUploadStep",
624
624
  "protected": true,
@@ -634,7 +634,7 @@
634
634
  },
635
635
  "locationInModule": {
636
636
  "filename": "src/awscdk/base.ts",
637
- "line": 265
637
+ "line": 269
638
638
  },
639
639
  "name": "provideAssetUploadStep",
640
640
  "parameters": [
@@ -659,7 +659,7 @@
659
659
  },
660
660
  "locationInModule": {
661
661
  "filename": "src/awscdk/base.ts",
662
- "line": 303
662
+ "line": 310
663
663
  },
664
664
  "name": "provideDeployStep",
665
665
  "parameters": [
@@ -683,7 +683,7 @@
683
683
  },
684
684
  "locationInModule": {
685
685
  "filename": "src/awscdk/base.ts",
686
- "line": 314
686
+ "line": 321
687
687
  },
688
688
  "name": "provideDiffStep",
689
689
  "parameters": [
@@ -714,7 +714,7 @@
714
714
  },
715
715
  "locationInModule": {
716
716
  "filename": "src/awscdk/base.ts",
717
- "line": 233
717
+ "line": 237
718
718
  },
719
719
  "name": "provideInstallStep",
720
720
  "protected": true,
@@ -730,7 +730,7 @@
730
730
  },
731
731
  "locationInModule": {
732
732
  "filename": "src/awscdk/base.ts",
733
- "line": 242
733
+ "line": 246
734
734
  },
735
735
  "name": "provideSynthStep",
736
736
  "protected": true,
@@ -746,7 +746,7 @@
746
746
  },
747
747
  "locationInModule": {
748
748
  "filename": "src/awscdk/base.ts",
749
- "line": 327
749
+ "line": 334
750
750
  },
751
751
  "name": "renderInstallPackageCommands",
752
752
  "parameters": [
@@ -786,7 +786,7 @@
786
786
  "immutable": true,
787
787
  "locationInModule": {
788
788
  "filename": "src/awscdk/base.ts",
789
- "line": 181
789
+ "line": 185
790
790
  },
791
791
  "name": "branchName",
792
792
  "type": {
@@ -800,7 +800,7 @@
800
800
  "immutable": true,
801
801
  "locationInModule": {
802
802
  "filename": "src/awscdk/base.ts",
803
- "line": 180
803
+ "line": 184
804
804
  },
805
805
  "name": "stackPrefix",
806
806
  "type": {
@@ -813,7 +813,7 @@
813
813
  },
814
814
  "locationInModule": {
815
815
  "filename": "src/awscdk/base.ts",
816
- "line": 183
816
+ "line": 187
817
817
  },
818
818
  "name": "app",
819
819
  "protected": true,
@@ -827,7 +827,7 @@
827
827
  },
828
828
  "locationInModule": {
829
829
  "filename": "src/awscdk/base.ts",
830
- "line": 183
830
+ "line": 187
831
831
  },
832
832
  "name": "baseOptions",
833
833
  "protected": true,
@@ -863,30 +863,13 @@
863
863
  "immutable": true,
864
864
  "locationInModule": {
865
865
  "filename": "src/awscdk/base.ts",
866
- "line": 141
866
+ "line": 145
867
867
  },
868
868
  "name": "iamRoleArns",
869
869
  "type": {
870
870
  "fqn": "projen-pipelines.IamRoleConfig"
871
871
  }
872
872
  },
873
- {
874
- "abstract": true,
875
- "docs": {
876
- "remarks": "A namespace helps group related resources together, providing\nbetter organization and ease of management.",
877
- "stability": "stable",
878
- "summary": "This field determines the NPM namespace to be used when packaging CDK cloud assemblies."
879
- },
880
- "immutable": true,
881
- "locationInModule": {
882
- "filename": "src/awscdk/base.ts",
883
- "line": 138
884
- },
885
- "name": "pkgNamespace",
886
- "type": {
887
- "primitive": "string"
888
- }
889
- },
890
873
  {
891
874
  "abstract": true,
892
875
  "docs": {
@@ -896,7 +879,7 @@
896
879
  "immutable": true,
897
880
  "locationInModule": {
898
881
  "filename": "src/awscdk/base.ts",
899
- "line": 146
882
+ "line": 150
900
883
  },
901
884
  "name": "stages",
902
885
  "type": {
@@ -954,7 +937,7 @@
954
937
  "immutable": true,
955
938
  "locationInModule": {
956
939
  "filename": "src/awscdk/base.ts",
957
- "line": 155
940
+ "line": 159
958
941
  },
959
942
  "name": "featureStages",
960
943
  "optional": true,
@@ -971,7 +954,7 @@
971
954
  "immutable": true,
972
955
  "locationInModule": {
973
956
  "filename": "src/awscdk/base.ts",
974
- "line": 149
957
+ "line": 153
975
958
  },
976
959
  "name": "independentStages",
977
960
  "optional": true,
@@ -993,7 +976,7 @@
993
976
  "immutable": true,
994
977
  "locationInModule": {
995
978
  "filename": "src/awscdk/base.ts",
996
- "line": 152
979
+ "line": 156
997
980
  },
998
981
  "name": "personalStage",
999
982
  "optional": true,
@@ -1001,6 +984,25 @@
1001
984
  "fqn": "projen-pipelines.StageOptions"
1002
985
  }
1003
986
  },
987
+ {
988
+ "abstract": true,
989
+ "docs": {
990
+ "default": "-",
991
+ "remarks": "A namespace helps group related resources together, providing\nbetter organization and ease of management.\n\nThis is only needed if you need to version and upload the cloud assembly to a package repository.",
992
+ "stability": "stable",
993
+ "summary": "This field determines the NPM namespace to be used when packaging CDK cloud assemblies."
994
+ },
995
+ "immutable": true,
996
+ "locationInModule": {
997
+ "filename": "src/awscdk/base.ts",
998
+ "line": 142
999
+ },
1000
+ "name": "pkgNamespace",
1001
+ "optional": true,
1002
+ "type": {
1003
+ "primitive": "string"
1004
+ }
1005
+ },
1004
1006
  {
1005
1007
  "abstract": true,
1006
1008
  "docs": {
@@ -1009,7 +1011,7 @@
1009
1011
  "immutable": true,
1010
1012
  "locationInModule": {
1011
1013
  "filename": "src/awscdk/base.ts",
1012
- "line": 168
1014
+ "line": 172
1013
1015
  },
1014
1016
  "name": "postSynthCommands",
1015
1017
  "optional": true,
@@ -1030,7 +1032,7 @@
1030
1032
  "immutable": true,
1031
1033
  "locationInModule": {
1032
1034
  "filename": "src/awscdk/base.ts",
1033
- "line": 172
1035
+ "line": 176
1034
1036
  },
1035
1037
  "name": "postSynthSteps",
1036
1038
  "optional": true,
@@ -1051,7 +1053,7 @@
1051
1053
  "immutable": true,
1052
1054
  "locationInModule": {
1053
1055
  "filename": "src/awscdk/base.ts",
1054
- "line": 166
1056
+ "line": 170
1055
1057
  },
1056
1058
  "name": "preInstallCommands",
1057
1059
  "optional": true,
@@ -1072,7 +1074,7 @@
1072
1074
  "immutable": true,
1073
1075
  "locationInModule": {
1074
1076
  "filename": "src/awscdk/base.ts",
1075
- "line": 170
1077
+ "line": 174
1076
1078
  },
1077
1079
  "name": "preInstallSteps",
1078
1080
  "optional": true,
@@ -1093,7 +1095,7 @@
1093
1095
  "immutable": true,
1094
1096
  "locationInModule": {
1095
1097
  "filename": "src/awscdk/base.ts",
1096
- "line": 167
1098
+ "line": 171
1097
1099
  },
1098
1100
  "name": "preSynthCommands",
1099
1101
  "optional": true,
@@ -1114,7 +1116,7 @@
1114
1116
  "immutable": true,
1115
1117
  "locationInModule": {
1116
1118
  "filename": "src/awscdk/base.ts",
1117
- "line": 171
1119
+ "line": 175
1118
1120
  },
1119
1121
  "name": "preSynthSteps",
1120
1122
  "optional": true,
@@ -1684,7 +1686,7 @@
1684
1686
  },
1685
1687
  "locationInModule": {
1686
1688
  "filename": "src/awscdk/github.ts",
1687
- "line": 154
1689
+ "line": 157
1688
1690
  },
1689
1691
  "name": "createAssetUpload"
1690
1692
  },
@@ -1695,7 +1697,7 @@
1695
1697
  },
1696
1698
  "locationInModule": {
1697
1699
  "filename": "src/awscdk/github.ts",
1698
- "line": 209
1700
+ "line": 212
1699
1701
  },
1700
1702
  "name": "createDeployment",
1701
1703
  "parameters": [
@@ -1717,7 +1719,7 @@
1717
1719
  },
1718
1720
  "locationInModule": {
1719
1721
  "filename": "src/awscdk/github.ts",
1720
- "line": 325
1722
+ "line": 328
1721
1723
  },
1722
1724
  "name": "createIndependentDeployment",
1723
1725
  "parameters": [
@@ -1739,7 +1741,7 @@
1739
1741
  },
1740
1742
  "locationInModule": {
1741
1743
  "filename": "src/awscdk/github.ts",
1742
- "line": 106
1744
+ "line": 109
1743
1745
  },
1744
1746
  "name": "engineType",
1745
1747
  "overrides": "projen-pipelines.CDKPipeline",
@@ -3552,6 +3554,6 @@
3552
3554
  "symbolId": "src/steps/artifact-steps:UploadArtifactStepConfig"
3553
3555
  }
3554
3556
  },
3555
- "version": "0.2.6",
3556
- "fingerprint": "kYz26c2TBmtTZU6lovEMeEKMsI4iO3DaUCDhdJlt0Co="
3557
+ "version": "0.2.8",
3558
+ "fingerprint": "nKYpoJOQ7kkKZXi5Her2lnfeOQrbVBLdPLZjr2xqRVA="
3557
3559
  }
package/API.md CHANGED
@@ -982,13 +982,13 @@ const bashCDKPipelineOptions: BashCDKPipelineOptions = { ... }
982
982
  | **Name** | **Type** | **Description** |
983
983
  | --- | --- | --- |
984
984
  | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.iamRoleArns">iamRoleArns</a></code> | <code><a href="#projen-pipelines.IamRoleConfig">IamRoleConfig</a></code> | IAM config. |
985
- | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.pkgNamespace">pkgNamespace</a></code> | <code>string</code> | This field determines the NPM namespace to be used when packaging CDK cloud assemblies. |
986
985
  | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.stages">stages</a></code> | <code><a href="#projen-pipelines.DeploymentStage">DeploymentStage</a>[]</code> | This field specifies a list of stages that should be deployed using a CI/CD pipeline. |
987
986
  | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.branchName">branchName</a></code> | <code>string</code> | the name of the branch to deploy from. |
988
987
  | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.deploySubStacks">deploySubStacks</a></code> | <code>boolean</code> | If set to true all CDK actions will also include <stackName>/* to deploy/diff/destroy sub stacks of the main stack. |
989
988
  | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.featureStages">featureStages</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | This specifies details for feature stages. |
990
989
  | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.independentStages">independentStages</a></code> | <code><a href="#projen-pipelines.IndependentStage">IndependentStage</a>[]</code> | This specifies details for independent stages. |
991
990
  | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.personalStage">personalStage</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | This specifies details for a personal stage. |
991
+ | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.pkgNamespace">pkgNamespace</a></code> | <code>string</code> | This field determines the NPM namespace to be used when packaging CDK cloud assemblies. |
992
992
  | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.postSynthCommands">postSynthCommands</a></code> | <code>string[]</code> | *No description.* |
993
993
  | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.postSynthSteps">postSynthSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
994
994
  | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.preInstallCommands">preInstallCommands</a></code> | <code>string[]</code> | *No description.* |
@@ -1011,21 +1011,6 @@ IAM config.
1011
1011
 
1012
1012
  ---
1013
1013
 
1014
- ##### `pkgNamespace`<sup>Required</sup> <a name="pkgNamespace" id="projen-pipelines.BashCDKPipelineOptions.property.pkgNamespace"></a>
1015
-
1016
- ```typescript
1017
- public readonly pkgNamespace: string;
1018
- ```
1019
-
1020
- - *Type:* string
1021
-
1022
- This field determines the NPM namespace to be used when packaging CDK cloud assemblies.
1023
-
1024
- A namespace helps group related resources together, providing
1025
- better organization and ease of management.
1026
-
1027
- ---
1028
-
1029
1014
  ##### `stages`<sup>Required</sup> <a name="stages" id="projen-pipelines.BashCDKPipelineOptions.property.stages"></a>
1030
1015
 
1031
1016
  ```typescript
@@ -1102,6 +1087,24 @@ This specifies details for a personal stage.
1102
1087
 
1103
1088
  ---
1104
1089
 
1090
+ ##### `pkgNamespace`<sup>Optional</sup> <a name="pkgNamespace" id="projen-pipelines.BashCDKPipelineOptions.property.pkgNamespace"></a>
1091
+
1092
+ ```typescript
1093
+ public readonly pkgNamespace: string;
1094
+ ```
1095
+
1096
+ - *Type:* string
1097
+ - *Default:*
1098
+
1099
+ This field determines the NPM namespace to be used when packaging CDK cloud assemblies.
1100
+
1101
+ A namespace helps group related resources together, providing
1102
+ better organization and ease of management.
1103
+
1104
+ This is only needed if you need to version and upload the cloud assembly to a package repository.
1105
+
1106
+ ---
1107
+
1105
1108
  ##### `postSynthCommands`<sup>Optional</sup> <a name="postSynthCommands" id="projen-pipelines.BashCDKPipelineOptions.property.postSynthCommands"></a>
1106
1109
 
1107
1110
  ```typescript
@@ -1228,13 +1231,13 @@ const cDKPipelineOptions: CDKPipelineOptions = { ... }
1228
1231
  | **Name** | **Type** | **Description** |
1229
1232
  | --- | --- | --- |
1230
1233
  | <code><a href="#projen-pipelines.CDKPipelineOptions.property.iamRoleArns">iamRoleArns</a></code> | <code><a href="#projen-pipelines.IamRoleConfig">IamRoleConfig</a></code> | IAM config. |
1231
- | <code><a href="#projen-pipelines.CDKPipelineOptions.property.pkgNamespace">pkgNamespace</a></code> | <code>string</code> | This field determines the NPM namespace to be used when packaging CDK cloud assemblies. |
1232
1234
  | <code><a href="#projen-pipelines.CDKPipelineOptions.property.stages">stages</a></code> | <code><a href="#projen-pipelines.DeploymentStage">DeploymentStage</a>[]</code> | This field specifies a list of stages that should be deployed using a CI/CD pipeline. |
1233
1235
  | <code><a href="#projen-pipelines.CDKPipelineOptions.property.branchName">branchName</a></code> | <code>string</code> | the name of the branch to deploy from. |
1234
1236
  | <code><a href="#projen-pipelines.CDKPipelineOptions.property.deploySubStacks">deploySubStacks</a></code> | <code>boolean</code> | If set to true all CDK actions will also include <stackName>/* to deploy/diff/destroy sub stacks of the main stack. |
1235
1237
  | <code><a href="#projen-pipelines.CDKPipelineOptions.property.featureStages">featureStages</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | This specifies details for feature stages. |
1236
1238
  | <code><a href="#projen-pipelines.CDKPipelineOptions.property.independentStages">independentStages</a></code> | <code><a href="#projen-pipelines.IndependentStage">IndependentStage</a>[]</code> | This specifies details for independent stages. |
1237
1239
  | <code><a href="#projen-pipelines.CDKPipelineOptions.property.personalStage">personalStage</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | This specifies details for a personal stage. |
1240
+ | <code><a href="#projen-pipelines.CDKPipelineOptions.property.pkgNamespace">pkgNamespace</a></code> | <code>string</code> | This field determines the NPM namespace to be used when packaging CDK cloud assemblies. |
1238
1241
  | <code><a href="#projen-pipelines.CDKPipelineOptions.property.postSynthCommands">postSynthCommands</a></code> | <code>string[]</code> | *No description.* |
1239
1242
  | <code><a href="#projen-pipelines.CDKPipelineOptions.property.postSynthSteps">postSynthSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
1240
1243
  | <code><a href="#projen-pipelines.CDKPipelineOptions.property.preInstallCommands">preInstallCommands</a></code> | <code>string[]</code> | *No description.* |
@@ -1257,21 +1260,6 @@ IAM config.
1257
1260
 
1258
1261
  ---
1259
1262
 
1260
- ##### `pkgNamespace`<sup>Required</sup> <a name="pkgNamespace" id="projen-pipelines.CDKPipelineOptions.property.pkgNamespace"></a>
1261
-
1262
- ```typescript
1263
- public readonly pkgNamespace: string;
1264
- ```
1265
-
1266
- - *Type:* string
1267
-
1268
- This field determines the NPM namespace to be used when packaging CDK cloud assemblies.
1269
-
1270
- A namespace helps group related resources together, providing
1271
- better organization and ease of management.
1272
-
1273
- ---
1274
-
1275
1263
  ##### `stages`<sup>Required</sup> <a name="stages" id="projen-pipelines.CDKPipelineOptions.property.stages"></a>
1276
1264
 
1277
1265
  ```typescript
@@ -1348,6 +1336,24 @@ This specifies details for a personal stage.
1348
1336
 
1349
1337
  ---
1350
1338
 
1339
+ ##### `pkgNamespace`<sup>Optional</sup> <a name="pkgNamespace" id="projen-pipelines.CDKPipelineOptions.property.pkgNamespace"></a>
1340
+
1341
+ ```typescript
1342
+ public readonly pkgNamespace: string;
1343
+ ```
1344
+
1345
+ - *Type:* string
1346
+ - *Default:*
1347
+
1348
+ This field determines the NPM namespace to be used when packaging CDK cloud assemblies.
1349
+
1350
+ A namespace helps group related resources together, providing
1351
+ better organization and ease of management.
1352
+
1353
+ This is only needed if you need to version and upload the cloud assembly to a package repository.
1354
+
1355
+ ---
1356
+
1351
1357
  ##### `postSynthCommands`<sup>Optional</sup> <a name="postSynthCommands" id="projen-pipelines.CDKPipelineOptions.property.postSynthCommands"></a>
1352
1358
 
1353
1359
  ```typescript
@@ -1747,13 +1753,13 @@ const githubCDKPipelineOptions: GithubCDKPipelineOptions = { ... }
1747
1753
  | **Name** | **Type** | **Description** |
1748
1754
  | --- | --- | --- |
1749
1755
  | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.iamRoleArns">iamRoleArns</a></code> | <code><a href="#projen-pipelines.IamRoleConfig">IamRoleConfig</a></code> | IAM config. |
1750
- | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.pkgNamespace">pkgNamespace</a></code> | <code>string</code> | This field determines the NPM namespace to be used when packaging CDK cloud assemblies. |
1751
1756
  | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.stages">stages</a></code> | <code><a href="#projen-pipelines.DeploymentStage">DeploymentStage</a>[]</code> | This field specifies a list of stages that should be deployed using a CI/CD pipeline. |
1752
1757
  | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.branchName">branchName</a></code> | <code>string</code> | the name of the branch to deploy from. |
1753
1758
  | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.deploySubStacks">deploySubStacks</a></code> | <code>boolean</code> | If set to true all CDK actions will also include <stackName>/* to deploy/diff/destroy sub stacks of the main stack. |
1754
1759
  | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.featureStages">featureStages</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | This specifies details for feature stages. |
1755
1760
  | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.independentStages">independentStages</a></code> | <code><a href="#projen-pipelines.IndependentStage">IndependentStage</a>[]</code> | This specifies details for independent stages. |
1756
1761
  | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.personalStage">personalStage</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | This specifies details for a personal stage. |
1762
+ | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.pkgNamespace">pkgNamespace</a></code> | <code>string</code> | This field determines the NPM namespace to be used when packaging CDK cloud assemblies. |
1757
1763
  | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.postSynthCommands">postSynthCommands</a></code> | <code>string[]</code> | *No description.* |
1758
1764
  | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.postSynthSteps">postSynthSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
1759
1765
  | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.preInstallCommands">preInstallCommands</a></code> | <code>string[]</code> | *No description.* |
@@ -1779,21 +1785,6 @@ IAM config.
1779
1785
 
1780
1786
  ---
1781
1787
 
1782
- ##### `pkgNamespace`<sup>Required</sup> <a name="pkgNamespace" id="projen-pipelines.GithubCDKPipelineOptions.property.pkgNamespace"></a>
1783
-
1784
- ```typescript
1785
- public readonly pkgNamespace: string;
1786
- ```
1787
-
1788
- - *Type:* string
1789
-
1790
- This field determines the NPM namespace to be used when packaging CDK cloud assemblies.
1791
-
1792
- A namespace helps group related resources together, providing
1793
- better organization and ease of management.
1794
-
1795
- ---
1796
-
1797
1788
  ##### `stages`<sup>Required</sup> <a name="stages" id="projen-pipelines.GithubCDKPipelineOptions.property.stages"></a>
1798
1789
 
1799
1790
  ```typescript
@@ -1870,6 +1861,24 @@ This specifies details for a personal stage.
1870
1861
 
1871
1862
  ---
1872
1863
 
1864
+ ##### `pkgNamespace`<sup>Optional</sup> <a name="pkgNamespace" id="projen-pipelines.GithubCDKPipelineOptions.property.pkgNamespace"></a>
1865
+
1866
+ ```typescript
1867
+ public readonly pkgNamespace: string;
1868
+ ```
1869
+
1870
+ - *Type:* string
1871
+ - *Default:*
1872
+
1873
+ This field determines the NPM namespace to be used when packaging CDK cloud assemblies.
1874
+
1875
+ A namespace helps group related resources together, providing
1876
+ better organization and ease of management.
1877
+
1878
+ This is only needed if you need to version and upload the cloud assembly to a package repository.
1879
+
1880
+ ---
1881
+
1873
1882
  ##### `postSynthCommands`<sup>Optional</sup> <a name="postSynthCommands" id="projen-pipelines.GithubCDKPipelineOptions.property.postSynthCommands"></a>
1874
1883
 
1875
1884
  ```typescript
@@ -2104,13 +2113,13 @@ const gitlabCDKPipelineOptions: GitlabCDKPipelineOptions = { ... }
2104
2113
  | **Name** | **Type** | **Description** |
2105
2114
  | --- | --- | --- |
2106
2115
  | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.iamRoleArns">iamRoleArns</a></code> | <code><a href="#projen-pipelines.IamRoleConfig">IamRoleConfig</a></code> | IAM config. |
2107
- | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.pkgNamespace">pkgNamespace</a></code> | <code>string</code> | This field determines the NPM namespace to be used when packaging CDK cloud assemblies. |
2108
2116
  | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.stages">stages</a></code> | <code><a href="#projen-pipelines.DeploymentStage">DeploymentStage</a>[]</code> | This field specifies a list of stages that should be deployed using a CI/CD pipeline. |
2109
2117
  | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.branchName">branchName</a></code> | <code>string</code> | the name of the branch to deploy from. |
2110
2118
  | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.deploySubStacks">deploySubStacks</a></code> | <code>boolean</code> | If set to true all CDK actions will also include <stackName>/* to deploy/diff/destroy sub stacks of the main stack. |
2111
2119
  | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.featureStages">featureStages</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | This specifies details for feature stages. |
2112
2120
  | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.independentStages">independentStages</a></code> | <code><a href="#projen-pipelines.IndependentStage">IndependentStage</a>[]</code> | This specifies details for independent stages. |
2113
2121
  | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.personalStage">personalStage</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | This specifies details for a personal stage. |
2122
+ | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.pkgNamespace">pkgNamespace</a></code> | <code>string</code> | This field determines the NPM namespace to be used when packaging CDK cloud assemblies. |
2114
2123
  | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.postSynthCommands">postSynthCommands</a></code> | <code>string[]</code> | *No description.* |
2115
2124
  | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.postSynthSteps">postSynthSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
2116
2125
  | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.preInstallCommands">preInstallCommands</a></code> | <code>string[]</code> | *No description.* |
@@ -2135,21 +2144,6 @@ IAM config.
2135
2144
 
2136
2145
  ---
2137
2146
 
2138
- ##### `pkgNamespace`<sup>Required</sup> <a name="pkgNamespace" id="projen-pipelines.GitlabCDKPipelineOptions.property.pkgNamespace"></a>
2139
-
2140
- ```typescript
2141
- public readonly pkgNamespace: string;
2142
- ```
2143
-
2144
- - *Type:* string
2145
-
2146
- This field determines the NPM namespace to be used when packaging CDK cloud assemblies.
2147
-
2148
- A namespace helps group related resources together, providing
2149
- better organization and ease of management.
2150
-
2151
- ---
2152
-
2153
2147
  ##### `stages`<sup>Required</sup> <a name="stages" id="projen-pipelines.GitlabCDKPipelineOptions.property.stages"></a>
2154
2148
 
2155
2149
  ```typescript
@@ -2226,6 +2220,24 @@ This specifies details for a personal stage.
2226
2220
 
2227
2221
  ---
2228
2222
 
2223
+ ##### `pkgNamespace`<sup>Optional</sup> <a name="pkgNamespace" id="projen-pipelines.GitlabCDKPipelineOptions.property.pkgNamespace"></a>
2224
+
2225
+ ```typescript
2226
+ public readonly pkgNamespace: string;
2227
+ ```
2228
+
2229
+ - *Type:* string
2230
+ - *Default:*
2231
+
2232
+ This field determines the NPM namespace to be used when packaging CDK cloud assemblies.
2233
+
2234
+ A namespace helps group related resources together, providing
2235
+ better organization and ease of management.
2236
+
2237
+ This is only needed if you need to version and upload the cloud assembly to a package repository.
2238
+
2239
+ ---
2240
+
2229
2241
  ##### `postSynthCommands`<sup>Optional</sup> <a name="postSynthCommands" id="projen-pipelines.GitlabCDKPipelineOptions.property.postSynthCommands"></a>
2230
2242
 
2231
2243
  ```typescript
@@ -114,8 +114,12 @@ export interface CDKPipelineOptions {
114
114
  * This field determines the NPM namespace to be used when packaging CDK cloud
115
115
  * assemblies. A namespace helps group related resources together, providing
116
116
  * better organization and ease of management.
117
+ *
118
+ * This is only needed if you need to version and upload the cloud assembly to a package repository.
119
+ *
120
+ * @default -
117
121
  */
118
- readonly pkgNamespace: string;
122
+ readonly pkgNamespace?: string;
119
123
  /** IAM config */
120
124
  readonly iamRoleArns: IamRoleConfig;
121
125
  /**