projen 0.58.10 → 0.58.13

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 (132) hide show
  1. package/.jsii +1684 -13
  2. package/docs/README.md +1 -0
  3. package/docs/api/API.md +383 -0
  4. package/docs/circleci.md +87 -0
  5. package/lib/awscdk/auto-discover.js +5 -5
  6. package/lib/awscdk/awscdk-app-java.js +1 -1
  7. package/lib/awscdk/awscdk-app-py.js +1 -1
  8. package/lib/awscdk/awscdk-app-ts.js +1 -1
  9. package/lib/awscdk/awscdk-construct.js +2 -2
  10. package/lib/awscdk/awscdk-deps-java.js +1 -1
  11. package/lib/awscdk/awscdk-deps-js.js +1 -1
  12. package/lib/awscdk/awscdk-deps.js +1 -1
  13. package/lib/awscdk/cdk-config.js +1 -1
  14. package/lib/awscdk/cdk-tasks.js +1 -1
  15. package/lib/awscdk/integration-test.js +1 -1
  16. package/lib/awscdk/lambda-extension.js +1 -1
  17. package/lib/awscdk/lambda-function.js +2 -2
  18. package/lib/build/build-workflow.js +1 -1
  19. package/lib/cdk/auto-discover-base.js +2 -2
  20. package/lib/cdk/construct-lib.js +1 -1
  21. package/lib/cdk/integration-test-base.js +1 -1
  22. package/lib/cdk/jsii-docgen.js +1 -1
  23. package/lib/cdk/jsii-project.js +1 -1
  24. package/lib/cdk8s/auto-discover.js +2 -2
  25. package/lib/cdk8s/cdk8s-app-ts.js +1 -1
  26. package/lib/cdk8s/cdk8s-construct.js +1 -1
  27. package/lib/cdk8s/integration-test.js +1 -1
  28. package/lib/cdktf/cdktf-construct.js +1 -1
  29. package/lib/circleci/circleci.d.ts +132 -0
  30. package/lib/circleci/circleci.js +118 -0
  31. package/lib/circleci/constant.d.ts +5 -0
  32. package/lib/circleci/constant.js +10 -0
  33. package/lib/circleci/index.d.ts +3 -0
  34. package/lib/circleci/index.js +16 -0
  35. package/lib/circleci/model.d.ts +240 -0
  36. package/lib/circleci/model.js +37 -0
  37. package/lib/component.js +1 -1
  38. package/lib/dependencies.js +1 -1
  39. package/lib/dev-env.js +1 -1
  40. package/lib/docker-compose.js +2 -2
  41. package/lib/file.js +1 -1
  42. package/lib/gitattributes.js +1 -1
  43. package/lib/github/auto-approve.js +1 -1
  44. package/lib/github/auto-merge.js +1 -1
  45. package/lib/github/dependabot.js +1 -1
  46. package/lib/github/github-credentials.js +1 -1
  47. package/lib/github/github-project.js +1 -1
  48. package/lib/github/github.js +1 -1
  49. package/lib/github/mergify.js +1 -1
  50. package/lib/github/pr-template.js +1 -1
  51. package/lib/github/pull-request-lint.js +1 -1
  52. package/lib/github/stale.js +1 -1
  53. package/lib/github/task-workflow.js +1 -1
  54. package/lib/github/workflows.js +1 -1
  55. package/lib/gitlab/configuration.js +1 -1
  56. package/lib/gitlab/gitlab-configuration.js +1 -1
  57. package/lib/gitlab/nested-configuration.js +1 -1
  58. package/lib/gitpod.js +1 -1
  59. package/lib/ignore-file.js +1 -1
  60. package/lib/index.d.ts +1 -0
  61. package/lib/index.js +2 -1
  62. package/lib/ini.js +1 -1
  63. package/lib/java/java-project.js +1 -1
  64. package/lib/java/junit.js +1 -1
  65. package/lib/java/maven-compile.js +1 -1
  66. package/lib/java/maven-packaging.js +1 -1
  67. package/lib/java/maven-sample.js +1 -1
  68. package/lib/java/pom.js +1 -1
  69. package/lib/java/projenrc.js +1 -1
  70. package/lib/javascript/bundler.js +1 -1
  71. package/lib/javascript/eslint.js +1 -1
  72. package/lib/javascript/jest.js +1 -1
  73. package/lib/javascript/node-package.js +1 -1
  74. package/lib/javascript/node-project.js +1 -1
  75. package/lib/javascript/npm-config.js +1 -1
  76. package/lib/javascript/prettier.js +1 -1
  77. package/lib/javascript/projenrc.js +1 -1
  78. package/lib/javascript/typescript-config.js +1 -1
  79. package/lib/javascript/upgrade-dependencies.js +2 -2
  80. package/lib/json.js +1 -1
  81. package/lib/license.js +1 -1
  82. package/lib/logger.js +1 -1
  83. package/lib/makefile.js +1 -1
  84. package/lib/object-file.js +1 -1
  85. package/lib/project-build.js +1 -1
  86. package/lib/project.js +1 -1
  87. package/lib/projects.js +1 -1
  88. package/lib/projenrc-json.js +1 -1
  89. package/lib/python/pip.js +1 -1
  90. package/lib/python/poetry.js +2 -2
  91. package/lib/python/projenrc.js +1 -1
  92. package/lib/python/pytest-sample.js +1 -1
  93. package/lib/python/pytest.js +1 -1
  94. package/lib/python/python-project.js +1 -1
  95. package/lib/python/python-sample.js +1 -1
  96. package/lib/python/requirements-file.js +1 -1
  97. package/lib/python/setuppy.js +1 -1
  98. package/lib/python/setuptools.js +1 -1
  99. package/lib/python/venv.js +1 -1
  100. package/lib/readme.js +1 -1
  101. package/lib/release/publisher.js +1 -1
  102. package/lib/release/release-trigger.js +1 -1
  103. package/lib/release/release.js +1 -1
  104. package/lib/renovatebot.js +1 -1
  105. package/lib/sample-file.js +2 -2
  106. package/lib/semver.js +1 -1
  107. package/lib/source-code.js +1 -1
  108. package/lib/task-runtime.js +1 -1
  109. package/lib/task.js +1 -1
  110. package/lib/tasks.js +1 -1
  111. package/lib/testing.js +1 -1
  112. package/lib/textfile.js +1 -1
  113. package/lib/toml.js +1 -1
  114. package/lib/typescript/projenrc.js +1 -1
  115. package/lib/typescript/typescript-typedoc.js +1 -1
  116. package/lib/typescript/typescript.js +3 -3
  117. package/lib/util.d.ts +1 -0
  118. package/lib/util.js +25 -2
  119. package/lib/version.js +1 -1
  120. package/lib/vscode/devcontainer.js +1 -1
  121. package/lib/vscode/launch-config.js +1 -1
  122. package/lib/vscode/vscode.js +1 -1
  123. package/lib/web/next.js +3 -3
  124. package/lib/web/postcss.js +1 -1
  125. package/lib/web/react.js +4 -4
  126. package/lib/web/tailwind.js +1 -1
  127. package/lib/xmlfile.js +1 -1
  128. package/lib/yaml.js +1 -1
  129. package/node_modules/xmlbuilder2/node_modules/@types/node/README.md +1 -1
  130. package/node_modules/xmlbuilder2/node_modules/@types/node/package.json +2 -2
  131. package/node_modules/xmlbuilder2/node_modules/@types/node/url.d.ts +5 -1
  132. package/package.json +2 -2
package/.jsii CHANGED
@@ -60,38 +60,45 @@
60
60
  "projen.awscdk": {
61
61
  "locationInModule": {
62
62
  "filename": "src/index.ts",
63
- "line": 46
63
+ "line": 47
64
64
  },
65
65
  "symbolId": "src/awscdk/index:"
66
66
  },
67
67
  "projen.build": {
68
68
  "locationInModule": {
69
69
  "filename": "src/index.ts",
70
- "line": 50
70
+ "line": 51
71
71
  },
72
72
  "symbolId": "src/build/index:"
73
73
  },
74
74
  "projen.cdk": {
75
75
  "locationInModule": {
76
76
  "filename": "src/index.ts",
77
- "line": 49
77
+ "line": 50
78
78
  },
79
79
  "symbolId": "src/cdk/index:"
80
80
  },
