projen 0.59.8 → 0.60.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +714 -131
- package/README.md +1 -0
- package/docs/api/API.md +425 -37
- package/docs/typescript.md +12 -1
- package/lib/awscdk/auto-discover.js +5 -5
- package/lib/awscdk/awscdk-app-java.js +1 -1
- package/lib/awscdk/awscdk-app-py.d.ts +1 -1
- package/lib/awscdk/awscdk-app-py.js +28 -26
- package/lib/awscdk/awscdk-app-ts.js +1 -1
- package/lib/awscdk/awscdk-construct.js +2 -2
- package/lib/awscdk/awscdk-deps-java.js +1 -1
- package/lib/awscdk/awscdk-deps-js.js +1 -1
- package/lib/awscdk/awscdk-deps.js +1 -1
- package/lib/awscdk/cdk-config.js +1 -1
- package/lib/awscdk/cdk-tasks.js +1 -1
- package/lib/awscdk/integration-test.js +1 -1
- package/lib/awscdk/lambda-extension.js +1 -1
- package/lib/awscdk/lambda-function.js +2 -2
- package/lib/build/build-workflow.js +1 -1
- package/lib/cdk/auto-discover-base.js +2 -2
- package/lib/cdk/construct-lib.js +1 -1
- package/lib/cdk/integration-test-base.js +1 -1
- package/lib/cdk/jsii-docgen.js +1 -1
- package/lib/cdk/jsii-project.js +1 -1
- package/lib/cdk8s/auto-discover.js +2 -2
- package/lib/cdk8s/cdk8s-app-py.d.ts +39 -0
- package/lib/cdk8s/cdk8s-app-py.js +79 -0
- package/lib/cdk8s/cdk8s-app-ts.d.ts +3 -68
- package/lib/cdk8s/cdk8s-app-ts.js +9 -24
- package/lib/cdk8s/cdk8s-construct.js +1 -1
- package/lib/cdk8s/cdk8s-deps-js.d.ts +4 -0
- package/lib/cdk8s/cdk8s-deps-js.js +16 -0
- package/lib/cdk8s/cdk8s-deps-py.d.ts +4 -0
- package/lib/cdk8s/cdk8s-deps-py.js +19 -0
- package/lib/cdk8s/cdk8s-deps.d.ts +144 -0
- package/lib/cdk8s/cdk8s-deps.js +109 -0
- package/lib/cdk8s/index.d.ts +3 -0
- package/lib/cdk8s/index.js +4 -1
- package/lib/cdk8s/integration-test.js +1 -1
- package/lib/cdktf/cdktf-construct.js +1 -1
- package/lib/circleci/circleci.js +1 -1
- package/lib/component.js +1 -1
- package/lib/dependencies.js +1 -1
- package/lib/dev-env.js +1 -1
- package/lib/docker-compose.js +2 -2
- package/lib/file.js +1 -1
- package/lib/gitattributes.js +1 -1
- package/lib/github/auto-approve.js +1 -1
- package/lib/github/auto-merge.js +1 -1
- package/lib/github/dependabot.js +1 -1
- package/lib/github/github-credentials.js +1 -1
- package/lib/github/github-project.js +1 -1
- package/lib/github/github.js +1 -1
- package/lib/github/mergify.js +1 -1
- package/lib/github/pr-template.js +1 -1
- package/lib/github/pull-request-lint.js +1 -1
- package/lib/github/stale.js +1 -1
- package/lib/github/task-workflow.js +1 -1
- package/lib/github/workflows.js +1 -1
- package/lib/gitlab/configuration.js +1 -1
- package/lib/gitlab/gitlab-configuration.js +1 -1
- package/lib/gitlab/nested-configuration.js +1 -1
- package/lib/gitpod.js +1 -1
- package/lib/ignore-file.js +1 -1
- package/lib/ini.js +1 -1
- package/lib/java/java-project.js +1 -1
- package/lib/java/junit.js +1 -1
- package/lib/java/maven-compile.js +1 -1
- package/lib/java/maven-packaging.js +1 -1
- package/lib/java/maven-sample.js +1 -1
- package/lib/java/pom.js +1 -1
- package/lib/java/projenrc.js +1 -1
- package/lib/javascript/bundler.js +1 -1
- package/lib/javascript/eslint.js +1 -1
- package/lib/javascript/jest.js +1 -1
- package/lib/javascript/node-package.js +1 -1
- package/lib/javascript/node-project.js +1 -1
- package/lib/javascript/npm-config.js +1 -1
- package/lib/javascript/prettier.js +1 -1
- package/lib/javascript/projenrc.js +1 -1
- package/lib/javascript/typescript-config.js +1 -1
- package/lib/javascript/upgrade-dependencies.js +2 -2
- package/lib/json.js +1 -1
- package/lib/license.js +1 -1
- package/lib/logger.js +1 -1
- package/lib/makefile.js +1 -1
- package/lib/object-file.js +1 -1
- package/lib/project-build.js +1 -1
- package/lib/project.js +1 -1
- package/lib/projects.js +1 -1
- package/lib/projenrc-json.js +1 -1
- package/lib/python/pip.d.ts +2 -2
- package/lib/python/pip.js +8 -8
- package/lib/python/poetry.d.ts +3 -3
- package/lib/python/poetry.js +3 -3
- package/lib/python/projenrc.js +1 -1
- package/lib/python/pytest-sample.d.ts +18 -2
- package/lib/python/pytest-sample.js +8 -5
- package/lib/python/pytest.d.ts +2 -2
- package/lib/python/pytest.js +4 -3
- package/lib/python/python-packaging.d.ts +4 -0
- package/lib/python/python-packaging.js +1 -1
- package/lib/python/python-project.js +9 -4
- package/lib/python/python-sample.d.ts +6 -2
- package/lib/python/python-sample.js +4 -4
- package/lib/python/requirements-file.js +1 -1
- package/lib/python/setuppy.d.ts +2 -2
- package/lib/python/setuppy.js +3 -3
- package/lib/python/setuptools.d.ts +2 -2
- package/lib/python/setuptools.js +10 -6
- package/lib/python/venv.d.ts +2 -2
- package/lib/python/venv.js +2 -2
- package/lib/readme.js +1 -1
- package/lib/release/publisher.js +1 -1
- package/lib/release/release-trigger.js +1 -1
- package/lib/release/release.js +1 -1
- package/lib/renovatebot.js +1 -1
- package/lib/run-task.js +0 -1810
- package/lib/sample-file.js +2 -2
- package/lib/semver.js +1 -1
- package/lib/source-code.js +1 -1
- package/lib/task-runtime.js +1 -1
- package/lib/task.js +1 -1
- package/lib/tasks.js +1 -1
- package/lib/testing.js +1 -1
- package/lib/textfile.js +1 -1
- package/lib/toml.js +1 -1
- package/lib/typescript/projenrc.js +1 -1
- package/lib/typescript/typescript-typedoc.js +1 -1
- package/lib/typescript/typescript.js +3 -3
- package/lib/util/semver.js +5 -5
- package/lib/version.js +1 -1
- package/lib/vscode/devcontainer.js +1 -1
- package/lib/vscode/launch-config.js +1 -1
- package/lib/vscode/vscode.js +1 -1
- package/lib/web/next.js +3 -3
- package/lib/web/postcss.js +1 -1
- package/lib/web/react.js +4 -4
- package/lib/web/tailwind.js +1 -1
- package/lib/xmlfile.js +1 -1
- package/lib/yaml.js +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/README.md +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/index.d.ts +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/package.json +2 -2
- package/node_modules/xmlbuilder2/node_modules/@types/node/test.d.ts +146 -112
- package/package.json +1 -1
package/docs/api/API.md
CHANGED
|
@@ -65,6 +65,9 @@ Name|Description
|
|
|
65
65
|
[cdk.JsiiDocgen](#projen-cdk-jsiidocgen)|Creates a markdown file based on the jsii manifest: - Adds a `docgen` script to package.json - Runs `jsii-docgen` after compilation - Enforces that markdown file is checked in.
|
|
66
66
|
[cdk.JsiiProject](#projen-cdk-jsiiproject)|Multi-language jsii library project.
|
|
67
67
|
[cdk8s.AutoDiscover](#projen-cdk8s-autodiscover)|Automatically discovers and creates `IntegrationTest`s from entry points found in the test tree.
|
|
68
|
+
[cdk8s.Cdk8sDeps](#projen-cdk8s-cdk8sdeps)|Manages dependencies on the CDK8s.
|
|
69
|
+
[cdk8s.Cdk8sDepsPy](#projen-cdk8s-cdk8sdepspy)|*No description*
|
|
70
|
+
[cdk8s.Cdk8sPythonApp](#projen-cdk8s-cdk8spythonapp)|CDK8s app in Python.
|
|
68
71
|
[cdk8s.Cdk8sTypeScriptApp](#projen-cdk8s-cdk8stypescriptapp)|CDK8s app in TypeScript.
|
|
69
72
|
[cdk8s.ConstructLibraryCdk8s](#projen-cdk8s-constructlibrarycdk8s)|CDK8s construct library project.
|
|
70
73
|
[cdk8s.IntegrationTest](#projen-cdk8s-integrationtest)|CDK8S integration test.
|
|
@@ -109,7 +112,7 @@ Name|Description
|
|
|
109
112
|
[python.PoetryPyproject](#projen-python-poetrypyproject)|Represents configuration of a pyproject.toml file for a Poetry project.
|
|
110
113
|
[python.Projenrc](#projen-python-projenrc)|Allows writing projenrc files in python.
|
|
111
114
|
[python.Pytest](#projen-python-pytest)|*No description*
|
|
112
|
-
[python.PytestSample](#projen-python-pytestsample)
|
|
115
|
+
[python.PytestSample](#projen-python-pytestsample)|Python test code sample.
|
|
113
116
|
[python.PythonProject](#projen-python-pythonproject)|Python project.
|
|
114
117
|
[python.PythonSample](#projen-python-pythonsample)|Python code sample.
|
|
115
118
|
[python.RequirementsFile](#projen-python-requirementsfile)|Specifies a list of packages to be installed using pip.
|
|
@@ -223,6 +226,10 @@ Name|Description
|
|
|
223
226
|
[cdk.JsiiProjectOptions](#projen-cdk-jsiiprojectoptions)|*No description*
|
|
224
227
|
[cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget)|*No description*
|
|
225
228
|
[cdk8s.AutoDiscoverOptions](#projen-cdk8s-autodiscoveroptions)|Options for `AutoDiscover`.
|
|
229
|
+
[cdk8s.Cdk8sDepsCommonOptions](#projen-cdk8s-cdk8sdepscommonoptions)|Options for `Cdk8sDeps`.
|
|
230
|
+
[cdk8s.Cdk8sDepsOptions](#projen-cdk8s-cdk8sdepsoptions)|*No description*
|
|
231
|
+
[cdk8s.Cdk8sPackageNames](#projen-cdk8s-cdk8spackagenames)|*No description*
|
|
232
|
+
[cdk8s.Cdk8sPythonOptions](#projen-cdk8s-cdk8spythonoptions)|Options for `Cdk8sPythonApp`.
|
|
226
233
|
[cdk8s.Cdk8sTypeScriptAppOptions](#projen-cdk8s-cdk8stypescriptappoptions)|*No description*
|
|
227
234
|
[cdk8s.ConstructLibraryCdk8sOptions](#projen-cdk8s-constructlibrarycdk8soptions)|*No description*
|
|
228
235
|
[cdk8s.IntegrationTestAutoDiscoverOptions](#projen-cdk8s-integrationtestautodiscoveroptions)|*No description*
|
|
@@ -335,6 +342,7 @@ Name|Description
|
|
|
335
342
|
[python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps)|Poetry-specific options.
|
|
336
343
|
[python.ProjenrcOptions](#projen-python-projenrcoptions)|Options for `Projenrc`.
|
|
337
344
|
[python.PytestOptions](#projen-python-pytestoptions)|*No description*
|
|
345
|
+
[python.PytestSampleOptions](#projen-python-pytestsampleoptions)|Options for python test code sample.
|
|
338
346
|
[python.PythonPackagingOptions](#projen-python-pythonpackagingoptions)|*No description*
|
|
339
347
|
[python.PythonProjectOptions](#projen-python-pythonprojectoptions)|Options for `PythonProject`.
|
|
340
348
|
[python.PythonSampleOptions](#projen-python-pythonsampleoptions)|Options for python sample code.
|
|
@@ -3718,6 +3726,7 @@ new awscdk.AwsCdkPythonApp(options: AwsCdkPythonAppOptions)
|
|
|
3718
3726
|
* **description** (<code>string</code>) A short description of the package. __*Optional*__
|
|
3719
3727
|
* **homepage** (<code>string</code>) A URL to the website of the project. __*Optional*__
|
|
3720
3728
|
* **license** (<code>string</code>) License of this package as an SPDX identifier. __*Optional*__
|
|
3729
|
+
* **packageName** (<code>string</code>) Package name. __*Optional*__
|
|
3721
3730
|
* **poetryOptions** (<code>[python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps)</code>) Additional options to set for poetry if using poetry. __*Optional*__
|
|
3722
3731
|
* **setupConfig** (<code>Map<string, any></code>) Additional fields to pass in the setup() function if using setuptools. __*Optional*__
|
|
3723
3732
|
* **moduleName** (<code>string</code>) Name of the python package as used in imports and filenames.
|
|
@@ -5146,6 +5155,212 @@ new cdk8s.AutoDiscover(project: Project, options: AutoDiscoverOptions)
|
|
|
5146
5155
|
|
|
5147
5156
|
|
|
5148
5157
|
|
|
5158
|
+
## class Cdk8sDeps 🔹 <a id="projen-cdk8s-cdk8sdeps"></a>
|
|
5159
|
+
|
|
5160
|
+
Manages dependencies on the CDK8s.
|
|
5161
|
+
|
|
5162
|
+
__Submodule__: cdk8s
|
|
5163
|
+
|
|
5164
|
+
__Extends__: [Component](#projen-component)
|
|
5165
|
+
__Implemented by__: [cdk8s.Cdk8sDepsPy](#projen-cdk8s-cdk8sdepspy)
|
|
5166
|
+
|
|
5167
|
+
### Initializer
|
|
5168
|
+
|
|
5169
|
+
|
|
5170
|
+
|
|
5171
|
+
|
|
5172
|
+
```ts
|
|
5173
|
+
new cdk8s.Cdk8sDeps(project: Project, options: Cdk8sDepsOptions)
|
|
5174
|
+
```
|
|
5175
|
+
|
|
5176
|
+
* **project** (<code>[Project](#projen-project)</code>) *No description*
|
|
5177
|
+
* **options** (<code>[cdk8s.Cdk8sDepsOptions](#projen-cdk8s-cdk8sdepsoptions)</code>) *No description*
|
|
5178
|
+
* **cdk8sVersion** (<code>string</code>) Minumum version of the cdk8s to depend on.
|
|
5179
|
+
* **cdk8sCliVersion** (<code>string</code>) Minumum version of the cdk8s-cli to depend on. __*Default*__: "2.0.28"
|
|
5180
|
+
* **cdk8sCliVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for cdk8s-cli. __*Default*__: false
|
|
5181
|
+
* **cdk8sPlus** (<code>boolean</code>) Include cdk8s-plus. __*Default*__: true
|
|
5182
|
+
* **cdk8sPlusVersion** (<code>string</code>) Minumum version of the cdk8s-plus-XX to depend on. __*Default*__: "2.0.0-rc.26"
|
|
5183
|
+
* **cdk8sPlusVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for cdk8s-plus-17. __*Default*__: false
|
|
5184
|
+
* **cdk8sVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for cdk8s. __*Default*__: false
|
|
5185
|
+
* **constructsVersion** (<code>string</code>) Minimum version of the `constructs` library to depend on. __*Default*__: "10.1.42"
|
|
5186
|
+
* **constructsVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for constructs. __*Default*__: false
|
|
5187
|
+
* **k8sMinorVersion** (<code>number</code>) The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0. __*Default*__: 22
|
|
5188
|
+
* **cdk8sCliDependency** (<code>boolean</code>) Add cdk8s-cli only to Node projects.
|
|
5189
|
+
* **dependencyType** (<code>[DependencyType](#projen-dependencytype)</code>) The type of dependency to use for runtime CDK8s and `constructs` modules.
|
|
5190
|
+
|
|
5191
|
+
|
|
5192
|
+
|
|
5193
|
+
### Properties
|
|
5194
|
+
|
|
5195
|
+
|
|
5196
|
+
Name | Type | Description
|
|
5197
|
+
-----|------|-------------
|
|
5198
|
+
**cdk8sMajorVersion**🔹 | <code>number</code> | The major version of the CDK8s (e.g. 1, 2, ...).
|
|
5199
|
+
**cdk8sMinimumVersion**🔹 | <code>string</code> | The minimum version of the CDK8s (e.g. `2.0.0`).
|
|
5200
|
+
**cdk8sVersion**🔹 | <code>string</code> | The dependency requirement for CDK8s.
|
|
5201
|
+
|
|
5202
|
+
### Methods
|
|
5203
|
+
|
|
5204
|
+
|
|
5205
|
+
#### protected packageNames()🔹 <a id="projen-cdk8s-cdk8sdeps-packagenames"></a>
|
|
5206
|
+
|
|
5207
|
+
Return a configuration object with information about package naming in various languages.
|
|
5208
|
+
|
|
5209
|
+
```ts
|
|
5210
|
+
protected packageNames(): Cdk8sPackageNames
|
|
5211
|
+
```
|
|
5212
|
+
|
|
5213
|
+
|
|
5214
|
+
__Returns__:
|
|
5215
|
+
* <code>[cdk8s.Cdk8sPackageNames](#projen-cdk8s-cdk8spackagenames)</code>
|
|
5216
|
+
|
|
5217
|
+
|
|
5218
|
+
|
|
5219
|
+
## class Cdk8sDepsPy 🔹 <a id="projen-cdk8s-cdk8sdepspy"></a>
|
|
5220
|
+
|
|
5221
|
+
|
|
5222
|
+
|
|
5223
|
+
__Submodule__: cdk8s
|
|
5224
|
+
|
|
5225
|
+
__Extends__: [cdk8s.Cdk8sDeps](#projen-cdk8s-cdk8sdeps)
|
|
5226
|
+
|
|
5227
|
+
### Initializer
|
|
5228
|
+
|
|
5229
|
+
|
|
5230
|
+
|
|
5231
|
+
|
|
5232
|
+
```ts
|
|
5233
|
+
new cdk8s.Cdk8sDepsPy(project: Project, options: Cdk8sDepsOptions)
|
|
5234
|
+
```
|
|
5235
|
+
|
|
5236
|
+
* **project** (<code>[Project](#projen-project)</code>) *No description*
|
|
5237
|
+
* **options** (<code>[cdk8s.Cdk8sDepsOptions](#projen-cdk8s-cdk8sdepsoptions)</code>) *No description*
|
|
5238
|
+
* **cdk8sVersion** (<code>string</code>) Minumum version of the cdk8s to depend on.
|
|
5239
|
+
* **cdk8sCliVersion** (<code>string</code>) Minumum version of the cdk8s-cli to depend on. __*Default*__: "2.0.28"
|
|
5240
|
+
* **cdk8sCliVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for cdk8s-cli. __*Default*__: false
|
|
5241
|
+
* **cdk8sPlus** (<code>boolean</code>) Include cdk8s-plus. __*Default*__: true
|
|
5242
|
+
* **cdk8sPlusVersion** (<code>string</code>) Minumum version of the cdk8s-plus-XX to depend on. __*Default*__: "2.0.0-rc.26"
|
|
5243
|
+
* **cdk8sPlusVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for cdk8s-plus-17. __*Default*__: false
|
|
5244
|
+
* **cdk8sVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for cdk8s. __*Default*__: false
|
|
5245
|
+
* **constructsVersion** (<code>string</code>) Minimum version of the `constructs` library to depend on. __*Default*__: "10.1.42"
|
|
5246
|
+
* **constructsVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for constructs. __*Default*__: false
|
|
5247
|
+
* **k8sMinorVersion** (<code>number</code>) The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0. __*Default*__: 22
|
|
5248
|
+
* **cdk8sCliDependency** (<code>boolean</code>) Add cdk8s-cli only to Node projects.
|
|
5249
|
+
* **dependencyType** (<code>[DependencyType](#projen-dependencytype)</code>) The type of dependency to use for runtime CDK8s and `constructs` modules.
|
|
5250
|
+
|
|
5251
|
+
|
|
5252
|
+
### Methods
|
|
5253
|
+
|
|
5254
|
+
|
|
5255
|
+
#### protected packageNames()🔹 <a id="projen-cdk8s-cdk8sdepspy-packagenames"></a>
|
|
5256
|
+
|
|
5257
|
+
Return a configuration object with information about package naming in various languages.
|
|
5258
|
+
|
|
5259
|
+
```ts
|
|
5260
|
+
protected packageNames(): Cdk8sPackageNames
|
|
5261
|
+
```
|
|
5262
|
+
|
|
5263
|
+
|
|
5264
|
+
__Returns__:
|
|
5265
|
+
* <code>[cdk8s.Cdk8sPackageNames](#projen-cdk8s-cdk8spackagenames)</code>
|
|
5266
|
+
|
|
5267
|
+
|
|
5268
|
+
|
|
5269
|
+
## class Cdk8sPythonApp 🔹 <a id="projen-cdk8s-cdk8spythonapp"></a>
|
|
5270
|
+
|
|
5271
|
+
CDK8s app in Python.
|
|
5272
|
+
|
|
5273
|
+
__Submodule__: cdk8s
|
|
5274
|
+
|
|
5275
|
+
__Extends__: [python.PythonProject](#projen-python-pythonproject)
|
|
5276
|
+
|
|
5277
|
+
### Initializer
|
|
5278
|
+
|
|
5279
|
+
|
|
5280
|
+
|
|
5281
|
+
|
|
5282
|
+
```ts
|
|
5283
|
+
new cdk8s.Cdk8sPythonApp(options: Cdk8sPythonOptions)
|
|
5284
|
+
```
|
|
5285
|
+
|
|
5286
|
+
* **options** (<code>[cdk8s.Cdk8sPythonOptions](#projen-cdk8s-cdk8spythonoptions)</code>) *No description*
|
|
5287
|
+
* **name** (<code>string</code>) This is the name of your project.
|
|
5288
|
+
* **logging** (<code>[LoggerOptions](#projen-loggeroptions)</code>) Configure logging options such as verbosity. __*Default*__: {}
|
|
5289
|
+
* **outdir** (<code>string</code>) The root directory of the project. __*Default*__: "."
|
|
5290
|
+
* **parent** (<code>[Project](#projen-project)</code>) The parent project, if this project is part of a bigger project. __*Optional*__
|
|
5291
|
+
* **projenCommand** (<code>string</code>) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
|
|
5292
|
+
* **projenrcJson** (<code>boolean</code>) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
|
|
5293
|
+
* **projenrcJsonOptions** (<code>[ProjenrcOptions](#projen-projenrcoptions)</code>) Options for .projenrc.json. __*Default*__: default options
|
|
5294
|
+
* **renovatebot** (<code>boolean</code>) Use renovatebot to handle dependency upgrades. __*Default*__: false
|
|
5295
|
+
* **renovatebotOptions** (<code>[RenovatebotOptions](#projen-renovatebotoptions)</code>) Options for renovatebot. __*Default*__: default options
|
|
5296
|
+
* **autoApproveOptions** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
|
|
5297
|
+
* **autoMerge** (<code>boolean</code>) Enable automatic merging on GitHub. __*Default*__: true
|
|
5298
|
+
* **autoMergeOptions** (<code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code>) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
|
|
5299
|
+
* **clobber** (<code>boolean</code>) Add a `clobber` task which resets the repo to origin. __*Default*__: true
|
|
5300
|
+
* **devContainer** (<code>boolean</code>) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
|
|
5301
|
+
* **github** (<code>boolean</code>) Enable GitHub integration. __*Default*__: true
|
|
5302
|
+
* **githubOptions** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) Options for GitHub integration. __*Default*__: see GitHubOptions
|
|
5303
|
+
* **gitpod** (<code>boolean</code>) Add a Gitpod development environment. __*Default*__: false
|
|
5304
|
+
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
5305
|
+
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
5306
|
+
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
5307
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
5308
|
+
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
5309
|
+
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
5310
|
+
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
5311
|
+
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
5312
|
+
* **vscode** (<code>boolean</code>) Enable VSCode integration. __*Default*__: true
|
|
5313
|
+
* **authorEmail** (<code>string</code>) Author's e-mail.
|
|
5314
|
+
* **authorName** (<code>string</code>) Author's name.
|
|
5315
|
+
* **version** (<code>string</code>) Version of the package.
|
|
5316
|
+
* **classifiers** (<code>Array<string></code>) A list of PyPI trove classifiers that describe the project. __*Optional*__
|
|
5317
|
+
* **description** (<code>string</code>) A short description of the package. __*Optional*__
|
|
5318
|
+
* **homepage** (<code>string</code>) A URL to the website of the project. __*Optional*__
|
|
5319
|
+
* **license** (<code>string</code>) License of this package as an SPDX identifier. __*Optional*__
|
|
5320
|
+
* **packageName** (<code>string</code>) Package name. __*Optional*__
|
|
5321
|
+
* **poetryOptions** (<code>[python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps)</code>) Additional options to set for poetry if using poetry. __*Optional*__
|
|
5322
|
+
* **setupConfig** (<code>Map<string, any></code>) Additional fields to pass in the setup() function if using setuptools. __*Optional*__
|
|
5323
|
+
* **moduleName** (<code>string</code>) Name of the python package as used in imports and filenames.
|
|
5324
|
+
* **deps** (<code>Array<string></code>) List of runtime dependencies for this project. __*Default*__: []
|
|
5325
|
+
* **devDeps** (<code>Array<string></code>) List of dev dependencies for this project. __*Default*__: []
|
|
5326
|
+
* **pip** (<code>boolean</code>) Use pip with a requirements.txt file to track project dependencies. __*Default*__: true
|
|
5327
|
+
* **poetry** (<code>boolean</code>) Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. __*Default*__: false
|
|
5328
|
+
* **projenrcJs** (<code>boolean</code>) Use projenrc in javascript. __*Default*__: false
|
|
5329
|
+
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options related to projenrc in JavaScript. __*Default*__: default options
|
|
5330
|
+
* **projenrcPython** (<code>boolean</code>) Use projenrc in Python. __*Default*__: true
|
|
5331
|
+
* **projenrcPythonOptions** (<code>[python.ProjenrcOptions](#projen-python-projenrcoptions)</code>) Options related to projenrc in python. __*Default*__: default options
|
|
5332
|
+
* **pytest** (<code>boolean</code>) Include pytest tests. __*Default*__: true
|
|
5333
|
+
* **pytestOptions** (<code>[python.PytestOptions](#projen-python-pytestoptions)</code>) pytest options. __*Default*__: defaults
|
|
5334
|
+
* **sample** (<code>boolean</code>) Include sample code and test if the relevant directories don't exist. __*Default*__: true
|
|
5335
|
+
* **setuptools** (<code>boolean</code>) Use setuptools with a setup.py script for packaging and publishing. __*Default*__: true if the project type is library
|
|
5336
|
+
* **venv** (<code>boolean</code>) Use venv to manage a virtual environment for installing dependencies inside. __*Default*__: true
|
|
5337
|
+
* **venvOptions** (<code>[python.VenvOptions](#projen-python-venvoptions)</code>) Venv options. __*Default*__: defaults
|
|
5338
|
+
* **cdk8sVersion** (<code>string</code>) Minumum version of the cdk8s to depend on.
|
|
5339
|
+
* **cdk8sCliVersion** (<code>string</code>) Minumum version of the cdk8s-cli to depend on. __*Default*__: "2.0.28"
|
|
5340
|
+
* **cdk8sCliVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for cdk8s-cli. __*Default*__: false
|
|
5341
|
+
* **cdk8sPlus** (<code>boolean</code>) Include cdk8s-plus. __*Default*__: true
|
|
5342
|
+
* **cdk8sPlusVersion** (<code>string</code>) Minumum version of the cdk8s-plus-XX to depend on. __*Default*__: "2.0.0-rc.26"
|
|
5343
|
+
* **cdk8sPlusVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for cdk8s-plus-17. __*Default*__: false
|
|
5344
|
+
* **cdk8sVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for cdk8s. __*Default*__: false
|
|
5345
|
+
* **constructsVersion** (<code>string</code>) Minimum version of the `constructs` library to depend on. __*Default*__: "10.1.42"
|
|
5346
|
+
* **constructsVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for constructs. __*Default*__: false
|
|
5347
|
+
* **k8sMinorVersion** (<code>number</code>) The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0. __*Default*__: 22
|
|
5348
|
+
* **appEntrypoint** (<code>string</code>) The CDK8s app's entrypoint. __*Default*__: "app.py"
|
|
5349
|
+
* **cdk8sImports** (<code>Array<string></code>) Import additional specs. __*Default*__: no additional specs imported
|
|
5350
|
+
* **k8sSpecVersion** (<code>string</code>) Import a specific Kubernetes spec version. __*Default*__: Use the cdk8s default
|
|
5351
|
+
|
|
5352
|
+
|
|
5353
|
+
|
|
5354
|
+
### Properties
|
|
5355
|
+
|
|
5356
|
+
|
|
5357
|
+
Name | Type | Description
|
|
5358
|
+
-----|------|-------------
|
|
5359
|
+
**appEntrypoint**🔹 | <code>string</code> | The CDK8s app entrypoint.
|
|
5360
|
+
**cdk8sDeps**🔹 | <code>[cdk8s.Cdk8sDeps](#projen-cdk8s-cdk8sdeps)</code> | <span></span>
|
|
5361
|
+
|
|
5362
|
+
|
|
5363
|
+
|
|
5149
5364
|
## class Cdk8sTypeScriptApp 🔹 <a id="projen-cdk8s-cdk8stypescriptapp"></a>
|
|
5150
5365
|
|
|
5151
5366
|
CDK8s app in TypeScript.
|
|
@@ -5294,15 +5509,18 @@ new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
|
|
|
5294
5509
|
* **tsconfigDev** (<code>[javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)</code>) Custom tsconfig options for the development tsconfig.json file (used for testing). __*Default*__: use the production tsconfig options
|
|
5295
5510
|
* **tsconfigDevFile** (<code>string</code>) The name of the development tsconfig.json file. __*Default*__: "tsconfig.dev.json"
|
|
5296
5511
|
* **typescriptVersion** (<code>string</code>) TypeScript version to use. __*Default*__: "latest"
|
|
5297
|
-
* **cdk8sVersion** (<code>string</code>)
|
|
5298
|
-
* **
|
|
5299
|
-
* **
|
|
5300
|
-
* **
|
|
5301
|
-
* **
|
|
5512
|
+
* **cdk8sVersion** (<code>string</code>) Minumum version of the cdk8s to depend on.
|
|
5513
|
+
* **cdk8sCliVersion** (<code>string</code>) Minumum version of the cdk8s-cli to depend on. __*Default*__: "2.0.28"
|
|
5514
|
+
* **cdk8sCliVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for cdk8s-cli. __*Default*__: false
|
|
5515
|
+
* **cdk8sPlus** (<code>boolean</code>) Include cdk8s-plus. __*Default*__: true
|
|
5516
|
+
* **cdk8sPlusVersion** (<code>string</code>) Minumum version of the cdk8s-plus-XX to depend on. __*Default*__: "2.0.0-rc.26"
|
|
5302
5517
|
* **cdk8sPlusVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for cdk8s-plus-17. __*Default*__: false
|
|
5303
|
-
* **cdk8sVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for
|
|
5304
|
-
* **constructsVersion** (<code>string</code>) constructs
|
|
5518
|
+
* **cdk8sVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for cdk8s. __*Default*__: false
|
|
5519
|
+
* **constructsVersion** (<code>string</code>) Minimum version of the `constructs` library to depend on. __*Default*__: "10.1.42"
|
|
5305
5520
|
* **constructsVersionPinning** (<code>boolean</code>) Use pinned version instead of caret version for constructs. __*Default*__: false
|
|
5521
|
+
* **k8sMinorVersion** (<code>number</code>) The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0. __*Default*__: 22
|
|
5522
|
+
* **appEntrypoint** (<code>string</code>) The CDK8s app's entrypoint (relative to the source directory, which is "src" by default). __*Default*__: "main.ts"
|
|
5523
|
+
* **cdk8sImports** (<code>Array<string></code>) Import additional specs. __*Default*__: no additional specs imported
|
|
5306
5524
|
* **integrationTestAutoDiscover** (<code>boolean</code>) Automatically adds an `cdk8s.IntegrationTest` for each `.integ.ts` app in your test directory. If this is disabled, you can manually add an `cdk8s.AutoDiscover` component to your project. __*Default*__: true
|
|
5307
5525
|
* **k8sSpecVersion** (<code>string</code>) Import a specific Kubernetes spec version. __*Default*__: Use the cdk8s default
|
|
5308
5526
|
|
|
@@ -5314,9 +5532,7 @@ new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
|
|
|
5314
5532
|
Name | Type | Description
|
|
5315
5533
|
-----|------|-------------
|
|
5316
5534
|
**appEntrypoint**🔹 | <code>string</code> | The CDK8s app entrypoint.
|
|
5317
|
-
**
|
|
5318
|
-
**cdk8sVersion**🔹 | <code>string</code> | The CDK8s version this app is using.
|
|
5319
|
-
**constructsVersion**🔹 | <code>string</code> | The constructs version this app is using.
|
|
5535
|
+
**cdk8sDeps**🔹 | <code>[cdk8s.Cdk8sDeps](#projen-cdk8s-cdk8sdeps)</code> | <span></span>
|
|
5320
5536
|
|
|
5321
5537
|
|
|
5322
5538
|
|
|
@@ -8514,10 +8730,10 @@ __Extends__: [Component](#projen-component)
|
|
|
8514
8730
|
|
|
8515
8731
|
|
|
8516
8732
|
```ts
|
|
8517
|
-
new python.Pip(project:
|
|
8733
|
+
new python.Pip(project: Project, _options?: PipOptions)
|
|
8518
8734
|
```
|
|
8519
8735
|
|
|
8520
|
-
* **project** (<code>[
|
|
8736
|
+
* **project** (<code>[Project](#projen-project)</code>) *No description*
|
|
8521
8737
|
* **_options** (<code>[python.PipOptions](#projen-python-pipoptions)</code>) *No description*
|
|
8522
8738
|
|
|
8523
8739
|
|
|
@@ -8587,10 +8803,10 @@ __Extends__: [Component](#projen-component)
|
|
|
8587
8803
|
|
|
8588
8804
|
|
|
8589
8805
|
```ts
|
|
8590
|
-
new python.Poetry(project:
|
|
8806
|
+
new python.Poetry(project: Project, options: PythonPackagingOptions)
|
|
8591
8807
|
```
|
|
8592
8808
|
|
|
8593
|
-
* **project** (<code>[
|
|
8809
|
+
* **project** (<code>[Project](#projen-project)</code>) *No description*
|
|
8594
8810
|
* **options** (<code>[python.PythonPackagingOptions](#projen-python-pythonpackagingoptions)</code>) *No description*
|
|
8595
8811
|
* **authorEmail** (<code>string</code>) Author's e-mail.
|
|
8596
8812
|
* **authorName** (<code>string</code>) Author's name.
|
|
@@ -8599,6 +8815,7 @@ new python.Poetry(project: PythonProject, options: PythonPackagingOptions)
|
|
|
8599
8815
|
* **description** (<code>string</code>) A short description of the package. __*Optional*__
|
|
8600
8816
|
* **homepage** (<code>string</code>) A URL to the website of the project. __*Optional*__
|
|
8601
8817
|
* **license** (<code>string</code>) License of this package as an SPDX identifier. __*Optional*__
|
|
8818
|
+
* **packageName** (<code>string</code>) Package name. __*Optional*__
|
|
8602
8819
|
* **poetryOptions** (<code>[python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps)</code>) Additional options to set for poetry if using poetry. __*Optional*__
|
|
8603
8820
|
* **setupConfig** (<code>Map<string, any></code>) Additional fields to pass in the setup() function if using setuptools. __*Optional*__
|
|
8604
8821
|
|
|
@@ -8682,10 +8899,10 @@ __Extends__: [Component](#projen-component)
|
|
|
8682
8899
|
|
|
8683
8900
|
|
|
8684
8901
|
```ts
|
|
8685
|
-
new python.PoetryPyproject(project:
|
|
8902
|
+
new python.PoetryPyproject(project: Project, options: PoetryPyprojectOptions)
|
|
8686
8903
|
```
|
|
8687
8904
|
|
|
8688
|
-
* **project** (<code>[
|
|
8905
|
+
* **project** (<code>[Project](#projen-project)</code>) *No description*
|
|
8689
8906
|
* **options** (<code>[python.PoetryPyprojectOptions](#projen-python-poetrypyprojectoptions)</code>) *No description*
|
|
8690
8907
|
* **authors** (<code>Array<string></code>) The authors of the package. __*Optional*__
|
|
8691
8908
|
* **classifiers** (<code>Array<string></code>) A list of PyPI trove classifiers that describe the project. __*Optional*__
|
|
@@ -8763,10 +8980,10 @@ __Extends__: [Component](#projen-component)
|
|
|
8763
8980
|
|
|
8764
8981
|
|
|
8765
8982
|
```ts
|
|
8766
|
-
new python.Pytest(project:
|
|
8983
|
+
new python.Pytest(project: Project, options?: PytestOptions)
|
|
8767
8984
|
```
|
|
8768
8985
|
|
|
8769
|
-
* **project** (<code>[
|
|
8986
|
+
* **project** (<code>[Project](#projen-project)</code>) *No description*
|
|
8770
8987
|
* **options** (<code>[python.PytestOptions](#projen-python-pytestoptions)</code>) *No description*
|
|
8771
8988
|
* **maxFailures** (<code>number</code>) Stop the testing process after the first N failures. __*Optional*__
|
|
8772
8989
|
* **testdir** (<code>string</code>) Directory with tests. __*Default*__: 'tests'
|
|
@@ -8785,7 +9002,7 @@ Name | Type | Description
|
|
|
8785
9002
|
|
|
8786
9003
|
## class PytestSample 🔹 <a id="projen-python-pytestsample"></a>
|
|
8787
9004
|
|
|
8788
|
-
|
|
9005
|
+
Python test code sample.
|
|
8789
9006
|
|
|
8790
9007
|
__Submodule__: python
|
|
8791
9008
|
|
|
@@ -8797,11 +9014,13 @@ __Extends__: [Component](#projen-component)
|
|
|
8797
9014
|
|
|
8798
9015
|
|
|
8799
9016
|
```ts
|
|
8800
|
-
new python.PytestSample(project:
|
|
9017
|
+
new python.PytestSample(project: Project, options: PytestSampleOptions)
|
|
8801
9018
|
```
|
|
8802
9019
|
|
|
8803
|
-
* **project** (<code>[
|
|
8804
|
-
* **
|
|
9020
|
+
* **project** (<code>[Project](#projen-project)</code>) *No description*
|
|
9021
|
+
* **options** (<code>[python.PytestSampleOptions](#projen-python-pytestsampleoptions)</code>) *No description*
|
|
9022
|
+
* **moduleName** (<code>string</code>) Name of the python package as used in imports and filenames.
|
|
9023
|
+
* **testdir** (<code>string</code>) Test directory.
|
|
8805
9024
|
|
|
8806
9025
|
|
|
8807
9026
|
|
|
@@ -8857,6 +9076,7 @@ new python.PythonProject(options: PythonProjectOptions)
|
|
|
8857
9076
|
* **description** (<code>string</code>) A short description of the package. __*Optional*__
|
|
8858
9077
|
* **homepage** (<code>string</code>) A URL to the website of the project. __*Optional*__
|
|
8859
9078
|
* **license** (<code>string</code>) License of this package as an SPDX identifier. __*Optional*__
|
|
9079
|
+
* **packageName** (<code>string</code>) Package name. __*Optional*__
|
|
8860
9080
|
* **poetryOptions** (<code>[python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps)</code>) Additional options to set for poetry if using poetry. __*Optional*__
|
|
8861
9081
|
* **setupConfig** (<code>Map<string, any></code>) Additional fields to pass in the setup() function if using setuptools. __*Optional*__
|
|
8862
9082
|
* **moduleName** (<code>string</code>) Name of the python package as used in imports and filenames.
|
|
@@ -8948,11 +9168,12 @@ __Extends__: [Component](#projen-component)
|
|
|
8948
9168
|
|
|
8949
9169
|
|
|
8950
9170
|
```ts
|
|
8951
|
-
new python.PythonSample(project:
|
|
9171
|
+
new python.PythonSample(project: Project, options: PythonSampleOptions)
|
|
8952
9172
|
```
|
|
8953
9173
|
|
|
8954
|
-
* **project** (<code>[
|
|
8955
|
-
* **
|
|
9174
|
+
* **project** (<code>[Project](#projen-project)</code>) *No description*
|
|
9175
|
+
* **options** (<code>[python.PythonSampleOptions](#projen-python-pythonsampleoptions)</code>) *No description*
|
|
9176
|
+
* **dir** (<code>string</code>) Sample code directory.
|
|
8956
9177
|
|
|
8957
9178
|
|
|
8958
9179
|
|
|
@@ -9027,10 +9248,10 @@ __Extends__: [FileBase](#projen-filebase)
|
|
|
9027
9248
|
|
|
9028
9249
|
|
|
9029
9250
|
```ts
|
|
9030
|
-
new python.SetupPy(project:
|
|
9251
|
+
new python.SetupPy(project: Project, options: SetupPyOptions)
|
|
9031
9252
|
```
|
|
9032
9253
|
|
|
9033
|
-
* **project** (<code>[
|
|
9254
|
+
* **project** (<code>[Project](#projen-project)</code>) *No description*
|
|
9034
9255
|
* **options** (<code>[python.SetupPyOptions](#projen-python-setuppyoptions)</code>) *No description*
|
|
9035
9256
|
* **authorEmail** (<code>string</code>) Author's e-mail. __*Optional*__
|
|
9036
9257
|
* **authorName** (<code>string</code>) Author's name. __*Optional*__
|
|
@@ -9076,10 +9297,10 @@ __Extends__: [Component](#projen-component)
|
|
|
9076
9297
|
|
|
9077
9298
|
|
|
9078
9299
|
```ts
|
|
9079
|
-
new python.Setuptools(project:
|
|
9300
|
+
new python.Setuptools(project: Project, options: PythonPackagingOptions)
|
|
9080
9301
|
```
|
|
9081
9302
|
|
|
9082
|
-
* **project** (<code>[
|
|
9303
|
+
* **project** (<code>[Project](#projen-project)</code>) *No description*
|
|
9083
9304
|
* **options** (<code>[python.PythonPackagingOptions](#projen-python-pythonpackagingoptions)</code>) *No description*
|
|
9084
9305
|
* **authorEmail** (<code>string</code>) Author's e-mail.
|
|
9085
9306
|
* **authorName** (<code>string</code>) Author's name.
|
|
@@ -9088,6 +9309,7 @@ new python.Setuptools(project: PythonProject, options: PythonPackagingOptions)
|
|
|
9088
9309
|
* **description** (<code>string</code>) A short description of the package. __*Optional*__
|
|
9089
9310
|
* **homepage** (<code>string</code>) A URL to the website of the project. __*Optional*__
|
|
9090
9311
|
* **license** (<code>string</code>) License of this package as an SPDX identifier. __*Optional*__
|
|
9312
|
+
* **packageName** (<code>string</code>) Package name. __*Optional*__
|
|
9091
9313
|
* **poetryOptions** (<code>[python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps)</code>) Additional options to set for poetry if using poetry. __*Optional*__
|
|
9092
9314
|
* **setupConfig** (<code>Map<string, any></code>) Additional fields to pass in the setup() function if using setuptools. __*Optional*__
|
|
9093
9315
|
|
|
@@ -9118,10 +9340,10 @@ __Extends__: [Component](#projen-component)
|
|
|
9118
9340
|
|
|
9119
9341
|
|
|
9120
9342
|
```ts
|
|
9121
|
-
new python.Venv(project:
|
|
9343
|
+
new python.Venv(project: Project, options?: VenvOptions)
|
|
9122
9344
|
```
|
|
9123
9345
|
|
|
9124
|
-
* **project** (<code>[
|
|
9346
|
+
* **project** (<code>[Project](#projen-project)</code>) *No description*
|
|
9125
9347
|
* **options** (<code>[python.VenvOptions](#projen-python-venvoptions)</code>) *No description*
|
|
9126
9348
|
* **envdir** (<code>string</code>) Name of directory to store the environment in. __*Default*__: ".env"
|
|
9127
9349
|
|
|
@@ -12350,6 +12572,7 @@ Name | Type | Description
|
|
|
12350
12572
|
**mergify**?⚠️ | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
|
|
12351
12573
|
**mergifyOptions**?⚠️ | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
|
|
12352
12574
|
**outdir**?🔹 | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
|
|
12575
|
+
**packageName**?🔹 | <code>string</code> | Package name.<br/>__*Optional*__
|
|
12353
12576
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
12354
12577
|
**pip**?🔹 | <code>boolean</code> | Use pip with a requirements.txt file to track project dependencies.<br/>__*Default*__: true
|
|
12355
12578
|
**poetry**?🔹 | <code>boolean</code> | Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.<br/>__*Default*__: false
|
|
@@ -13459,6 +13682,145 @@ Name | Type | Description
|
|
|
13459
13682
|
|
|
13460
13683
|
|
|
13461
13684
|
|
|
13685
|
+
## struct Cdk8sDepsCommonOptions 🔹 <a id="projen-cdk8s-cdk8sdepscommonoptions"></a>
|
|
13686
|
+
|
|
13687
|
+
|
|
13688
|
+
Options for `Cdk8sDeps`.
|
|
13689
|
+
|
|
13690
|
+
|
|
13691
|
+
|
|
13692
|
+
Name | Type | Description
|
|
13693
|
+
-----|------|-------------
|
|
13694
|
+
**cdk8sVersion**🔹 | <code>string</code> | Minumum version of the cdk8s to depend on.
|
|
13695
|
+
**cdk8sCliVersion**?🔹 | <code>string</code> | Minumum version of the cdk8s-cli to depend on.<br/>__*Default*__: "2.0.28"
|
|
13696
|
+
**cdk8sCliVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for cdk8s-cli.<br/>__*Default*__: false
|
|
13697
|
+
**cdk8sPlus**?🔹 | <code>boolean</code> | Include cdk8s-plus.<br/>__*Default*__: true
|
|
13698
|
+
**cdk8sPlusVersion**?🔹 | <code>string</code> | Minumum version of the cdk8s-plus-XX to depend on.<br/>__*Default*__: "2.0.0-rc.26"
|
|
13699
|
+
**cdk8sPlusVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for cdk8s-plus-17.<br/>__*Default*__: false
|
|
13700
|
+
**cdk8sVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for cdk8s.<br/>__*Default*__: false
|
|
13701
|
+
**constructsVersion**?🔹 | <code>string</code> | Minimum version of the `constructs` library to depend on.<br/>__*Default*__: "10.1.42"
|
|
13702
|
+
**constructsVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for constructs.<br/>__*Default*__: false
|
|
13703
|
+
**k8sMinorVersion**?🔹 | <code>number</code> | The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0.<br/>__*Default*__: 22
|
|
13704
|
+
|
|
13705
|
+
|
|
13706
|
+
|
|
13707
|
+
## struct Cdk8sDepsOptions 🔹 <a id="projen-cdk8s-cdk8sdepsoptions"></a>
|
|
13708
|
+
|
|
13709
|
+
|
|
13710
|
+
|
|
13711
|
+
|
|
13712
|
+
|
|
13713
|
+
|
|
13714
|
+
Name | Type | Description
|
|
13715
|
+
-----|------|-------------
|
|
13716
|
+
**cdk8sCliDependency**🔹 | <code>boolean</code> | Add cdk8s-cli only to Node projects.
|
|
13717
|
+
**cdk8sVersion**🔹 | <code>string</code> | Minumum version of the cdk8s to depend on.
|
|
13718
|
+
**dependencyType**🔹 | <code>[DependencyType](#projen-dependencytype)</code> | The type of dependency to use for runtime CDK8s and `constructs` modules.
|
|
13719
|
+
**cdk8sCliVersion**?🔹 | <code>string</code> | Minumum version of the cdk8s-cli to depend on.<br/>__*Default*__: "2.0.28"
|
|
13720
|
+
**cdk8sCliVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for cdk8s-cli.<br/>__*Default*__: false
|
|
13721
|
+
**cdk8sPlus**?🔹 | <code>boolean</code> | Include cdk8s-plus.<br/>__*Default*__: true
|
|
13722
|
+
**cdk8sPlusVersion**?🔹 | <code>string</code> | Minumum version of the cdk8s-plus-XX to depend on.<br/>__*Default*__: "2.0.0-rc.26"
|
|
13723
|
+
**cdk8sPlusVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for cdk8s-plus-17.<br/>__*Default*__: false
|
|
13724
|
+
**cdk8sVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for cdk8s.<br/>__*Default*__: false
|
|
13725
|
+
**constructsVersion**?🔹 | <code>string</code> | Minimum version of the `constructs` library to depend on.<br/>__*Default*__: "10.1.42"
|
|
13726
|
+
**constructsVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for constructs.<br/>__*Default*__: false
|
|
13727
|
+
**k8sMinorVersion**?🔹 | <code>number</code> | The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0.<br/>__*Default*__: 22
|
|
13728
|
+
|
|
13729
|
+
|
|
13730
|
+
|
|
13731
|
+
## struct Cdk8sPackageNames 🔹 <a id="projen-cdk8s-cdk8spackagenames"></a>
|
|
13732
|
+
|
|
13733
|
+
__Obtainable from__: [Cdk8sDeps](#projen-cdk8s-cdk8sdeps).[packageNames](#projen-cdk8s-cdk8sdeps#projen-cdk8s-cdk8sdeps-packagenames)(), [Cdk8sDepsPy](#projen-cdk8s-cdk8sdepspy).[packageNames](#projen-cdk8s-cdk8sdepspy#projen-cdk8s-cdk8sdepspy-packagenames)()
|
|
13734
|
+
|
|
13735
|
+
|
|
13736
|
+
|
|
13737
|
+
|
|
13738
|
+
|
|
13739
|
+
Name | Type | Description
|
|
13740
|
+
-----|------|-------------
|
|
13741
|
+
**cdk8s**🔹 | <code>string</code> | Fully qualified name of the core framework package.
|
|
13742
|
+
**cdk8sPlus**🔹 | <code>string</code> | Fully qualified name of the cdk9s-plus-XX library package.
|
|
13743
|
+
**constructs**🔹 | <code>string</code> | Fully qualified name of the constructs library package.
|
|
13744
|
+
**cdk8sClient**?🔹 | <code>string</code> | Fully qualified name of the client package.<br/>__*Optional*__
|
|
13745
|
+
|
|
13746
|
+
|
|
13747
|
+
|
|
13748
|
+
## struct Cdk8sPythonOptions 🔹 <a id="projen-cdk8s-cdk8spythonoptions"></a>
|
|
13749
|
+
|
|
13750
|
+
|
|
13751
|
+
Options for `Cdk8sPythonApp`.
|
|
13752
|
+
|
|
13753
|
+
|
|
13754
|
+
|
|
13755
|
+
Name | Type | Description
|
|
13756
|
+
-----|------|-------------
|
|
13757
|
+
**authorEmail**🔹 | <code>string</code> | Author's e-mail.
|
|
13758
|
+
**authorName**🔹 | <code>string</code> | Author's name.
|
|
13759
|
+
**cdk8sVersion**🔹 | <code>string</code> | Minumum version of the cdk8s to depend on.
|
|
13760
|
+
**moduleName**🔹 | <code>string</code> | Name of the python package as used in imports and filenames.
|
|
13761
|
+
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
13762
|
+
**version**🔹 | <code>string</code> | Version of the package.
|
|
13763
|
+
**appEntrypoint**?🔹 | <code>string</code> | The CDK8s app's entrypoint.<br/>__*Default*__: "app.py"
|
|
13764
|
+
**autoApproveOptions**?🔹 | <code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code> | Enable and configure the 'auto approve' workflow.<br/>__*Default*__: auto approve is disabled
|
|
13765
|
+
**autoMerge**?🔹 | <code>boolean</code> | Enable automatic merging on GitHub.<br/>__*Default*__: true
|
|
13766
|
+
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
13767
|
+
**cdk8sCliVersion**?🔹 | <code>string</code> | Minumum version of the cdk8s-cli to depend on.<br/>__*Default*__: "2.0.28"
|
|
13768
|
+
**cdk8sCliVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for cdk8s-cli.<br/>__*Default*__: false
|
|
13769
|
+
**cdk8sImports**?🔹 | <code>Array<string></code> | Import additional specs.<br/>__*Default*__: no additional specs imported
|
|
13770
|
+
**cdk8sPlus**?🔹 | <code>boolean</code> | Include cdk8s-plus.<br/>__*Default*__: true
|
|
13771
|
+
**cdk8sPlusVersion**?🔹 | <code>string</code> | Minumum version of the cdk8s-plus-XX to depend on.<br/>__*Default*__: "2.0.0-rc.26"
|
|
13772
|
+
**cdk8sPlusVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for cdk8s-plus-17.<br/>__*Default*__: false
|
|
13773
|
+
**cdk8sVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for cdk8s.<br/>__*Default*__: false
|
|
13774
|
+
**classifiers**?🔹 | <code>Array<string></code> | A list of PyPI trove classifiers that describe the project.<br/>__*Optional*__
|
|
13775
|
+
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
13776
|
+
**constructsVersion**?🔹 | <code>string</code> | Minimum version of the `constructs` library to depend on.<br/>__*Default*__: "10.1.42"
|
|
13777
|
+
**constructsVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for constructs.<br/>__*Default*__: false
|
|
13778
|
+
**deps**?🔹 | <code>Array<string></code> | List of runtime dependencies for this project.<br/>__*Default*__: []
|
|
13779
|
+
**description**?🔹 | <code>string</code> | A short description of the package.<br/>__*Optional*__
|
|
13780
|
+
**devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
|
|
13781
|
+
**devDeps**?🔹 | <code>Array<string></code> | List of dev dependencies for this project.<br/>__*Default*__: []
|
|
13782
|
+
**github**?🔹 | <code>boolean</code> | Enable GitHub integration.<br/>__*Default*__: true
|
|
13783
|
+
**githubOptions**?🔹 | <code>[github.GitHubOptions](#projen-github-githuboptions)</code> | Options for GitHub integration.<br/>__*Default*__: see GitHubOptions
|
|
13784
|
+
**gitpod**?🔹 | <code>boolean</code> | Add a Gitpod development environment.<br/>__*Default*__: false
|
|
13785
|
+
**homepage**?🔹 | <code>string</code> | A URL to the website of the project.<br/>__*Optional*__
|
|
13786
|
+
**k8sMinorVersion**?🔹 | <code>number</code> | The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0.<br/>__*Default*__: 22
|
|
13787
|
+
**k8sSpecVersion**?🔹 | <code>string</code> | Import a specific Kubernetes spec version.<br/>__*Default*__: Use the cdk8s default
|
|
13788
|
+
**license**?🔹 | <code>string</code> | License of this package as an SPDX identifier.<br/>__*Optional*__
|
|
13789
|
+
**logging**?🔹 | <code>[LoggerOptions](#projen-loggeroptions)</code> | Configure logging options such as verbosity.<br/>__*Default*__: {}
|
|
13790
|
+
**mergify**?⚠️ | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
|
|
13791
|
+
**mergifyOptions**?⚠️ | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
|
|
13792
|
+
**outdir**?🔹 | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
|
|
13793
|
+
**packageName**?🔹 | <code>string</code> | Package name.<br/>__*Optional*__
|
|
13794
|
+
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
13795
|
+
**pip**?🔹 | <code>boolean</code> | Use pip with a requirements.txt file to track project dependencies.<br/>__*Default*__: true
|
|
13796
|
+
**poetry**?🔹 | <code>boolean</code> | Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.<br/>__*Default*__: false
|
|
13797
|
+
**poetryOptions**?🔹 | <code>[python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps)</code> | Additional options to set for poetry if using poetry.<br/>__*Optional*__
|
|
13798
|
+
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
13799
|
+
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
13800
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
13801
|
+
**projenTokenSecret**?⚠️ | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
13802
|
+
**projenrcJs**?🔹 | <code>boolean</code> | Use projenrc in javascript.<br/>__*Default*__: false
|
|
13803
|
+
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options related to projenrc in JavaScript.<br/>__*Default*__: default options
|
|
13804
|
+
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
13805
|
+
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
13806
|
+
**projenrcPython**?🔹 | <code>boolean</code> | Use projenrc in Python.<br/>__*Default*__: true
|
|
13807
|
+
**projenrcPythonOptions**?🔹 | <code>[python.ProjenrcOptions](#projen-python-projenrcoptions)</code> | Options related to projenrc in python.<br/>__*Default*__: default options
|
|
13808
|
+
**pytest**?🔹 | <code>boolean</code> | Include pytest tests.<br/>__*Default*__: true
|
|
13809
|
+
**pytestOptions**?🔹 | <code>[python.PytestOptions](#projen-python-pytestoptions)</code> | pytest options.<br/>__*Default*__: defaults
|
|
13810
|
+
**readme**?🔹 | <code>[SampleReadmeProps](#projen-samplereadmeprops)</code> | The README setup.<br/>__*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
13811
|
+
**renovatebot**?🔹 | <code>boolean</code> | Use renovatebot to handle dependency upgrades.<br/>__*Default*__: false
|
|
13812
|
+
**renovatebotOptions**?🔹 | <code>[RenovatebotOptions](#projen-renovatebotoptions)</code> | Options for renovatebot.<br/>__*Default*__: default options
|
|
13813
|
+
**sample**?🔹 | <code>boolean</code> | Include sample code and test if the relevant directories don't exist.<br/>__*Default*__: true
|
|
13814
|
+
**setupConfig**?🔹 | <code>Map<string, any></code> | Additional fields to pass in the setup() function if using setuptools.<br/>__*Optional*__
|
|
13815
|
+
**setuptools**?🔹 | <code>boolean</code> | Use setuptools with a setup.py script for packaging and publishing.<br/>__*Default*__: true if the project type is library
|
|
13816
|
+
**stale**?🔹 | <code>boolean</code> | Auto-close of stale issues and pull request.<br/>__*Default*__: false
|
|
13817
|
+
**staleOptions**?🔹 | <code>[github.StaleOptions](#projen-github-staleoptions)</code> | Auto-close stale issues and pull requests.<br/>__*Default*__: see defaults in `StaleOptions`
|
|
13818
|
+
**venv**?🔹 | <code>boolean</code> | Use venv to manage a virtual environment for installing dependencies inside.<br/>__*Default*__: true
|
|
13819
|
+
**venvOptions**?🔹 | <code>[python.VenvOptions](#projen-python-venvoptions)</code> | Venv options.<br/>__*Default*__: defaults
|
|
13820
|
+
**vscode**?🔹 | <code>boolean</code> | Enable VSCode integration.<br/>__*Default*__: true
|
|
13821
|
+
|
|
13822
|
+
|
|
13823
|
+
|
|
13462
13824
|
## struct Cdk8sTypeScriptAppOptions 🔹 <a id="projen-cdk8s-cdk8stypescriptappoptions"></a>
|
|
13463
13825
|
|
|
13464
13826
|
|
|
@@ -13468,7 +13830,7 @@ Name | Type | Description
|
|
|
13468
13830
|
|
|
13469
13831
|
Name | Type | Description
|
|
13470
13832
|
-----|------|-------------
|
|
13471
|
-
**cdk8sVersion**🔹 | <code>string</code> |
|
|
13833
|
+
**cdk8sVersion**🔹 | <code>string</code> | Minumum version of the cdk8s to depend on.
|
|
13472
13834
|
**defaultReleaseBranch**🔹 | <code>string</code> | The name of the main release branch.
|
|
13473
13835
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
13474
13836
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
@@ -13490,16 +13852,18 @@ Name | Type | Description
|
|
|
13490
13852
|
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
13491
13853
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
13492
13854
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
13493
|
-
**cdk8sCliVersion**?🔹 | <code>string</code> | cdk8s-cli
|
|
13494
|
-
**cdk8sCliVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for
|
|
13855
|
+
**cdk8sCliVersion**?🔹 | <code>string</code> | Minumum version of the cdk8s-cli to depend on.<br/>__*Default*__: "2.0.28"
|
|
13856
|
+
**cdk8sCliVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for cdk8s-cli.<br/>__*Default*__: false
|
|
13495
13857
|
**cdk8sImports**?🔹 | <code>Array<string></code> | Import additional specs.<br/>__*Default*__: no additional specs imported
|
|
13858
|
+
**cdk8sPlus**?🔹 | <code>boolean</code> | Include cdk8s-plus.<br/>__*Default*__: true
|
|
13859
|
+
**cdk8sPlusVersion**?🔹 | <code>string</code> | Minumum version of the cdk8s-plus-XX to depend on.<br/>__*Default*__: "2.0.0-rc.26"
|
|
13496
13860
|
**cdk8sPlusVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for cdk8s-plus-17.<br/>__*Default*__: false
|
|
13497
|
-
**cdk8sVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for
|
|
13861
|
+
**cdk8sVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for cdk8s.<br/>__*Default*__: false
|
|
13498
13862
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
13499
13863
|
**codeArtifactOptions**?🔹 | <code>[javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)</code> | Options for npm packages using AWS CodeArtifact.<br/>__*Default*__: undefined
|
|
13500
13864
|
**codeCov**?🔹 | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret.<br/>__*Default*__: false
|
|
13501
13865
|
**codeCovTokenSecret**?🔹 | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.<br/>__*Default*__: if this option is not specified, only public repositories are supported
|
|
13502
|
-
**constructsVersion**?🔹 | <code>string</code> | constructs
|
|
13866
|
+
**constructsVersion**?🔹 | <code>string</code> | Minimum version of the `constructs` library to depend on.<br/>__*Default*__: "10.1.42"
|
|
13503
13867
|
**constructsVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for constructs.<br/>__*Default*__: false
|
|
13504
13868
|
**copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
|
|
13505
13869
|
**copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
|
|
@@ -13527,6 +13891,7 @@ Name | Type | Description
|
|
|
13527
13891
|
**jest**?🔹 | <code>boolean</code> | Setup jest unit tests.<br/>__*Default*__: true
|
|
13528
13892
|
**jestOptions**?🔹 | <code>[javascript.JestOptions](#projen-javascript-jestoptions)</code> | Jest options.<br/>__*Default*__: default options
|
|
13529
13893
|
**jsiiReleaseVersion**?🔹 | <code>string</code> | Version requirement of `publib` which is used to publish modules to npm.<br/>__*Default*__: "latest"
|
|
13894
|
+
**k8sMinorVersion**?🔹 | <code>number</code> | The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0.<br/>__*Default*__: 22
|
|
13530
13895
|
**k8sSpecVersion**?🔹 | <code>string</code> | Import a specific Kubernetes spec version.<br/>__*Default*__: Use the cdk8s default
|
|
13531
13896
|
**keywords**?🔹 | <code>Array<string></code> | Keywords to include in `package.json`.<br/>__*Optional*__
|
|
13532
13897
|
**libdir**?🔹 | <code>string</code> | Typescript artifacts output directory.<br/>__*Default*__: "lib"
|
|
@@ -16290,6 +16655,20 @@ Name | Type | Description
|
|
|
16290
16655
|
|
|
16291
16656
|
|
|
16292
16657
|
|
|
16658
|
+
## struct PytestSampleOptions 🔹 <a id="projen-python-pytestsampleoptions"></a>
|
|
16659
|
+
|
|
16660
|
+
|
|
16661
|
+
Options for python test code sample.
|
|
16662
|
+
|
|
16663
|
+
|
|
16664
|
+
|
|
16665
|
+
Name | Type | Description
|
|
16666
|
+
-----|------|-------------
|
|
16667
|
+
**moduleName**🔹 | <code>string</code> | Name of the python package as used in imports and filenames.
|
|
16668
|
+
**testdir**🔹 | <code>string</code> | Test directory.
|
|
16669
|
+
|
|
16670
|
+
|
|
16671
|
+
|
|
16293
16672
|
## struct PythonPackagingOptions 🔹 <a id="projen-python-pythonpackagingoptions"></a>
|
|
16294
16673
|
|
|
16295
16674
|
|
|
@@ -16306,6 +16685,7 @@ Name | Type | Description
|
|
|
16306
16685
|
**description**?🔹 | <code>string</code> | A short description of the package.<br/>__*Optional*__
|
|
16307
16686
|
**homepage**?🔹 | <code>string</code> | A URL to the website of the project.<br/>__*Optional*__
|
|
16308
16687
|
**license**?🔹 | <code>string</code> | License of this package as an SPDX identifier.<br/>__*Optional*__
|
|
16688
|
+
**packageName**?🔹 | <code>string</code> | Package name.<br/>__*Optional*__
|
|
16309
16689
|
**poetryOptions**?🔹 | <code>[python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps)</code> | Additional options to set for poetry if using poetry.<br/>__*Optional*__
|
|
16310
16690
|
**setupConfig**?🔹 | <code>Map<string, any></code> | Additional fields to pass in the setup() function if using setuptools.<br/>__*Optional*__
|
|
16311
16691
|
|
|
@@ -16343,6 +16723,7 @@ Name | Type | Description
|
|
|
16343
16723
|
**mergify**?⚠️ | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
|
|
16344
16724
|
**mergifyOptions**?⚠️ | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for mergify.<br/>__*Default*__: default options
|
|
16345
16725
|
**outdir**?🔹 | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
|
|
16726
|
+
**packageName**?🔹 | <code>string</code> | Package name.<br/>__*Optional*__
|
|
16346
16727
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
16347
16728
|
**pip**?🔹 | <code>boolean</code> | Use pip with a requirements.txt file to track project dependencies.<br/>__*Default*__: true
|
|
16348
16729
|
**poetry**?🔹 | <code>boolean</code> | Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.<br/>__*Default*__: false
|
|
@@ -16379,6 +16760,13 @@ Name | Type | Description
|
|
|
16379
16760
|
Options for python sample code.
|
|
16380
16761
|
|
|
16381
16762
|
|
|
16763
|
+
|
|
16764
|
+
Name | Type | Description
|
|
16765
|
+
-----|------|-------------
|
|
16766
|
+
**dir**🔹 | <code>string</code> | Sample code directory.
|
|
16767
|
+
|
|
16768
|
+
|
|
16769
|
+
|
|
16382
16770
|
## struct RequirementsFileOptions 🔹 <a id="projen-python-requirementsfileoptions"></a>
|
|
16383
16771
|
|
|
16384
16772
|
|