81
81
  "projen.cdk8s": {
82
82
  "locationInModule": {
83
83
  "filename": "src/index.ts",
84
- "line": 47
84
+ "line": 48
85
85
  },
86
86
  "symbolId": "src/cdk8s/index:"
87
87
  },
88
88
  "projen.cdktf": {
89
89
  "locationInModule": {
90
90
  "filename": "src/index.ts",
91
- "line": 48
91
+ "line": 49
92
92
  },
93
93
  "symbolId": "src/cdktf/index:"
94
94
  },
95
+ "projen.circleci": {
96
+ "locationInModule": {
97
+ "filename": "src/index.ts",
98
+ "line": 40
99
+ },
100
+ "symbolId": "src/circleci/index:"
101
+ },
95
102
  "projen.github": {
96
103
  "locationInModule": {
97
104
  "filename": "src/index.ts",
@@ -116,42 +123,42 @@
116
123
  "projen.java": {
117
124
  "locationInModule": {
118
125
  "filename": "src/index.ts",
119
- "line": 41
126
+ "line": 42
120
127
  },
121
128
  "symbolId": "src/java/index:"
122
129
  },
123
130
  "projen.javascript": {
124
131
  "locationInModule": {
125
132
  "filename": "src/index.ts",
126
- "line": 44
133
+ "line": 45
127
134
  },
128
135
  "symbolId": "src/javascript/index:"
129
136
  },
130
137
  "projen.python": {
131
138
  "locationInModule": {
132
139
  "filename": "src/index.ts",
133
- "line": 42
140
+ "line": 43
134
141
  },
135
142
  "symbolId": "src/python/index:"
136
143
  },
137
144
  "projen.release": {
138
145
  "locationInModule": {
139
146
  "filename": "src/index.ts",
140
- "line": 45
147
+ "line": 46
141
148
  },
142
149
  "symbolId": "src/release/index:"
143
150
  },
144
151
  "projen.typescript": {
145
152
  "locationInModule": {
146
153
  "filename": "src/index.ts",
147
- "line": 43
154
+ "line": 44
148
155
  },
149
156
  "symbolId": "src/typescript/index:"
150
157
  },
151
158
  "projen.vscode": {
152
159
  "locationInModule": {
153
160
  "filename": "src/index.ts",
154
- "line": 40
161
+ "line": 41
155
162
  },
156
163
  "symbolId": "src/vscode/index:"
157
164
  },
@@ -15568,6 +15575,1670 @@
15568
15575
  ],
15569
15576
  "symbolId": "src/cdktf/cdktf-construct:ConstructLibraryCdktfOptions"
15570
15577
  },
15578
+ "projen.circleci.CircleCiProps": {
15579
+ "assembly": "projen",
15580
+ "datatype": true,
15581
+ "docs": {
15582
+ "see": "https://circleci.com/docs/2.0/configuration-reference/",
15583
+ "stability": "experimental",
15584
+ "summary": "Options for class {@link Circleci}."
15585
+ },
15586
+ "fqn": "projen.circleci.CircleCiProps",
15587
+ "kind": "interface",
15588
+ "locationInModule": {
15589
+ "filename": "src/circleci/circleci.ts",
15590
+ "line": 12
15591
+ },
15592
+ "name": "CircleCiProps",
15593
+ "namespace": "circleci",
15594
+ "properties": [
15595
+ {
15596
+ "abstract": true,
15597
+ "docs": {
15598
+ "see": "https://circleci.com/docs/2.0/configuration-reference/#jobs",
15599
+ "stability": "experimental",
15600
+ "summary": "List of Jobs to create unique steps per pipeline, e.g. ```json jobs: [{ identifier: \"compile\", docker: { image: \"golang:alpine\" } steps: [\"checkout\", run: {command: \"go build .\"}] }] ```."
15601
+ },
15602
+ "immutable": true,
15603
+ "locationInModule": {
15604
+ "filename": "src/circleci/circleci.ts",
15605
+ "line": 59
15606
+ },
15607
+ "name": "jobs",
15608
+ "optional": true,
15609
+ "type": {
15610
+ "collection": {
15611
+ "elementtype": {
15612
+ "fqn": "projen.circleci.Job"
15613
+ },
15614
+ "kind": "array"
15615
+ }
15616
+ }
15617
+ },
15618
+ {
15619
+ "abstract": true,
15620
+ "docs": {
15621
+ "stability": "experimental",
15622
+ "summary": "Contains a map of CirclCi Orbs ```json orbs: { node: \"circleci/node@5.0.1\" slack: \"circleci/slack@4.8.3\" } ```."
15623
+ },
15624
+ "immutable": true,
15625
+ "locationInModule": {
15626
+ "filename": "src/circleci/circleci.ts",
15627
+ "line": 22
15628
+ },
15629
+ "name": "orbs",
15630
+ "optional": true,
15631
+ "type": {
15632
+ "collection": {
15633
+ "elementtype": {
15634
+ "primitive": "string"
15635
+ },
15636
+ "kind": "map"
15637
+ }
15638
+ }
15639
+ },
15640
+ {
15641
+ "abstract": true,
15642
+ "docs": {
15643
+ "see": "https://circleci.com/docs/2.0/configuration-reference/#setup",
15644
+ "stability": "experimental",
15645
+ "summary": "The setup field enables you to conditionally trigger configurations from outside the primary .circleci parent directory, update pipeline parameters, or generate customized configurations."
15646
+ },
15647
+ "immutable": true,
15648
+ "locationInModule": {
15649
+ "filename": "src/circleci/circleci.ts",
15650
+ "line": 66
15651
+ },
15652
+ "name": "setup",
15653
+ "optional": true,
15654
+ "type": {
15655
+ "primitive": "boolean"
15656
+ }
15657
+ },
15658
+ {
15659
+ "abstract": true,
15660
+ "docs": {
15661
+ "default": "2.1",
15662
+ "see": "https://circleci.com/docs/2.0/configuration-reference/#version",
15663
+ "stability": "experimental",
15664
+ "summary": "pipeline version."
15665
+ },
15666
+ "immutable": true,
15667
+ "locationInModule": {
15668
+ "filename": "src/circleci/circleci.ts",
15669
+ "line": 29
15670
+ },
15671
+ "name": "version",
15672
+ "optional": true,
15673
+ "type": {
15674
+ "primitive": "number"
15675
+ }
15676
+ },
15677
+ {
15678
+ "abstract": true,
15679
+ "docs": {
15680
+ "see": "https://circleci.com/docs/2.0/configuration-reference/#workflows",
15681
+ "stability": "experimental",
15682
+ "summary": "List of Workflows of pipeline, e.g. ```json workflows: { { identifier: \"build\", jobs: [{ identifier: \"node/install\", context: [\"npm\"], }] } } ```."
15683
+ },
15684
+ "immutable": true,
15685
+ "locationInModule": {
15686
+ "filename": "src/circleci/circleci.ts",
15687
+ "line": 46
15688
+ },
15689
+ "name": "workflows",
15690
+ "optional": true,
15691
+ "type": {
15692
+ "collection": {
15693
+ "elementtype": {
15694
+ "fqn": "projen.circleci.Workflow"
15695
+ },
15696
+ "kind": "array"
15697
+ }
15698
+ }
15699
+ }
15700
+ ],
15701
+ "symbolId": "src/circleci/circleci:CircleCiProps"
15702
+ },
15703
+ "projen.circleci.Circleci": {
15704
+ "assembly": "projen",
15705
+ "base": "projen.Component",
15706
+ "docs": {
15707
+ "see": "https://circleci.com/docs/2.0/configuration-reference/",
15708
+ "stability": "experimental",
15709
+ "summary": "Circleci Class to manage `.circleci/config.yml`. Check projen's docs for more information."
15710
+ },
15711
+ "fqn": "projen.circleci.Circleci",
15712
+ "initializer": {
15713
+ "docs": {
15714
+ "stability": "experimental"
15715
+ },
15716
+ "locationInModule": {
15717
+ "filename": "src/circleci/circleci.ts",
15718
+ "line": 101
15719
+ },
15720
+ "parameters": [
15721
+ {
15722
+ "name": "project",
15723
+ "type": {
15724
+ "fqn": "projen.Project"
15725
+ }
15726
+ },
15727
+ {
15728
+ "name": "options",
15729
+ "optional": true,
15730
+ "type": {
15731
+ "fqn": "projen.circleci.CircleCiProps"
15732
+ }
15733
+ }
15734
+ ]
15735
+ },
15736
+ "kind": "class",
15737
+ "locationInModule": {
15738
+ "filename": "src/circleci/circleci.ts",
15739
+ "line": 75
15740
+ },
15741
+ "methods": [
15742
+ {
15743
+ "docs": {
15744
+ "remarks": "Will throw error if the orb already exists",
15745
+ "stability": "experimental",
15746
+ "summary": "Add a Circleci Orb to pipeline."
15747
+ },
15748
+ "locationInModule": {
15749
+ "filename": "src/circleci/circleci.ts",
15750
+ "line": 180
15751
+ },
15752
+ "name": "addOrb",
15753
+ "parameters": [
15754
+ {
15755
+ "name": "name",
15756
+ "type": {
15757
+ "primitive": "string"
15758
+ }
15759
+ },
15760
+ {
15761
+ "name": "orb",
15762
+ "type": {
15763
+ "primitive": "string"
15764
+ }
15765
+ }
15766
+ ]
15767
+ },
15768
+ {
15769
+ "docs": {
15770
+ "stability": "experimental",
15771
+ "summary": "add new workflow to existing pipeline."
15772
+ },
15773
+ "locationInModule": {
15774
+ "filename": "src/circleci/circleci.ts",
15775
+ "line": 147
15776
+ },
15777
+ "name": "addWorkflow",
15778
+ "parameters": [
15779
+ {
15780
+ "name": "workflow",
15781
+ "type": {
15782
+ "fqn": "projen.circleci.Workflow"
15783
+ }
15784
+ }
15785
+ ]
15786
+ }
15787
+ ],
15788
+ "name": "Circleci",
15789
+ "namespace": "circleci",
15790
+ "properties": [
15791
+ {
15792
+ "docs": {
15793
+ "stability": "experimental",
15794
+ "summary": "The yaml file for the Circleci pipeline."
15795
+ },
15796
+ "immutable": true,
15797
+ "locationInModule": {
15798
+ "filename": "src/circleci/circleci.ts",
15799
+ "line": 79
15800
+ },
15801
+ "name": "file",
15802
+ "type": {
15803
+ "fqn": "projen.YamlFile"
15804
+ }
15805
+ }
15806
+ ],
15807
+ "symbolId": "src/circleci/circleci:Circleci"
15808
+ },
15809
+ "projen.circleci.Docker": {
15810
+ "assembly": "projen",
15811
+ "datatype": true,
15812
+ "docs": {
15813
+ "see": "https://circleci.com/docs/2.0/configuration-reference/#docker",
15814
+ "stability": "experimental",
15815
+ "summary": "Options for docker executor."
15816
+ },
15817
+ "fqn": "projen.circleci.Docker",
15818
+ "kind": "interface",
15819
+ "locationInModule": {
15820
+ "filename": "src/circleci/model.ts",
15821
+ "line": 179
15822
+ },
15823
+ "name": "Docker",
15824
+ "namespace": "circleci",
15825
+ "properties": [
15826
+ {
15827
+ "abstract": true,
15828
+ "docs": {
15829
+ "stability": "experimental",
15830
+ "summary": "The name of a custom docker image to use."
15831
+ },
15832
+ "immutable": true,
15833
+ "locationInModule": {
15834
+ "filename": "src/circleci/model.ts",
15835
+ "line": 181
15836
+ },
15837
+ "name": "image",
15838
+ "type": {
15839
+ "primitive": "string"
15840
+ }
15841
+ },
15842
+ {
15843
+ "abstract": true,
15844
+ "docs": {
15845
+ "stability": "experimental",
15846
+ "summary": "Authentication for registries using standard docker login credentials."
15847
+ },
15848
+ "immutable": true,
15849
+ "locationInModule": {
15850
+ "filename": "src/circleci/model.ts",
15851
+ "line": 193
15852
+ },
15853
+ "name": "auth",
15854
+ "optional": true,
15855
+ "type": {
15856
+ "collection": {
15857
+ "elementtype": {
15858
+ "primitive": "string"
15859
+ },
15860
+ "kind": "map"
15861
+ }
15862
+ }
15863
+ },
15864
+ {
15865
+ "abstract": true,
15866
+ "docs": {
15867
+ "stability": "experimental",
15868
+ "summary": "Authentication for AWS Elastic Container Registry (ECR)."
15869
+ },
15870
+ "immutable": true,
15871
+ "locationInModule": {
15872
+ "filename": "src/circleci/model.ts",
15873
+ "line": 195
15874
+ },
15875
+ "name": "awsAuth",
15876
+ "optional": true,
15877
+ "type": {
15878
+ "collection": {
15879
+ "elementtype": {
15880
+ "primitive": "string"
15881
+ },
15882
+ "kind": "map"
15883
+ }
15884
+ }
15885
+ },
15886
+ {
15887
+ "abstract": true,
15888
+ "docs": {
15889
+ "stability": "experimental",
15890
+ "summary": "The command used as pid 1 (or args for entrypoint) when launching the container."
15891
+ },
15892
+ "immutable": true,
15893
+ "locationInModule": {
15894
+ "filename": "src/circleci/model.ts",
15895
+ "line": 187
15896
+ },
15897
+ "name": "command",
15898
+ "optional": true,
15899
+ "type": {
15900
+ "collection": {
15901
+ "elementtype": {
15902
+ "primitive": "string"
15903
+ },
15904
+ "kind": "array"
15905
+ }
15906
+ }
15907
+ },
15908
+ {
15909
+ "abstract": true,
15910
+ "docs": {
15911
+ "stability": "experimental",
15912
+ "summary": "The command used as executable when launching the container."
15913
+ },
15914
+ "immutable": true,
15915
+ "locationInModule": {
15916
+ "filename": "src/circleci/model.ts",
15917
+ "line": 185
15918
+ },
15919
+ "name": "entrypoint",
15920
+ "optional": true,
15921
+ "type": {
15922
+ "collection": {
15923
+ "elementtype": {
15924
+ "primitive": "string"
15925
+ },
15926
+ "kind": "array"
15927
+ }
15928
+ }
15929
+ },
15930
+ {
15931
+ "abstract": true,
15932
+ "docs": {
15933
+ "stability": "experimental",
15934
+ "summary": "A map of environment variable names and values."
15935
+ },
15936
+ "immutable": true,
15937
+ "locationInModule": {
15938
+ "filename": "src/circleci/model.ts",
15939
+ "line": 191
15940
+ },
15941
+ "name": "environment",
15942
+ "optional": true,
15943
+ "type": {
15944
+ "collection": {
15945
+ "elementtype": {
15946
+ "union": {
15947
+ "types": [
15948
+ {
15949
+ "primitive": "string"
15950
+ },
15951
+ {
15952
+ "primitive": "number"
15953
+ },
15954
+ {
15955
+ "primitive": "boolean"
15956
+ }
15957
+ ]
15958
+ }
15959
+ },
15960
+ "kind": "map"
15961
+ }
15962
+ }
15963
+ },
15964
+ {
15965
+ "abstract": true,
15966
+ "docs": {
15967
+ "remarks": "By default, container services are accessible through localhost",
15968
+ "stability": "experimental",
15969
+ "summary": "The name the container is reachable by."
15970
+ },
15971
+ "immutable": true,
15972
+ "locationInModule": {
15973
+ "filename": "src/circleci/model.ts",
15974
+ "line": 183
15975
+ },
15976
+ "name": "name",
15977
+ "optional": true,
15978
+ "type": {
15979
+ "primitive": "string"
15980
+ }
15981
+ },
15982
+ {
15983
+ "abstract": true,
15984
+ "docs": {
15985
+ "stability": "experimental",
15986
+ "summary": "Which user to run commands as within the Docker container."
15987
+ },
15988
+ "immutable": true,
15989
+ "locationInModule": {
15990
+ "filename": "src/circleci/model.ts",
15991
+ "line": 189
15992
+ },
15993
+ "name": "user",
15994
+ "optional": true,
15995
+ "type": {
15996
+ "primitive": "string"
15997
+ }
15998
+ }
15999
+ ],
16000
+ "symbolId": "src/circleci/model:Docker"
16001
+ },
16002
+ "projen.circleci.Filter": {
16003
+ "assembly": "projen",
16004
+ "datatype": true,
16005
+ "docs": {
16006
+ "remarks": "Branches can have the keys only and ignore which either map to a single string naming a branch.\nYou may also use regular expressions to match against branches by enclosing them with /’s, or map to a list of such strings.\nRegular expressions must match the entire string.\n\nAny branches that match only will run the job.\nAny branches that match ignore will not run the job.\nIf neither only nor ignore are specified then all branches will run the job.\nIf both only and ignore are specified the only is considered before ignore.",
16007
+ "see": "https://circleci.com/docs/2.0/configuration-reference/#filters",
16008
+ "stability": "experimental",
16009
+ "summary": "The branches key controls whether the current branch should have a schedule trigger created for it, where current branch is the branch containing the config.yml file with the trigger stanza. That is, a push on the main branch will only schedule a workflow for the main branch."
16010
+ },
16011
+ "fqn": "projen.circleci.Filter",
16012
+ "kind": "interface",
16013
+ "locationInModule": {
16014
+ "filename": "src/circleci/model.ts",
16015
+ "line": 135
16016
+ },
16017
+ "name": "Filter",
16018
+ "namespace": "circleci",
16019
+ "properties": [
16020
+ {
16021
+ "abstract": true,
16022
+ "docs": {
16023
+ "stability": "experimental"
16024
+ },
16025
+ "immutable": true,
16026
+ "locationInModule": {
16027
+ "filename": "src/circleci/model.ts",
16028
+ "line": 136
16029
+ },
16030
+ "name": "branches",
16031
+ "optional": true,
16032
+ "type": {
16033
+ "fqn": "projen.circleci.FilterConfig"
16034
+ }
16035
+ },
16036
+ {
16037
+ "abstract": true,
16038
+ "docs": {
16039
+ "stability": "experimental"
16040
+ },
16041
+ "immutable": true,
16042
+ "locationInModule": {
16043
+ "filename": "src/circleci/model.ts",
16044
+ "line": 137
16045
+ },
16046
+ "name": "tags",
16047
+ "optional": true,
16048
+ "type": {
16049
+ "fqn": "projen.circleci.FilterConfig"
16050
+ }
16051
+ }
16052
+ ],
16053
+ "symbolId": "src/circleci/model:Filter"
16054
+ },
16055
+ "projen.circleci.FilterConfig": {
16056
+ "assembly": "projen",
16057
+ "datatype": true,
16058
+ "docs": {
16059
+ "see": "https://circleci.com/docs/2.0/configuration-reference/#filters",
16060
+ "stability": "experimental",
16061
+ "summary": "set an inclusive or exclusive filter."
16062
+ },
16063
+ "fqn": "projen.circleci.FilterConfig",
16064
+ "kind": "interface",
16065
+ "locationInModule": {
16066
+ "filename": "src/circleci/model.ts",
16067
+ "line": 144
16068
+ },
16069
+ "name": "FilterConfig",
16070
+ "namespace": "circleci",
16071
+ "properties": [
16072
+ {
16073
+ "abstract": true,
16074
+ "docs": {
16075
+ "stability": "experimental",
16076
+ "summary": "Either a single branch specifier, or a list of branch specifiers."
16077
+ },
16078
+ "immutable": true,
16079
+ "locationInModule": {
16080
+ "filename": "src/circleci/model.ts",
16081
+ "line": 148
16082
+ },
16083
+ "name": "ignore",
16084
+ "optional": true,
16085
+ "type": {
16086
+ "collection": {
16087
+ "elementtype": {
16088
+ "primitive": "string"
16089
+ },
16090
+ "kind": "array"
16091
+ }
16092
+ }
16093
+ },
16094
+ {
16095
+ "abstract": true,
16096
+ "docs": {
16097
+ "stability": "experimental",
16098
+ "summary": "Either a single branch specifier, or a list of branch specifiers."
16099
+ },
16100
+ "immutable": true,
16101
+ "locationInModule": {
16102
+ "filename": "src/circleci/model.ts",
16103
+ "line": 146
16104
+ },
16105
+ "name": "only",
16106
+ "optional": true,
16107
+ "type": {
16108
+ "collection": {
16109
+ "elementtype": {
16110
+ "primitive": "string"
16111
+ },
16112
+ "kind": "array"
16113
+ }
16114
+ }
16115
+ }
16116
+ ],
16117
+ "symbolId": "src/circleci/model:FilterConfig"
16118
+ },
16119
+ "projen.circleci.Job": {
16120
+ "assembly": "projen",
16121
+ "datatype": true,
16122
+ "docs": {
16123
+ "remarks": "Jobs are specified in the jobs map,\nsee Sample 2.0 config.yml for two examples of a job map.\nThe name of the job is the key in the map, and the value is a map describing the job.\nEach job consists of the job’s name as a key and a map as a value. A name should be case insensitive unique within a current jobs list.",
16124
+ "see": "https://circleci.com/docs/2.0/configuration-reference/#job_name",
16125
+ "stability": "experimental",
16126
+ "summary": "A Workflow is comprised of one or more uniquely named jobs."
16127
+ },
16128
+ "fqn": "projen.circleci.Job",
16129
+ "kind": "interface",
16130
+ "locationInModule": {
16131
+ "filename": "src/circleci/model.ts",
16132
+ "line": 66
16133
+ },
16134
+ "name": "Job",
16135
+ "namespace": "circleci",
16136
+ "properties": [
16137
+ {
16138
+ "abstract": true,
16139
+ "docs": {
16140
+ "stability": "experimental",
16141
+ "summary": "name of dynamic key *."
16142
+ },
16143
+ "immutable": true,
16144
+ "locationInModule": {
16145
+ "filename": "src/circleci/model.ts",
16146
+ "line": 10
16147
+ },
16148
+ "name": "identifier",
16149
+ "type": {
16150
+ "primitive": "string"
16151
+ }
16152
+ },
16153
+ {
16154
+ "abstract": true,
16155
+ "docs": {
16156
+ "stability": "experimental"
16157
+ },
16158
+ "immutable": true,
16159
+ "locationInModule": {
16160
+ "filename": "src/circleci/model.ts",
16161
+ "line": 156
16162
+ },
16163
+ "name": "docker",
16164
+ "optional": true,
16165
+ "type": {
16166
+ "collection": {
16167
+ "elementtype": {
16168
+ "fqn": "projen.circleci.Docker"
16169
+ },
16170
+ "kind": "array"
16171
+ }
16172
+ }
16173
+ },
16174
+ {
16175
+ "abstract": true,
16176
+ "docs": {
16177
+ "stability": "experimental",
16178
+ "summary": "A map of environment variable names and values."
16179
+ },
16180
+ "immutable": true,
16181
+ "locationInModule": {
16182
+ "filename": "src/circleci/model.ts",
16183
+ "line": 170
16184
+ },
16185
+ "name": "environment",
16186
+ "optional": true,
16187
+ "type": {
16188
+ "collection": {
16189
+ "elementtype": {
16190
+ "union": {
16191
+ "types": [
16192
+ {
16193
+ "primitive": "string"
16194
+ },
16195
+ {
16196
+ "primitive": "number"
16197
+ },
16198
+ {
16199
+ "primitive": "boolean"
16200
+ }
16201
+ ]
16202
+ }
16203
+ },
16204
+ "kind": "map"
16205
+ }
16206
+ }
16207
+ },
16208
+ {
16209
+ "abstract": true,
16210
+ "docs": {
16211
+ "stability": "experimental"
16212
+ },
16213
+ "immutable": true,
16214
+ "locationInModule": {
16215
+ "filename": "src/circleci/model.ts",
16216
+ "line": 157
16217
+ },
16218
+ "name": "machine",
16219
+ "optional": true,
16220
+ "type": {
16221
+ "fqn": "projen.circleci.Machine"
16222
+ }
16223
+ },
16224
+ {
16225
+ "abstract": true,
16226
+ "docs": {
16227
+ "stability": "experimental"
16228
+ },
16229
+ "immutable": true,
16230
+ "locationInModule": {
16231
+ "filename": "src/circleci/model.ts",
16232
+ "line": 158
16233
+ },
16234
+ "name": "macos",
16235
+ "optional": true,
16236
+ "type": {
16237
+ "fqn": "projen.circleci.Macos"
16238
+ }
16239
+ },
16240
+ {
16241
+ "abstract": true,
16242
+ "docs": {
16243
+ "stability": "experimental",
16244
+ "summary": "Number of parallel instances of this job to run (default: 1)."
16245
+ },
16246
+ "immutable": true,
16247
+ "locationInModule": {
16248
+ "filename": "src/circleci/model.ts",
16249
+ "line": 168
16250
+ },
16251
+ "name": "parallelism",
16252
+ "optional": true,
16253
+ "type": {
16254
+ "primitive": "number"
16255
+ }
16256
+ },
16257
+ {
16258
+ "abstract": true,
16259
+ "docs": {
16260
+ "stability": "experimental",
16261
+ "summary": "Parameters for making a job explicitly configurable in a workflow."
16262
+ },
16263
+ "immutable": true,
16264
+ "locationInModule": {
16265
+ "filename": "src/circleci/model.ts",
16266
+ "line": 162
16267
+ },
16268
+ "name": "parameters",
16269
+ "optional": true,
16270
+ "type": {
16271
+ "collection": {
16272
+ "elementtype": {
16273
+ "primitive": "string"
16274
+ },
16275
+ "kind": "map"
16276
+ }
16277
+ }
16278
+ },
16279
+ {
16280
+ "abstract": true,
16281
+ "docs": {
16282
+ "stability": "experimental",
16283
+ "summary": "{@link ResourceClass}."
16284
+ },
16285
+ "immutable": true,
16286
+ "locationInModule": {
16287
+ "filename": "src/circleci/model.ts",
16288
+ "line": 172
16289
+ },
16290
+ "name": "resourceClass",
16291
+ "optional": true,
16292
+ "type": {
16293
+ "primitive": "string"
16294
+ }
16295
+ },
16296
+ {
16297
+ "abstract": true,
16298
+ "docs": {
16299
+ "remarks": "Can be overridden by shell in each step",
16300
+ "stability": "experimental",
16301
+ "summary": "Shell to use for execution command in all steps."
16302
+ },
16303
+ "immutable": true,
16304
+ "locationInModule": {
16305
+ "filename": "src/circleci/model.ts",
16306
+ "line": 160
16307
+ },
16308
+ "name": "shell",
16309
+ "optional": true,
16310
+ "type": {
16311
+ "primitive": "string"
16312
+ }
16313
+ },
16314
+ {
16315
+ "abstract": true,
16316
+ "docs": {
16317
+ "stability": "experimental",
16318
+ "summary": "no type support here, for syntax {@see https://circleci.com/docs/2.0/configuration-reference/#steps}."
16319
+ },
16320
+ "immutable": true,
16321
+ "locationInModule": {
16322
+ "filename": "src/circleci/model.ts",
16323
+ "line": 164
16324
+ },
16325
+ "name": "steps",
16326
+ "optional": true,
16327
+ "type": {
16328
+ "collection": {
16329
+ "elementtype": {
16330
+ "primitive": "any"
16331
+ },
16332
+ "kind": "array"
16333
+ }
16334
+ }
16335
+ },
16336
+ {
16337
+ "abstract": true,
16338
+ "docs": {
16339
+ "remarks": "Will be interpreted as an absolute path. Default: `~/project`",
16340
+ "stability": "experimental",
16341
+ "summary": "In which directory to run the steps."
16342
+ },
16343
+ "immutable": true,
16344
+ "locationInModule": {
16345
+ "filename": "src/circleci/model.ts",
16346
+ "line": 166
16347
+ },
16348
+ "name": "workingDirectory",
16349
+ "optional": true,
16350
+ "type": {
16351
+ "primitive": "string"
16352
+ }
16353
+ }
16354
+ ],
16355
+ "symbolId": "src/circleci/model:Job"
16356
+ },
16357
+ "projen.circleci.JobType": {
16358
+ "assembly": "projen",
16359
+ "docs": {
16360
+ "see": "https://circleci.com/docs/2.0/configuration-reference/#type",
16361
+ "stability": "experimental",
16362
+ "summary": "A job may have a type of approval indicating it must be manually approved before downstream jobs may proceed."
16363
+ },
16364
+ "fqn": "projen.circleci.JobType",
16365
+ "kind": "enum",
16366
+ "locationInModule": {
16367
+ "filename": "src/circleci/model.ts",
16368
+ "line": 32
16369
+ },
16370
+ "members": [
16371
+ {
16372
+ "docs": {
16373
+ "stability": "experimental"
16374
+ },
16375
+ "name": "APPROVAL"
16376
+ }
16377
+ ],
16378
+ "name": "JobType",
16379
+ "namespace": "circleci",
16380
+ "symbolId": "src/circleci/model:JobType"
16381
+ },
16382
+ "projen.circleci.JobWhen": {
16383
+ "assembly": "projen",
16384
+ "docs": {
16385
+ "see": "https://circleci.com/docs/2.0/configuration-reference/#steps",
16386
+ "stability": "experimental",
16387
+ "summary": "Specify when to enable or disable the step."
16388
+ },
16389
+ "fqn": "projen.circleci.JobWhen",
16390
+ "kind": "enum",
16391
+ "locationInModule": {
16392
+ "filename": "src/circleci/model.ts",
16393
+ "line": 54
16394
+ },
16395
+ "members": [
16396
+ {
16397
+ "docs": {
16398
+ "stability": "experimental"
16399
+ },
16400
+ "name": "ALWAYS"
16401
+ },
16402
+ {
16403
+ "docs": {
16404
+ "stability": "experimental"
16405
+ },
16406
+ "name": "ON_SUCCESS"
16407
+ },
16408
+ {
16409
+ "docs": {
16410
+ "stability": "experimental"
16411
+ },
16412
+ "name": "ON_FAIL"
16413
+ }
16414
+ ],
16415
+ "name": "JobWhen",
16416
+ "namespace": "circleci",
16417
+ "symbolId": "src/circleci/model:JobWhen"
16418
+ },
16419
+ "projen.circleci.Machine": {
16420
+ "assembly": "projen",
16421
+ "datatype": true,
16422
+ "docs": {
16423
+ "stability": "experimental"
16424
+ },
16425
+ "fqn": "projen.circleci.Machine",
16426
+ "kind": "interface",
16427
+ "locationInModule": {
16428
+ "filename": "src/circleci/model.ts",
16429
+ "line": 198
16430
+ },
16431
+ "name": "Machine",
16432
+ "namespace": "circleci",
16433
+ "properties": [
16434
+ {
16435
+ "abstract": true,
16436
+ "docs": {
16437
+ "see": "https://circleci.com/docs/2.0/configuration-reference/#available-machine-images",
16438
+ "stability": "experimental",
16439
+ "summary": "The VM image to use."
16440
+ },
16441
+ "immutable": true,
16442
+ "locationInModule": {
16443
+ "filename": "src/circleci/model.ts",
16444
+ "line": 203
16445
+ },
16446
+ "name": "image",
16447
+ "type": {
16448
+ "primitive": "string"
16449
+ }
16450
+ },
16451
+ {
16452
+ "abstract": true,
16453
+ "docs": {
16454
+ "see": "https://circleci.com/docs/2.0/configuration-reference/#available-machine-images",
16455
+ "stability": "experimental",
16456
+ "summary": "enable docker layer caching."
16457
+ },
16458
+ "immutable": true,
16459
+ "locationInModule": {
16460
+ "filename": "src/circleci/model.ts",
16461
+ "line": 207
16462
+ },
16463
+ "name": "dockerLayerCaching",
16464
+ "optional": true,
16465
+ "type": {
16466
+ "primitive": "string"
16467
+ }
16468
+ }
16469
+ ],
16470
+ "symbolId": "src/circleci/model:Machine"
16471
+ },
16472
+ "projen.circleci.Macos": {
16473
+ "assembly": "projen",
16474
+ "datatype": true,
16475
+ "docs": {
16476
+ "remarks": "To run a job in a macOS virtual machine,\nyou must add the macos key to the top-level configuration for the job and specify\nthe version of Xcode you would like to use.",
16477
+ "see": "https://circleci.com/docs/2.0/configuration-reference/#macos",
16478
+ "stability": "experimental",
16479
+ "summary": "CircleCI supports running jobs on macOS, to allow you to build, test, and deploy apps for macOS, iOS, tvOS and watchOS."
16480
+ },
16481
+ "fqn": "projen.circleci.Macos",
16482
+ "kind": "interface",
16483
+ "locationInModule": {
16484
+ "filename": "src/circleci/model.ts",
16485
+ "line": 217
16486
+ },
16487
+ "name": "Macos",
16488
+ "namespace": "circleci",
16489
+ "properties": [
16490
+ {
16491
+ "abstract": true,
16492
+ "docs": {
16493
+ "stability": "experimental",
16494
+ "summary": "The version of Xcode that is installed on the virtual machine."
16495
+ },
16496
+ "immutable": true,
16497
+ "locationInModule": {
16498
+ "filename": "src/circleci/model.ts",
16499
+ "line": 219
16500
+ },
16501
+ "name": "xcode",
16502
+ "type": {
16503
+ "primitive": "string"
16504
+ }
16505
+ }
16506
+ ],
16507
+ "symbolId": "src/circleci/model:Macos"
16508
+ },
16509
+ "projen.circleci.Matrix": {
16510
+ "assembly": "projen",
16511
+ "datatype": true,
16512
+ "docs": {
16513
+ "see": "https://circleci.com/docs/2.0/configuration-reference/#matrix-requires-version-21",
16514
+ "stability": "experimental",
16515
+ "summary": "The matrix stanza allows you to run a parameterized job multiple times with different arguments."
16516
+ },
16517
+ "fqn": "projen.circleci.Matrix",
16518
+ "kind": "interface",
16519
+ "locationInModule": {
16520
+ "filename": "src/circleci/model.ts",
16521
+ "line": 94
16522
+ },
16523
+ "name": "Matrix",
16524
+ "namespace": "circleci",
16525
+ "properties": [
16526
+ {
16527
+ "abstract": true,
16528
+ "docs": {
16529
+ "remarks": "Defaults to the name of the job being executed",
16530
+ "stability": "experimental",
16531
+ "summary": "An alias for the matrix, usable from another job’s requires stanza."
16532
+ },
16533
+ "immutable": true,
16534
+ "locationInModule": {
16535
+ "filename": "src/circleci/model.ts",
16536
+ "line": 98
16537
+ },
16538
+ "name": "alias",
16539
+ "optional": true,
16540
+ "type": {
16541
+ "primitive": "string"
16542
+ }
16543
+ },
16544
+ {
16545
+ "abstract": true,
16546
+ "docs": {
16547
+ "stability": "experimental",
16548
+ "summary": "A map of parameter names to every value the job should be called with."
16549
+ },
16550
+ "immutable": true,
16551
+ "locationInModule": {
16552
+ "filename": "src/circleci/model.ts",
16553
+ "line": 96
16554
+ },
16555
+ "name": "parameters",
16556
+ "optional": true,
16557
+ "type": {
16558
+ "collection": {
16559
+ "elementtype": {
16560
+ "union": {
16561
+ "types": [
16562
+ {
16563
+ "collection": {
16564
+ "elementtype": {
16565
+ "primitive": "string"
16566
+ },
16567
+ "kind": "array"
16568
+ }
16569
+ },
16570
+ {
16571
+ "collection": {
16572
+ "elementtype": {
16573
+ "primitive": "number"
16574
+ },
16575
+ "kind": "array"
16576
+ }
16577
+ }
16578
+ ]
16579
+ }
16580
+ },
16581
+ "kind": "map"
16582
+ }
16583
+ }
16584
+ }
16585
+ ],
16586
+ "symbolId": "src/circleci/model:Matrix"
16587
+ },
16588
+ "projen.circleci.ResourceClass": {
16589
+ "assembly": "projen",
16590
+ "docs": {
16591
+ "remarks": "Different resource classes are available for different executors, as described in the tables below.",
16592
+ "see": "https://circleci.com/docs/2.0/configuration-reference/#resourceclass",
16593
+ "stability": "experimental",
16594
+ "summary": "The resource_class feature allows configuring CPU and RAM resources for each job."
16595
+ },
16596
+ "fqn": "projen.circleci.ResourceClass",
16597
+ "kind": "enum",
16598
+ "locationInModule": {
16599
+ "filename": "src/circleci/model.ts",
16600
+ "line": 41
16601
+ },
16602
+ "members": [
16603
+ {
16604
+ "docs": {
16605
+ "stability": "experimental"
16606
+ },
16607
+ "name": "SMALL"
16608
+ },
16609
+ {
16610
+ "docs": {
16611
+ "stability": "experimental"
16612
+ },
16613
+ "name": "MEDIUM"
16614
+ },
16615
+ {
16616
+ "docs": {
16617
+ "stability": "experimental"
16618
+ },
16619
+ "name": "MEDIUM_PLUS"
16620
+ },
16621
+ {
16622
+ "docs": {
16623
+ "stability": "experimental"
16624
+ },
16625
+ "name": "LARGE_X"
16626
+ },
16627
+ {
16628
+ "docs": {
16629
+ "stability": "experimental"
16630
+ },
16631
+ "name": "LARGE_2X"
16632
+ },
16633
+ {
16634
+ "docs": {
16635
+ "stability": "experimental"
16636
+ },
16637
+ "name": "LARGE_2X_PLUS"
16638
+ }
16639
+ ],
16640
+ "name": "ResourceClass",
16641
+ "namespace": "circleci",
16642
+ "symbolId": "src/circleci/model:ResourceClass"
16643
+ },
16644
+ "projen.circleci.Run": {
16645
+ "assembly": "projen",
16646
+ "datatype": true,
16647
+ "docs": {
16648
+ "remarks": "Run commands are executed using non-login shells by default,\nso you must explicitly source any dotfiles as part of the command.\n\nNot used because type incompatible types in steps array",
16649
+ "see": "https://circleci.com/docs/2.0/configuration-reference/#run",
16650
+ "stability": "experimental",
16651
+ "summary": "Used for invoking all command-line programs, taking either a map of configuration values, or, when called in its short-form, a string that will be used as both the command and name."
16652
+ },
16653
+ "fqn": "projen.circleci.Run",
16654
+ "kind": "interface",
16655
+ "locationInModule": {
16656
+ "filename": "src/circleci/model.ts",
16657
+ "line": 240
16658
+ },
16659
+ "name": "Run",
16660
+ "namespace": "circleci",
16661
+ "properties": [
16662
+ {
16663
+ "abstract": true,
16664
+ "docs": {
16665
+ "stability": "experimental",
16666
+ "summary": "Command to run via the shell."
16667
+ },
16668
+ "immutable": true,
16669
+ "locationInModule": {
16670
+ "filename": "src/circleci/model.ts",
16671
+ "line": 242
16672
+ },
16673
+ "name": "command",
16674
+ "type": {
16675
+ "primitive": "string"
16676
+ }
16677
+ },
16678
+ {
16679
+ "abstract": true,
16680
+ "docs": {
16681
+ "stability": "experimental",
16682
+ "summary": "Whether this step should run in the background (default: false)."
16683
+ },
16684
+ "immutable": true,
16685
+ "locationInModule": {
16686
+ "filename": "src/circleci/model.ts",
16687
+ "line": 250
16688
+ },
16689
+ "name": "background",
16690
+ "optional": true,
16691
+ "type": {
16692
+ "primitive": "string"
16693
+ }
16694
+ },
16695
+ {
16696
+ "abstract": true,
16697
+ "docs": {
16698
+ "stability": "experimental",
16699
+ "summary": "Additional environmental variables, locally scoped to command."
16700
+ },
16701
+ "immutable": true,
16702
+ "locationInModule": {
16703
+ "filename": "src/circleci/model.ts",
16704
+ "line": 248
16705
+ },
16706
+ "name": "environment",
16707
+ "optional": true,
16708
+ "type": {
16709
+ "primitive": "string"
16710
+ }
16711
+ },
16712
+ {
16713
+ "abstract": true,
16714
+ "docs": {
16715
+ "stability": "experimental",
16716
+ "summary": "Title of the step to be shown in the CircleCI UI (default: full command)."
16717
+ },
16718
+ "immutable": true,
16719
+ "locationInModule": {
16720
+ "filename": "src/circleci/model.ts",
16721
+ "line": 244
16722
+ },
16723
+ "name": "name",
16724
+ "optional": true,
16725
+ "type": {
16726
+ "primitive": "string"
16727
+ }
16728
+ },
16729
+ {
16730
+ "abstract": true,
16731
+ "docs": {
16732
+ "stability": "experimental",
16733
+ "summary": "Elapsed time the command can run without output such as “20m”, “1.25h”, “5s”. The default is 10 minutes."
16734
+ },
16735
+ "immutable": true,
16736
+ "locationInModule": {
16737
+ "filename": "src/circleci/model.ts",
16738
+ "line": 254
16739
+ },
16740
+ "name": "noOutputTimeout",
16741
+ "optional": true,
16742
+ "type": {
16743
+ "primitive": "string"
16744
+ }
16745
+ },
16746
+ {
16747
+ "abstract": true,
16748
+ "docs": {
16749
+ "stability": "experimental",
16750
+ "summary": "Shell to use for execution command."
16751
+ },
16752
+ "immutable": true,
16753
+ "locationInModule": {
16754
+ "filename": "src/circleci/model.ts",
16755
+ "line": 246
16756
+ },
16757
+ "name": "shell",
16758
+ "optional": true,
16759
+ "type": {
16760
+ "primitive": "string"
16761
+ }
16762
+ },
16763
+ {
16764
+ "abstract": true,
16765
+ "docs": {
16766
+ "stability": "experimental",
16767
+ "summary": "Specify when to enable or disable the step."
16768
+ },
16769
+ "immutable": true,
16770
+ "locationInModule": {
16771
+ "filename": "src/circleci/model.ts",
16772
+ "line": 256
16773
+ },
16774
+ "name": "when",
16775
+ "optional": true,
16776
+ "type": {
16777
+ "primitive": "string"
16778
+ }
16779
+ },
16780
+ {
16781
+ "abstract": true,
16782
+ "docs": {
16783
+ "remarks": "Will be interpreted relative to the working_directory of the job). (default: .)",
16784
+ "stability": "experimental",
16785
+ "summary": "In which directory to run this step."
16786
+ },
16787
+ "immutable": true,
16788
+ "locationInModule": {
16789
+ "filename": "src/circleci/model.ts",
16790
+ "line": 252
16791
+ },
16792
+ "name": "workingDirectory",
16793
+ "optional": true,
16794
+ "type": {
16795
+ "primitive": "string"
16796
+ }
16797
+ }
16798
+ ],
16799
+ "symbolId": "src/circleci/model:Run"
16800
+ },
16801
+ "projen.circleci.Schedule": {
16802
+ "assembly": "projen",
16803
+ "datatype": true,
16804
+ "docs": {
16805
+ "see": "https://circleci.com/docs/2.0/configuration-reference/#schedule",
16806
+ "stability": "experimental",
16807
+ "summary": "A workflow may have a schedule indicating it runs at a certain time."
16808
+ },
16809
+ "fqn": "projen.circleci.Schedule",
16810
+ "kind": "interface",
16811
+ "locationInModule": {
16812
+ "filename": "src/circleci/model.ts",
16813
+ "line": 114
16814
+ },
16815
+ "name": "Schedule",
16816
+ "namespace": "circleci",
16817
+ "properties": [
16818
+ {
16819
+ "abstract": true,
16820
+ "docs": {
16821
+ "stability": "experimental"
16822
+ },
16823
+ "immutable": true,
16824
+ "locationInModule": {
16825
+ "filename": "src/circleci/model.ts",
16826
+ "line": 117
16827
+ },
16828
+ "name": "filters",
16829
+ "type": {
16830
+ "fqn": "projen.circleci.Filter"
16831
+ }
16832
+ },
16833
+ {
16834
+ "abstract": true,
16835
+ "docs": {
16836
+ "stability": "experimental",
16837
+ "summary": "The cron key is defined using POSIX crontab syntax."
16838
+ },
16839
+ "immutable": true,
16840
+ "locationInModule": {
16841
+ "filename": "src/circleci/model.ts",
16842
+ "line": 116
16843
+ },
16844
+ "name": "cron",
16845
+ "optional": true,
16846
+ "type": {
16847
+ "primitive": "string"
16848
+ }
16849
+ }
16850
+ ],
16851
+ "symbolId": "src/circleci/model:Schedule"
16852
+ },
16853
+ "projen.circleci.StepRun": {
16854
+ "assembly": "projen",
16855
+ "datatype": true,
16856
+ "docs": {
16857
+ "see": "https://circleci.com/docs/2.0/configuration-reference/#steps",
16858
+ "stability": "experimental",
16859
+ "summary": "Execution steps for Job."
16860
+ },
16861
+ "fqn": "projen.circleci.StepRun",
16862
+ "kind": "interface",
16863
+ "locationInModule": {
16864
+ "filename": "src/circleci/model.ts",
16865
+ "line": 226
16866
+ },
16867
+ "name": "StepRun",
16868
+ "namespace": "circleci",
16869
+ "properties": [
16870
+ {
16871
+ "abstract": true,
16872
+ "docs": {
16873
+ "stability": "experimental"
16874
+ },
16875
+ "immutable": true,
16876
+ "locationInModule": {
16877
+ "filename": "src/circleci/model.ts",
16878
+ "line": 227
16879
+ },
16880
+ "name": "run",
16881
+ "optional": true,
16882
+ "type": {
16883
+ "fqn": "projen.circleci.Run"
16884
+ }
16885
+ }
16886
+ ],
16887
+ "symbolId": "src/circleci/model:StepRun"
16888
+ },
16889
+ "projen.circleci.Triggers": {
16890
+ "assembly": "projen",
16891
+ "datatype": true,
16892
+ "docs": {
16893
+ "remarks": "Default behavior is to trigger the workflow when pushing to a branch.",
16894
+ "see": "https://circleci.com/docs/2.0/configuration-reference/#triggers",
16895
+ "stability": "experimental",
16896
+ "summary": "Specifies which triggers will cause this workflow to be executed."
16897
+ },
16898
+ "fqn": "projen.circleci.Triggers",
16899
+ "kind": "interface",
16900
+ "locationInModule": {
16901
+ "filename": "src/circleci/model.ts",
16902
+ "line": 106
16903
+ },
16904
+ "name": "Triggers",
16905
+ "namespace": "circleci",
16906
+ "properties": [
16907
+ {
16908
+ "abstract": true,
16909
+ "docs": {
16910
+ "stability": "experimental"
16911
+ },
16912
+ "immutable": true,
16913
+ "locationInModule": {
16914
+ "filename": "src/circleci/model.ts",
16915
+ "line": 107
16916
+ },
16917
+ "name": "schedule",
16918
+ "optional": true,
16919
+ "type": {
16920
+ "fqn": "projen.circleci.Schedule"
16921
+ }
16922
+ }
16923
+ ],
16924
+ "symbolId": "src/circleci/model:Triggers"
16925
+ },
16926
+ "projen.circleci.Workflow": {
16927
+ "assembly": "projen",
16928
+ "datatype": true,
16929
+ "docs": {
16930
+ "remarks": "Each workflow consists of the workflow name as a key and a map as a value.\nA name should be unique within the current config.yml.\nThe top-level keys for the Workflows configuration are version and jobs.",
16931
+ "see": "https://circleci.com/docs/2.0/configuration-reference/#workflows",
16932
+ "stability": "experimental",
16933
+ "summary": "Used for orchestrating all jobs."
16934
+ },
16935
+ "fqn": "projen.circleci.Workflow",
16936
+ "kind": "interface",
16937
+ "locationInModule": {
16938
+ "filename": "src/circleci/model.ts",
16939
+ "line": 19
16940
+ },
16941
+ "name": "Workflow",
16942
+ "namespace": "circleci",
16943
+ "properties": [
16944
+ {
16945
+ "abstract": true,
16946
+ "docs": {
16947
+ "stability": "experimental",
16948
+ "summary": "name of dynamic key *."
16949
+ },
16950
+ "immutable": true,
16951
+ "locationInModule": {
16952
+ "filename": "src/circleci/model.ts",
16953
+ "line": 10
16954
+ },
16955
+ "name": "identifier",
16956
+ "type": {
16957
+ "primitive": "string"
16958
+ }
16959
+ },
16960
+ {
16961
+ "abstract": true,
16962
+ "docs": {
16963
+ "stability": "experimental"
16964
+ },
16965
+ "immutable": true,
16966
+ "locationInModule": {
16967
+ "filename": "src/circleci/model.ts",
16968
+ "line": 20
16969
+ },
16970
+ "name": "jobs",
16971
+ "optional": true,
16972
+ "type": {
16973
+ "collection": {
16974
+ "elementtype": {
16975
+ "fqn": "projen.circleci.WorkflowJob"
16976
+ },
16977
+ "kind": "array"
16978
+ }
16979
+ }
16980
+ },
16981
+ {
16982
+ "abstract": true,
16983
+ "docs": {
16984
+ "stability": "experimental"
16985
+ },
16986
+ "immutable": true,
16987
+ "locationInModule": {
16988
+ "filename": "src/circleci/model.ts",
16989
+ "line": 21
16990
+ },
16991
+ "name": "triggers",
16992
+ "optional": true,
16993
+ "type": {
16994
+ "collection": {
16995
+ "elementtype": {
16996
+ "fqn": "projen.circleci.Triggers"
16997
+ },
16998
+ "kind": "array"
16999
+ }
17000
+ }
17001
+ },
17002
+ {
17003
+ "abstract": true,
17004
+ "docs": {
17005
+ "remarks": "Check Docu as reference",
17006
+ "see": "https://circleci.com/docs/2.0/configuration-reference/#logic-statement-examples",
17007
+ "stability": "experimental",
17008
+ "summary": "when is too dynamic to be casted to interfaces."
17009
+ },
17010
+ "immutable": true,
17011
+ "locationInModule": {
17012
+ "filename": "src/circleci/model.ts",
17013
+ "line": 25
17014
+ },
17015
+ "name": "when",
17016
+ "optional": true,
17017
+ "type": {
17018
+ "primitive": "any"
17019
+ }
17020
+ }
17021
+ ],
17022
+ "symbolId": "src/circleci/model:Workflow"
17023
+ },
17024
+ "projen.circleci.WorkflowJob": {
17025
+ "assembly": "projen",
17026
+ "datatype": true,
17027
+ "docs": {
17028
+ "remarks": "A Job can be created with {@link Job} or it can be provided by the orb",
17029
+ "see": "https://circleci.com/docs/2.0/configuration-reference/#jobs-in-workflow",
17030
+ "stability": "experimental",
17031
+ "summary": "A Job is part of Workflow."
17032
+ },
17033
+ "fqn": "projen.circleci.WorkflowJob",
17034
+ "kind": "interface",
17035
+ "locationInModule": {
17036
+ "filename": "src/circleci/model.ts",
17037
+ "line": 72
17038
+ },
17039
+ "name": "WorkflowJob",
17040
+ "namespace": "circleci",
17041
+ "properties": [
17042
+ {
17043
+ "abstract": true,
17044
+ "docs": {
17045
+ "stability": "experimental",
17046
+ "summary": "name of dynamic key *."
17047
+ },
17048
+ "immutable": true,
17049
+ "locationInModule": {
17050
+ "filename": "src/circleci/model.ts",
17051
+ "line": 10
17052
+ },
17053
+ "name": "identifier",
17054
+ "type": {
17055
+ "primitive": "string"
17056
+ }
17057
+ },
17058
+ {
17059
+ "abstract": true,
17060
+ "docs": {
17061
+ "remarks": "The initial default name is org-global. Each context name must be unique.",
17062
+ "stability": "experimental",
17063
+ "summary": "The name of the context(s)."
17064
+ },
17065
+ "immutable": true,
17066
+ "locationInModule": {
17067
+ "filename": "src/circleci/model.ts",
17068
+ "line": 78
17069
+ },
17070
+ "name": "context",
17071
+ "optional": true,
17072
+ "type": {
17073
+ "collection": {
17074
+ "elementtype": {
17075
+ "primitive": "string"
17076
+ },
17077
+ "kind": "array"
17078
+ }
17079
+ }
17080
+ },
17081
+ {
17082
+ "abstract": true,
17083
+ "docs": {
17084
+ "stability": "experimental",
17085
+ "summary": "Job Filters can have the key branches or tags."
17086
+ },
17087
+ "immutable": true,
17088
+ "locationInModule": {
17089
+ "filename": "src/circleci/model.ts",
17090
+ "line": 82
17091
+ },
17092
+ "name": "filter",
17093
+ "optional": true,
17094
+ "type": {
17095
+ "fqn": "projen.circleci.Filter"
17096
+ }
17097
+ },
17098
+ {
17099
+ "abstract": true,
17100
+ "docs": {
17101
+ "stability": "experimental"
17102
+ },
17103
+ "immutable": true,
17104
+ "locationInModule": {
17105
+ "filename": "src/circleci/model.ts",
17106
+ "line": 83
17107
+ },
17108
+ "name": "matrix",
17109
+ "optional": true,
17110
+ "type": {
17111
+ "fqn": "projen.circleci.Matrix"
17112
+ }
17113
+ },
17114
+ {
17115
+ "abstract": true,
17116
+ "docs": {
17117
+ "remarks": "Useful when calling a job multiple times",
17118
+ "stability": "experimental",
17119
+ "summary": "A replacement for the job name."
17120
+ },
17121
+ "immutable": true,
17122
+ "locationInModule": {
17123
+ "filename": "src/circleci/model.ts",
17124
+ "line": 76
17125
+ },
17126
+ "name": "name",
17127
+ "optional": true,
17128
+ "type": {
17129
+ "primitive": "string"
17130
+ }
17131
+ },
17132
+ {
17133
+ "abstract": true,
17134
+ "docs": {
17135
+ "stability": "experimental",
17136
+ "summary": "Parameters passed to job when referencing a job from orb."
17137
+ },
17138
+ "immutable": true,
17139
+ "locationInModule": {
17140
+ "filename": "src/circleci/model.ts",
17141
+ "line": 87
17142
+ },
17143
+ "name": "orbParameters",
17144
+ "optional": true,
17145
+ "type": {
17146
+ "collection": {
17147
+ "elementtype": {
17148
+ "union": {
17149
+ "types": [
17150
+ {
17151
+ "primitive": "string"
17152
+ },
17153
+ {
17154
+ "primitive": "number"
17155
+ },
17156
+ {
17157
+ "primitive": "boolean"
17158
+ }
17159
+ ]
17160
+ }
17161
+ },
17162
+ "kind": "map"
17163
+ }
17164
+ }
17165
+ },
17166
+ {
17167
+ "abstract": true,
17168
+ "docs": {
17169
+ "stability": "experimental",
17170
+ "summary": "Parameters for making a job explicitly configurable in a workflow."
17171
+ },
17172
+ "immutable": true,
17173
+ "locationInModule": {
17174
+ "filename": "src/circleci/model.ts",
17175
+ "line": 85
17176
+ },
17177
+ "name": "parameters",
17178
+ "optional": true,
17179
+ "type": {
17180
+ "collection": {
17181
+ "elementtype": {
17182
+ "union": {
17183
+ "types": [
17184
+ {
17185
+ "primitive": "string"
17186
+ },
17187
+ {
17188
+ "primitive": "number"
17189
+ },
17190
+ {
17191
+ "primitive": "boolean"
17192
+ }
17193
+ ]
17194
+ }
17195
+ },
17196
+ "kind": "map"
17197
+ }
17198
+ }
17199
+ },
17200
+ {
17201
+ "abstract": true,
17202
+ "docs": {
17203
+ "stability": "experimental",
17204
+ "summary": "A list of jobs that must succeed for the job to start."
17205
+ },
17206
+ "immutable": true,
17207
+ "locationInModule": {
17208
+ "filename": "src/circleci/model.ts",
17209
+ "line": 74
17210
+ },
17211
+ "name": "requires",
17212
+ "optional": true,
17213
+ "type": {
17214
+ "collection": {
17215
+ "elementtype": {
17216
+ "primitive": "string"
17217
+ },
17218
+ "kind": "array"
17219
+ }
17220
+ }
17221
+ },
17222
+ {
17223
+ "abstract": true,
17224
+ "docs": {
17225
+ "stability": "experimental",
17226
+ "summary": "A job may have a type of approval indicating it must be manually approved before downstream jobs may proceed."
17227
+ },
17228
+ "immutable": true,
17229
+ "locationInModule": {
17230
+ "filename": "src/circleci/model.ts",
17231
+ "line": 80
17232
+ },
17233
+ "name": "type",
17234
+ "optional": true,
17235
+ "type": {
17236
+ "fqn": "projen.circleci.JobType"
17237
+ }
17238
+ }
17239
+ ],
17240
+ "symbolId": "src/circleci/model:WorkflowJob"
17241
+ },
15571
17242
  "projen.github.AutoApprove": {
15572
17243
  "assembly": "projen",
15573
17244
  "base": "projen.Component",
@@ -46207,6 +47878,6 @@
46207
47878
  "symbolId": "src/web/tailwind:TailwindConfigOptions"
46208
47879
  }
46209
47880
  },
46210
- "version": "0.58.10",
46211
- "fingerprint": "6GsFAyxGAI7urZx+JFrvrJM5mIxdUXvD05kTk71OCkY="
47881
+ "version": "0.58.13",
47882
+ "fingerprint": "uhcnY6IqQ5MgwQtOHHqeN1JTKnxOW83o/zefNu+1dDE="
46212
47883
  }