projen 0.79.4__py3-none-any.whl → 0.98.25__py3-none-any.whl
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.
- projen/__init__.py +1234 -86
- projen/_jsii/__init__.py +20 -2
- projen/_jsii/projen@0.98.25.jsii.tgz +0 -0
- projen/awscdk/__init__.py +1758 -230
- projen/build/__init__.py +290 -129
- projen/cdk/__init__.py +1030 -151
- projen/cdk8s/__init__.py +833 -109
- projen/cdktf/__init__.py +389 -50
- projen/circleci/__init__.py +35 -1
- projen/github/__init__.py +2224 -312
- projen/github/workflows/__init__.py +403 -17
- projen/gitlab/__init__.py +241 -8
- projen/java/__init__.py +471 -4
- projen/javascript/__init__.py +2276 -143
- projen/javascript/biome_config/__init__.py +5461 -0
- projen/python/__init__.py +3390 -1037
- projen/python/uv_config/__init__.py +3933 -0
- projen/release/__init__.py +1080 -138
- projen/typescript/__init__.py +992 -118
- projen/vscode/__init__.py +22 -1
- projen/web/__init__.py +1456 -163
- {projen-0.79.4.data → projen-0.98.25.data}/scripts/projen +1 -1
- {projen-0.79.4.dist-info → projen-0.98.25.dist-info}/METADATA +42 -41
- projen-0.98.25.dist-info/RECORD +28 -0
- {projen-0.79.4.dist-info → projen-0.98.25.dist-info}/WHEEL +1 -1
- projen/_jsii/projen@0.79.4.jsii.tgz +0 -0
- projen-0.79.4.dist-info/RECORD +0 -26
- {projen-0.79.4.dist-info → projen-0.98.25.dist-info}/LICENSE +0 -0
- {projen-0.79.4.dist-info → projen-0.98.25.dist-info}/top_level.txt +0 -0
projen/cdktf/__init__.py
CHANGED
|
@@ -1,3 +1,6 @@
|
|
|
1
|
+
from pkgutil import extend_path
|
|
2
|
+
__path__ = extend_path(__path__, __name__)
|
|
3
|
+
|
|
1
4
|
import abc
|
|
2
5
|
import builtins
|
|
3
6
|
import datetime
|
|
@@ -8,7 +11,22 @@ import jsii
|
|
|
8
11
|
import publication
|
|
9
12
|
import typing_extensions
|
|
10
13
|
|
|
11
|
-
|
|
14
|
+
import typeguard
|
|
15
|
+
from importlib.metadata import version as _metadata_package_version
|
|
16
|
+
TYPEGUARD_MAJOR_VERSION = int(_metadata_package_version('typeguard').split('.')[0])
|
|
17
|
+
|
|
18
|
+
def check_type(argname: str, value: object, expected_type: typing.Any) -> typing.Any:
|
|
19
|
+
if TYPEGUARD_MAJOR_VERSION <= 2:
|
|
20
|
+
return typeguard.check_type(argname=argname, value=value, expected_type=expected_type) # type:ignore
|
|
21
|
+
else:
|
|
22
|
+
if isinstance(value, jsii._reference_map.InterfaceDynamicProxy): # pyright: ignore [reportAttributeAccessIssue]
|
|
23
|
+
pass
|
|
24
|
+
else:
|
|
25
|
+
if TYPEGUARD_MAJOR_VERSION == 3:
|
|
26
|
+
typeguard.config.collection_check_strategy = typeguard.CollectionCheckStrategy.ALL_ITEMS # type:ignore
|
|
27
|
+
typeguard.check_type(value=value, expected_type=expected_type) # type:ignore
|
|
28
|
+
else:
|
|
29
|
+
typeguard.check_type(value=value, expected_type=expected_type, collection_check_strategy=typeguard.CollectionCheckStrategy.ALL_ITEMS) # type:ignore
|
|
12
30
|
|
|
13
31
|
from .._jsii import *
|
|
14
32
|
|
|
@@ -47,6 +65,9 @@ from ..github.workflows import (
|
|
|
47
65
|
JobStep as _JobStep_c3287c05, Triggers as _Triggers_e9ae7617
|
|
48
66
|
)
|
|
49
67
|
from ..javascript import (
|
|
68
|
+
AuditOptions as _AuditOptions_429c62df,
|
|
69
|
+
BiomeOptions as _BiomeOptions_452ab984,
|
|
70
|
+
BuildWorkflowOptions as _BuildWorkflowOptions_b756f97f,
|
|
50
71
|
BundlerOptions as _BundlerOptions_d60b85ed,
|
|
51
72
|
CodeArtifactOptions as _CodeArtifactOptions_e4782b3e,
|
|
52
73
|
EslintOptions as _EslintOptions_824f60bb,
|
|
@@ -129,8 +150,13 @@ class ConstructLibraryCdktf(
|
|
|
129
150
|
typescript_version: typing.Optional[builtins.str] = None,
|
|
130
151
|
default_release_branch: builtins.str,
|
|
131
152
|
artifacts_directory: typing.Optional[builtins.str] = None,
|
|
153
|
+
audit_deps: typing.Optional[builtins.bool] = None,
|
|
154
|
+
audit_deps_options: typing.Optional[typing.Union[_AuditOptions_429c62df, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
132
155
|
auto_approve_upgrades: typing.Optional[builtins.bool] = None,
|
|
156
|
+
biome: typing.Optional[builtins.bool] = None,
|
|
157
|
+
biome_options: typing.Optional[typing.Union[_BiomeOptions_452ab984, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
133
158
|
build_workflow: typing.Optional[builtins.bool] = None,
|
|
159
|
+
build_workflow_options: typing.Optional[typing.Union[_BuildWorkflowOptions_b756f97f, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
134
160
|
build_workflow_triggers: typing.Optional[typing.Union[_Triggers_e9ae7617, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
135
161
|
bundler_options: typing.Optional[typing.Union[_BundlerOptions_d60b85ed, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
136
162
|
check_licenses: typing.Optional[typing.Union[_LicenseCheckerOptions_80bcd362, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
@@ -192,6 +218,7 @@ class ConstructLibraryCdktf(
|
|
|
192
218
|
bugs_email: typing.Optional[builtins.str] = None,
|
|
193
219
|
bugs_url: typing.Optional[builtins.str] = None,
|
|
194
220
|
bundled_deps: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
221
|
+
bun_version: typing.Optional[builtins.str] = None,
|
|
195
222
|
code_artifact_options: typing.Optional[typing.Union[_CodeArtifactOptions_e4782b3e, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
196
223
|
deps: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
197
224
|
description: typing.Optional[builtins.str] = None,
|
|
@@ -204,9 +231,11 @@ class ConstructLibraryCdktf(
|
|
|
204
231
|
max_node_version: typing.Optional[builtins.str] = None,
|
|
205
232
|
min_node_version: typing.Optional[builtins.str] = None,
|
|
206
233
|
npm_access: typing.Optional[_NpmAccess_134fa228] = None,
|
|
234
|
+
npm_provenance: typing.Optional[builtins.bool] = None,
|
|
207
235
|
npm_registry: typing.Optional[builtins.str] = None,
|
|
208
236
|
npm_registry_url: typing.Optional[builtins.str] = None,
|
|
209
237
|
npm_token_secret: typing.Optional[builtins.str] = None,
|
|
238
|
+
npm_trusted_publishing: typing.Optional[builtins.bool] = None,
|
|
210
239
|
package_manager: typing.Optional[_NodePackageManager_3eb53bf6] = None,
|
|
211
240
|
package_name: typing.Optional[builtins.str] = None,
|
|
212
241
|
peer_dependency_options: typing.Optional[typing.Union[_PeerDependencyOptions_99d7d493, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
@@ -218,9 +247,11 @@ class ConstructLibraryCdktf(
|
|
|
218
247
|
scripts: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
219
248
|
stability: typing.Optional[builtins.str] = None,
|
|
220
249
|
yarn_berry_options: typing.Optional[typing.Union[_YarnBerryOptions_b6942539, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
250
|
+
bump_package: typing.Optional[builtins.str] = None,
|
|
221
251
|
jsii_release_version: typing.Optional[builtins.str] = None,
|
|
222
252
|
major_version: typing.Optional[jsii.Number] = None,
|
|
223
253
|
min_major_version: typing.Optional[jsii.Number] = None,
|
|
254
|
+
next_version_command: typing.Optional[builtins.str] = None,
|
|
224
255
|
npm_dist_tag: typing.Optional[builtins.str] = None,
|
|
225
256
|
post_build_steps: typing.Optional[typing.Sequence[typing.Union[_JobStep_c3287c05, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
226
257
|
prerelease: typing.Optional[builtins.str] = None,
|
|
@@ -228,12 +259,14 @@ class ConstructLibraryCdktf(
|
|
|
228
259
|
publish_tasks: typing.Optional[builtins.bool] = None,
|
|
229
260
|
releasable_commits: typing.Optional[_ReleasableCommits_d481ce10] = None,
|
|
230
261
|
release_branches: typing.Optional[typing.Mapping[builtins.str, typing.Union[_BranchOptions_13663d08, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
262
|
+
release_environment: typing.Optional[builtins.str] = None,
|
|
231
263
|
release_every_commit: typing.Optional[builtins.bool] = None,
|
|
232
264
|
release_failure_issue: typing.Optional[builtins.bool] = None,
|
|
233
265
|
release_failure_issue_label: typing.Optional[builtins.str] = None,
|
|
234
266
|
release_schedule: typing.Optional[builtins.str] = None,
|
|
235
267
|
release_tag_prefix: typing.Optional[builtins.str] = None,
|
|
236
268
|
release_trigger: typing.Optional[_ReleaseTrigger_e4dc221f] = None,
|
|
269
|
+
release_workflow_env: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
237
270
|
release_workflow_name: typing.Optional[builtins.str] = None,
|
|
238
271
|
release_workflow_setup_steps: typing.Optional[typing.Sequence[typing.Union[_JobStep_c3287c05, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
239
272
|
versionrc_options: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
|
|
@@ -255,7 +288,7 @@ class ConstructLibraryCdktf(
|
|
|
255
288
|
) -> None:
|
|
256
289
|
'''
|
|
257
290
|
:param cdktf_version: (experimental) Minimum target version this library is tested against. Default: "^0.13.0"
|
|
258
|
-
:param constructs_version: (experimental) Construct version to use. Default: "^10.0
|
|
291
|
+
:param constructs_version: (experimental) Construct version to use. Default: "^10.3.0"
|
|
259
292
|
:param catalog: (experimental) Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:. https://awscdk.io/packages/[@SCOPE/]PACKAGE@VERSION The catalog will also post a tweet to https://twitter.com/awscdkio with the package name, description and the above link. You can disable these tweets through ``{ announce: false }``. You can also add a Twitter handle through ``{ twitter: 'xx' }`` which will be mentioned in the tweet. Default: - new version will be announced
|
|
260
293
|
:param author: (experimental) The name of the library author. Default: $GIT_USER_NAME
|
|
261
294
|
:param author_address: (experimental) Email or URL of the library author. Default: $GIT_USER_EMAIL
|
|
@@ -266,7 +299,7 @@ class ConstructLibraryCdktf(
|
|
|
266
299
|
:param docgen_file_path: (experimental) File path for generated docs. Default: "API.md"
|
|
267
300
|
:param dotnet:
|
|
268
301
|
:param exclude_typescript: (experimental) Accepts a list of glob patterns. Files matching any of those patterns will be excluded from the TypeScript compiler input. By default, jsii will include all *.ts files (except .d.ts files) in the TypeScript compiler input. This can be problematic for example when the package's build or test procedure generates .ts files that cannot be compiled with jsii's compiler settings.
|
|
269
|
-
:param jsii_version: (experimental) Version of the jsii compiler to use. Set to "*" if you want to manually manage the version of jsii in your project by managing updates to ``package.json`` on your own. NOTE: The jsii compiler releases since 5.0.0 are not semantically versioned and should remain on the same minor, so we recommend using a ``~`` dependency (e.g. ``~5.0.0``). Default: "
|
|
302
|
+
:param jsii_version: (experimental) Version of the jsii compiler to use. Set to "*" if you want to manually manage the version of jsii in your project by managing updates to ``package.json`` on your own. NOTE: The jsii compiler releases since 5.0.0 are not semantically versioned and should remain on the same minor, so we recommend using a ``~`` dependency (e.g. ``~5.0.0``). Default: "~5.8.0"
|
|
270
303
|
:param publish_to_go: (experimental) Publish Go bindings to a git repository. Default: - no publishing
|
|
271
304
|
:param publish_to_maven: (experimental) Publish to maven. Default: - no publishing
|
|
272
305
|
:param publish_to_nuget: (experimental) Publish to NuGet. Default: - no publishing
|
|
@@ -278,7 +311,7 @@ class ConstructLibraryCdktf(
|
|
|
278
311
|
:param docgen: (experimental) Docgen by Typedoc. Default: false
|
|
279
312
|
:param docs_directory: (experimental) Docs directory. Default: "docs"
|
|
280
313
|
:param entrypoint_types: (experimental) The .d.ts file that includes the type declarations for this module. Default: - .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
|
|
281
|
-
:param eslint: (experimental) Setup eslint. Default: true
|
|
314
|
+
:param eslint: (experimental) Setup eslint. Default: - true, unless biome is enabled
|
|
282
315
|
:param eslint_options: (experimental) Eslint options. Default: - opinionated default options
|
|
283
316
|
:param libdir: (experimental) Typescript artifacts output directory. Default: "lib"
|
|
284
317
|
:param projenrc_ts: (experimental) Use TypeScript for your projenrc file (``.projenrc.ts``). Default: false
|
|
@@ -293,13 +326,18 @@ class ConstructLibraryCdktf(
|
|
|
293
326
|
:param typescript_version: (experimental) TypeScript version to use. NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a ``~`` dependency (e.g. ``~1.2.3``). Default: "latest"
|
|
294
327
|
:param default_release_branch: (experimental) The name of the main release branch. Default: "main"
|
|
295
328
|
:param artifacts_directory: (experimental) A directory which will contain build artifacts. Default: "dist"
|
|
329
|
+
:param audit_deps: (experimental) Run security audit on dependencies. When enabled, creates an "audit" task that checks for known security vulnerabilities in dependencies. By default, runs during every build and checks for "high" severity vulnerabilities or above in all dependencies (including dev dependencies). Default: false
|
|
330
|
+
:param audit_deps_options: (experimental) Security audit options. Default: - default options
|
|
296
331
|
:param auto_approve_upgrades: (experimental) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). Throw if set to true but ``autoApproveOptions`` are not defined. Default: - true
|
|
332
|
+
:param biome: (experimental) Setup Biome. Default: false
|
|
333
|
+
:param biome_options: (experimental) Biome options. Default: - default options
|
|
297
334
|
:param build_workflow: (experimental) Define a GitHub workflow for building PRs. Default: - true if not a subproject
|
|
298
|
-
:param
|
|
335
|
+
:param build_workflow_options: (experimental) Options for PR build workflow.
|
|
336
|
+
:param build_workflow_triggers: (deprecated) Build workflow triggers. Default: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
299
337
|
:param bundler_options: (experimental) Options for ``Bundler``.
|
|
300
338
|
:param check_licenses: (experimental) Configure which licenses should be deemed acceptable for use by dependencies. This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered. Default: - no license checks are run during the build and all licenses will be accepted
|
|
301
|
-
:param code_cov: (experimental) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@
|
|
302
|
-
:param code_cov_token_secret: (experimental) Define the secret name for a specified https://codecov.io/ token
|
|
339
|
+
:param code_cov: (experimental) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via ``codeCovTokenSecret``. Default: false
|
|
340
|
+
:param code_cov_token_secret: (experimental) Define the secret name for a specified https://codecov.io/ token. Default: - OIDC auth is used
|
|
303
341
|
:param copyright_owner: (experimental) License copyright owner. Default: - defaults to the value of authorName or "" if ``authorName`` is undefined.
|
|
304
342
|
:param copyright_period: (experimental) The copyright years to put in the LICENSE file. Default: - current year
|
|
305
343
|
:param dependabot: (experimental) Use dependabot to handle dependency upgrades. Cannot be used in conjunction with ``depsUpgrade``. Default: false
|
|
@@ -309,14 +347,14 @@ class ConstructLibraryCdktf(
|
|
|
309
347
|
:param gitignore: (experimental) Additional entries to .gitignore.
|
|
310
348
|
:param jest: (experimental) Setup jest unit tests. Default: true
|
|
311
349
|
:param jest_options: (experimental) Jest options. Default: - default options
|
|
312
|
-
:param mutable_build: (
|
|
350
|
+
:param mutable_build: (deprecated) Automatically update files modified during builds to pull-request branches. This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged. Implies that PR builds do not have anti-tamper checks. Default: true
|
|
313
351
|
:param npmignore: (deprecated) Additional entries to .npmignore.
|
|
314
352
|
:param npmignore_enabled: (experimental) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. Default: true
|
|
315
353
|
:param npm_ignore_options: (experimental) Configuration options for .npmignore file.
|
|
316
354
|
:param package: (experimental) Defines a ``package`` task that will produce an npm tarball under the artifacts directory (e.g. ``dist``). Default: true
|
|
317
355
|
:param prettier: (experimental) Setup prettier. Default: false
|
|
318
356
|
:param prettier_options: (experimental) Prettier options. Default: - default options
|
|
319
|
-
:param projen_dev_dependency: (experimental) Indicates of "projen" should be installed as a devDependency. Default: true
|
|
357
|
+
:param projen_dev_dependency: (experimental) Indicates of "projen" should be installed as a devDependency. Default: - true if not a subproject
|
|
320
358
|
:param projenrc_js: (experimental) Generate (once) .projenrc.js (in JavaScript). Set to ``false`` in order to disable .projenrc.js generation. Default: - true if projenrcJson is false
|
|
321
359
|
:param projenrc_js_options: (experimental) Options for .projenrc.js. Default: - default options
|
|
322
360
|
:param projen_version: (experimental) Version of projen to install. Default: - Defaults to the latest version.
|
|
@@ -326,8 +364,8 @@ class ConstructLibraryCdktf(
|
|
|
326
364
|
:param release_to_npm: (experimental) Automatically release to npm when new versions are introduced. Default: false
|
|
327
365
|
:param release_workflow: (deprecated) DEPRECATED: renamed to ``release``. Default: - true if not a subproject
|
|
328
366
|
:param workflow_bootstrap_steps: (experimental) Workflow steps to use in order to bootstrap this repo. Default: "yarn install --frozen-lockfile && yarn projen"
|
|
329
|
-
:param workflow_git_identity: (experimental) The git identity to use in workflows. Default: - GitHub Actions
|
|
330
|
-
:param workflow_node_version: (experimental) The node version
|
|
367
|
+
:param workflow_git_identity: (experimental) The git identity to use in workflows. Default: - default GitHub Actions user
|
|
368
|
+
:param workflow_node_version: (experimental) The node version used in GitHub Actions workflows. Always use this option if your GitHub Actions workflows require a specific to run. Default: - ``minNodeVersion`` if set, otherwise ``lts/*``.
|
|
331
369
|
:param workflow_package_cache: (experimental) Enable Node.js package cache in GitHub workflows. Default: false
|
|
332
370
|
:param auto_approve_options: (experimental) Enable and configure the 'auto approve' workflow. Default: - auto approve is disabled
|
|
333
371
|
:param auto_merge: (experimental) Enable automatic merging on GitHub. Has no effect if ``github.mergify`` is set to false. Default: true
|
|
@@ -356,6 +394,7 @@ class ConstructLibraryCdktf(
|
|
|
356
394
|
:param bugs_email: (experimental) The email address to which issues should be reported.
|
|
357
395
|
:param bugs_url: (experimental) The url to your project's issue tracker.
|
|
358
396
|
:param bundled_deps: (experimental) List of dependencies to bundle into this module. These modules will be added both to the ``dependencies`` section and ``bundledDependencies`` section of your ``package.json``. The recommendation is to only specify the module name here (e.g. ``express``). This will behave similar to ``yarn add`` or ``npm install`` in the sense that it will add the module as a dependency to your ``package.json`` file with the latest version (``^``). You can specify semver requirements in the same syntax passed to ``npm i`` or ``yarn add`` (e.g. ``express@^2``) and this will be what you ``package.json`` will eventually include.
|
|
397
|
+
:param bun_version: (experimental) The version of Bun to use if using Bun as a package manager. Default: "latest"
|
|
359
398
|
:param code_artifact_options: (experimental) Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact Default: - undefined
|
|
360
399
|
:param deps: (experimental) Runtime dependencies of this module. The recommendation is to only specify the module name here (e.g. ``express``). This will behave similar to ``yarn add`` or ``npm install`` in the sense that it will add the module as a dependency to your ``package.json`` file with the latest version (``^``). You can specify semver requirements in the same syntax passed to ``npm i`` or ``yarn add`` (e.g. ``express@^2``) and this will be what you ``package.json`` will eventually include. Default: []
|
|
361
400
|
:param description: (experimental) The description is just a string that helps people understand the purpose of the package. It can be used when searching for packages in a package manager as well. See https://classic.yarnpkg.com/en/docs/package-json/#toc-description
|
|
@@ -365,26 +404,30 @@ class ConstructLibraryCdktf(
|
|
|
365
404
|
:param keywords: (experimental) Keywords to include in ``package.json``.
|
|
366
405
|
:param license: (experimental) License's SPDX identifier. See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses. Use the ``licensed`` option if you want to no license to be specified. Default: "Apache-2.0"
|
|
367
406
|
:param licensed: (experimental) Indicates if a license should be added. Default: true
|
|
368
|
-
:param max_node_version: (experimental)
|
|
369
|
-
:param min_node_version: (experimental)
|
|
407
|
+
:param max_node_version: (experimental) The maximum node version supported by this package. Most projects should not use this option. The value indicates that the package is incompatible with any newer versions of node. This requirement is enforced via the engines field. You will normally not need to set this option. Consider this option only if your package is known to not function with newer versions of node. Default: - no maximum version is enforced
|
|
408
|
+
:param min_node_version: (experimental) The minimum node version required by this package to function. Most projects should not use this option. The value indicates that the package is incompatible with any older versions of node. This requirement is enforced via the engines field. You will normally not need to set this option, even if your package is incompatible with EOL versions of node. Consider this option only if your package depends on a specific feature, that is not available in other LTS versions. Setting this option has very high impact on the consumers of your package, as package managers will actively prevent usage with node versions you have marked as incompatible. To change the node version of your CI/CD workflows, use ``workflowNodeVersion``. Default: - no minimum version is enforced
|
|
370
409
|
:param npm_access: (experimental) Access level of the npm package. Default: - for scoped packages (e.g. ``foo@bar``), the default is ``NpmAccess.RESTRICTED``, for non-scoped packages, the default is ``NpmAccess.PUBLIC``.
|
|
410
|
+
:param npm_provenance: (experimental) Should provenance statements be generated when the package is published. A supported package manager is required to publish a package with npm provenance statements and you will need to use a supported CI/CD provider. Note that the projen ``Release`` and ``Publisher`` components are using ``publib`` to publish packages, which is using npm internally and supports provenance statements independently of the package manager used. Default: - true for public packages, false otherwise
|
|
371
411
|
:param npm_registry: (deprecated) The host name of the npm registry to publish to. Cannot be set together with ``npmRegistryUrl``.
|
|
372
412
|
:param npm_registry_url: (experimental) The base URL of the npm package registry. Must be a URL (e.g. start with "https://" or "http://") Default: "https://registry.npmjs.org"
|
|
373
413
|
:param npm_token_secret: (experimental) GitHub secret which contains the NPM token to use when publishing packages. Default: "NPM_TOKEN"
|
|
414
|
+
:param npm_trusted_publishing: (experimental) Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. Default: - false
|
|
374
415
|
:param package_manager: (experimental) The Node Package Manager used to execute scripts. Default: NodePackageManager.YARN_CLASSIC
|
|
375
416
|
:param package_name: (experimental) The "name" in package.json. Default: - defaults to project name
|
|
376
417
|
:param peer_dependency_options: (experimental) Options for ``peerDeps``.
|
|
377
418
|
:param peer_deps: (experimental) Peer dependencies for this module. Dependencies listed here are required to be installed (and satisfied) by the *consumer* of this library. Using peer dependencies allows you to ensure that only a single module of a certain library exists in the ``node_modules`` tree of your consumers. Note that prior to npm@7, peer dependencies are *not* automatically installed, which means that adding peer dependencies to a library will be a breaking change for your customers. Unless ``peerDependencyOptions.pinnedDevDependency`` is disabled (it is enabled by default), projen will automatically add a dev dependency with a pinned version for each peer dependency. This will ensure that you build & test your module against the lowest peer version required. Default: []
|
|
378
|
-
:param pnpm_version: (experimental) The version of PNPM to use if using PNPM as a package manager. Default: "
|
|
419
|
+
:param pnpm_version: (experimental) The version of PNPM to use if using PNPM as a package manager. Default: "9"
|
|
379
420
|
:param repository: (experimental) The repository is the location where the actual code for your package lives. See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
|
|
380
421
|
:param repository_directory: (experimental) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives.
|
|
381
422
|
:param scoped_packages_options: (experimental) Options for privately hosted scoped packages. Default: - fetch all scoped packages from the public npm registry
|
|
382
423
|
:param scripts: (deprecated) npm scripts to include. If a script has the same name as a standard script, the standard script will be overwritten. Also adds the script as a task. Default: {}
|
|
383
424
|
:param stability: (experimental) Package's Stability.
|
|
384
425
|
:param yarn_berry_options: (experimental) Options for Yarn Berry. Default: - Yarn Berry v4 with all default options
|
|
426
|
+
:param bump_package: (experimental) The ``commit-and-tag-version`` compatible package used to bump the package version, as a dependency string. This can be any compatible package version, including the deprecated ``standard-version@9``. Default: - A recent version of "commit-and-tag-version"
|
|
385
427
|
:param jsii_release_version: (experimental) Version requirement of ``publib`` which is used to publish modules to npm. Default: "latest"
|
|
386
428
|
:param major_version: (experimental) Major version to release from the default branch. If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version. Default: - Major version is not enforced.
|
|
387
429
|
:param min_major_version: (experimental) Minimal Major version to release. This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number. Can not be set together with ``majorVersion``. Default: - No minimum version is being enforced
|
|
430
|
+
:param next_version_command: (experimental) A shell command to control the next version to release. If present, this shell command will be run before the bump is executed, and it determines what version to release. It will be executed in the following environment: - Working directory: the project directory. - ``$VERSION``: the current version. Looks like ``1.2.3``. - ``$LATEST_TAG``: the most recent tag. Looks like ``prefix-v1.2.3``, or may be unset. - ``$SUGGESTED_BUMP``: the suggested bump action based on commits. One of ``major|minor|patch|none``. The command should print one of the following to ``stdout``: - Nothing: the next version number will be determined based on commit history. - ``x.y.z``: the next version number will be ``x.y.z``. - ``major|minor|patch``: the next version number will be the current version number with the indicated component bumped. This setting cannot be specified together with ``minMajorVersion``; the invoked script can be used to achieve the effects of ``minMajorVersion``. Default: - The next version will be determined based on the commit history and project settings.
|
|
388
431
|
:param npm_dist_tag: (experimental) The npmDistTag to use when publishing from the default branch. To set the npm dist-tag for release branches, set the ``npmDistTag`` property for each branch. Default: "latest"
|
|
389
432
|
:param post_build_steps: (experimental) Steps to execute after build as part of the release workflow. Default: []
|
|
390
433
|
:param prerelease: (experimental) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). Default: - normal semantic versions
|
|
@@ -392,15 +435,17 @@ class ConstructLibraryCdktf(
|
|
|
392
435
|
:param publish_tasks: (experimental) Define publishing tasks that can be executed manually as well as workflows. Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity. Default: false
|
|
393
436
|
:param releasable_commits: (experimental) Find commits that should be considered releasable Used to decide if a release is required. Default: ReleasableCommits.everyCommit()
|
|
394
437
|
:param release_branches: (experimental) Defines additional release branches. A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch *must* be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the ``majorVersion`` field must also be provided for the default branch. Default: - no additional branches are used for release. you can use ``addBranch()`` to add additional branches.
|
|
438
|
+
:param release_environment: (experimental) The GitHub Actions environment used for the release. This can be used to add an explicit approval step to the release or limit who can initiate a release through environment protection rules. When multiple artifacts are released, the environment can be overwritten on a per artifact basis. Default: - no environment used, unless set at the artifact level
|
|
395
439
|
:param release_every_commit: (deprecated) Automatically release new versions every commit to one of branches in ``releaseBranches``. Default: true
|
|
396
440
|
:param release_failure_issue: (experimental) Create a github issue on every failed publishing task. Default: false
|
|
397
441
|
:param release_failure_issue_label: (experimental) The label to apply to issues indicating publish failures. Only applies if ``releaseFailureIssue`` is true. Default: "failed-release"
|
|
398
442
|
:param release_schedule: (deprecated) CRON schedule to trigger new releases. Default: - no scheduled releases
|
|
399
443
|
:param release_tag_prefix: (experimental) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. Note: this prefix is used to detect the latest tagged version when bumping, so if you change this on a project with an existing version history, you may need to manually tag your latest release with the new prefix. Default: "v"
|
|
400
444
|
:param release_trigger: (experimental) The release trigger to use. Default: - Continuous releases (``ReleaseTrigger.continuous()``)
|
|
445
|
+
:param release_workflow_env: (experimental) Build environment variables for release workflows. Default: {}
|
|
401
446
|
:param release_workflow_name: (experimental) The name of the default release workflow. Default: "release"
|
|
402
447
|
:param release_workflow_setup_steps: (experimental) A set of workflow steps to execute in order to setup the workflow container.
|
|
403
|
-
:param versionrc_options: (experimental) Custom configuration used when creating changelog with
|
|
448
|
+
:param versionrc_options: (experimental) Custom configuration used when creating changelog with commit-and-tag-version package. Given values either append to default configuration or overwrite values in it. Default: - standard configuration applicable for GitHub repositories
|
|
404
449
|
:param workflow_container_image: (experimental) Container image to use for GitHub workflows. Default: - default image
|
|
405
450
|
:param workflow_runs_on: (experimental) Github Runner selection labels. Default: ["ubuntu-latest"]
|
|
406
451
|
:param workflow_runs_on_group: (experimental) Github Runner Group selection options.
|
|
@@ -459,8 +504,13 @@ class ConstructLibraryCdktf(
|
|
|
459
504
|
typescript_version=typescript_version,
|
|
460
505
|
default_release_branch=default_release_branch,
|
|
461
506
|
artifacts_directory=artifacts_directory,
|
|
507
|
+
audit_deps=audit_deps,
|
|
508
|
+
audit_deps_options=audit_deps_options,
|
|
462
509
|
auto_approve_upgrades=auto_approve_upgrades,
|
|
510
|
+
biome=biome,
|
|
511
|
+
biome_options=biome_options,
|
|
463
512
|
build_workflow=build_workflow,
|
|
513
|
+
build_workflow_options=build_workflow_options,
|
|
464
514
|
build_workflow_triggers=build_workflow_triggers,
|
|
465
515
|
bundler_options=bundler_options,
|
|
466
516
|
check_licenses=check_licenses,
|
|
@@ -522,6 +572,7 @@ class ConstructLibraryCdktf(
|
|
|
522
572
|
bugs_email=bugs_email,
|
|
523
573
|
bugs_url=bugs_url,
|
|
524
574
|
bundled_deps=bundled_deps,
|
|
575
|
+
bun_version=bun_version,
|
|
525
576
|
code_artifact_options=code_artifact_options,
|
|
526
577
|
deps=deps,
|
|
527
578
|
description=description,
|
|
@@ -534,9 +585,11 @@ class ConstructLibraryCdktf(
|
|
|
534
585
|
max_node_version=max_node_version,
|
|
535
586
|
min_node_version=min_node_version,
|
|
536
587
|
npm_access=npm_access,
|
|
588
|
+
npm_provenance=npm_provenance,
|
|
537
589
|
npm_registry=npm_registry,
|
|
538
590
|
npm_registry_url=npm_registry_url,
|
|
539
591
|
npm_token_secret=npm_token_secret,
|
|
592
|
+
npm_trusted_publishing=npm_trusted_publishing,
|
|
540
593
|
package_manager=package_manager,
|
|
541
594
|
package_name=package_name,
|
|
542
595
|
peer_dependency_options=peer_dependency_options,
|
|
@@ -548,9 +601,11 @@ class ConstructLibraryCdktf(
|
|
|
548
601
|
scripts=scripts,
|
|
549
602
|
stability=stability,
|
|
550
603
|
yarn_berry_options=yarn_berry_options,
|
|
604
|
+
bump_package=bump_package,
|
|
551
605
|
jsii_release_version=jsii_release_version,
|
|
552
606
|
major_version=major_version,
|
|
553
607
|
min_major_version=min_major_version,
|
|
608
|
+
next_version_command=next_version_command,
|
|
554
609
|
npm_dist_tag=npm_dist_tag,
|
|
555
610
|
post_build_steps=post_build_steps,
|
|
556
611
|
prerelease=prerelease,
|
|
@@ -558,12 +613,14 @@ class ConstructLibraryCdktf(
|
|
|
558
613
|
publish_tasks=publish_tasks,
|
|
559
614
|
releasable_commits=releasable_commits,
|
|
560
615
|
release_branches=release_branches,
|
|
616
|
+
release_environment=release_environment,
|
|
561
617
|
release_every_commit=release_every_commit,
|
|
562
618
|
release_failure_issue=release_failure_issue,
|
|
563
619
|
release_failure_issue_label=release_failure_issue_label,
|
|
564
620
|
release_schedule=release_schedule,
|
|
565
621
|
release_tag_prefix=release_tag_prefix,
|
|
566
622
|
release_trigger=release_trigger,
|
|
623
|
+
release_workflow_env=release_workflow_env,
|
|
567
624
|
release_workflow_name=release_workflow_name,
|
|
568
625
|
release_workflow_setup_steps=release_workflow_setup_steps,
|
|
569
626
|
versionrc_options=versionrc_options,
|
|
@@ -630,6 +687,7 @@ class ConstructLibraryCdktf(
|
|
|
630
687
|
"bugs_email": "bugsEmail",
|
|
631
688
|
"bugs_url": "bugsUrl",
|
|
632
689
|
"bundled_deps": "bundledDeps",
|
|
690
|
+
"bun_version": "bunVersion",
|
|
633
691
|
"code_artifact_options": "codeArtifactOptions",
|
|
634
692
|
"deps": "deps",
|
|
635
693
|
"description": "description",
|
|
@@ -642,9 +700,11 @@ class ConstructLibraryCdktf(
|
|
|
642
700
|
"max_node_version": "maxNodeVersion",
|
|
643
701
|
"min_node_version": "minNodeVersion",
|
|
644
702
|
"npm_access": "npmAccess",
|
|
703
|
+
"npm_provenance": "npmProvenance",
|
|
645
704
|
"npm_registry": "npmRegistry",
|
|
646
705
|
"npm_registry_url": "npmRegistryUrl",
|
|
647
706
|
"npm_token_secret": "npmTokenSecret",
|
|
707
|
+
"npm_trusted_publishing": "npmTrustedPublishing",
|
|
648
708
|
"package_manager": "packageManager",
|
|
649
709
|
"package_name": "packageName",
|
|
650
710
|
"peer_dependency_options": "peerDependencyOptions",
|
|
@@ -656,9 +716,11 @@ class ConstructLibraryCdktf(
|
|
|
656
716
|
"scripts": "scripts",
|
|
657
717
|
"stability": "stability",
|
|
658
718
|
"yarn_berry_options": "yarnBerryOptions",
|
|
719
|
+
"bump_package": "bumpPackage",
|
|
659
720
|
"jsii_release_version": "jsiiReleaseVersion",
|
|
660
721
|
"major_version": "majorVersion",
|
|
661
722
|
"min_major_version": "minMajorVersion",
|
|
723
|
+
"next_version_command": "nextVersionCommand",
|
|
662
724
|
"npm_dist_tag": "npmDistTag",
|
|
663
725
|
"post_build_steps": "postBuildSteps",
|
|
664
726
|
"prerelease": "prerelease",
|
|
@@ -666,12 +728,14 @@ class ConstructLibraryCdktf(
|
|
|
666
728
|
"publish_tasks": "publishTasks",
|
|
667
729
|
"releasable_commits": "releasableCommits",
|
|
668
730
|
"release_branches": "releaseBranches",
|
|
731
|
+
"release_environment": "releaseEnvironment",
|
|
669
732
|
"release_every_commit": "releaseEveryCommit",
|
|
670
733
|
"release_failure_issue": "releaseFailureIssue",
|
|
671
734
|
"release_failure_issue_label": "releaseFailureIssueLabel",
|
|
672
735
|
"release_schedule": "releaseSchedule",
|
|
673
736
|
"release_tag_prefix": "releaseTagPrefix",
|
|
674
737
|
"release_trigger": "releaseTrigger",
|
|
738
|
+
"release_workflow_env": "releaseWorkflowEnv",
|
|
675
739
|
"release_workflow_name": "releaseWorkflowName",
|
|
676
740
|
"release_workflow_setup_steps": "releaseWorkflowSetupSteps",
|
|
677
741
|
"versionrc_options": "versionrcOptions",
|
|
@@ -680,8 +744,13 @@ class ConstructLibraryCdktf(
|
|
|
680
744
|
"workflow_runs_on_group": "workflowRunsOnGroup",
|
|
681
745
|
"default_release_branch": "defaultReleaseBranch",
|
|
682
746
|
"artifacts_directory": "artifactsDirectory",
|
|
747
|
+
"audit_deps": "auditDeps",
|
|
748
|
+
"audit_deps_options": "auditDepsOptions",
|
|
683
749
|
"auto_approve_upgrades": "autoApproveUpgrades",
|
|
750
|
+
"biome": "biome",
|
|
751
|
+
"biome_options": "biomeOptions",
|
|
684
752
|
"build_workflow": "buildWorkflow",
|
|
753
|
+
"build_workflow_options": "buildWorkflowOptions",
|
|
685
754
|
"build_workflow_triggers": "buildWorkflowTriggers",
|
|
686
755
|
"bundler_options": "bundlerOptions",
|
|
687
756
|
"check_licenses": "checkLicenses",
|
|
@@ -798,6 +867,7 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
798
867
|
bugs_email: typing.Optional[builtins.str] = None,
|
|
799
868
|
bugs_url: typing.Optional[builtins.str] = None,
|
|
800
869
|
bundled_deps: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
870
|
+
bun_version: typing.Optional[builtins.str] = None,
|
|
801
871
|
code_artifact_options: typing.Optional[typing.Union[_CodeArtifactOptions_e4782b3e, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
802
872
|
deps: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
803
873
|
description: typing.Optional[builtins.str] = None,
|
|
@@ -810,9 +880,11 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
810
880
|
max_node_version: typing.Optional[builtins.str] = None,
|
|
811
881
|
min_node_version: typing.Optional[builtins.str] = None,
|
|
812
882
|
npm_access: typing.Optional[_NpmAccess_134fa228] = None,
|
|
883
|
+
npm_provenance: typing.Optional[builtins.bool] = None,
|
|
813
884
|
npm_registry: typing.Optional[builtins.str] = None,
|
|
814
885
|
npm_registry_url: typing.Optional[builtins.str] = None,
|
|
815
886
|
npm_token_secret: typing.Optional[builtins.str] = None,
|
|
887
|
+
npm_trusted_publishing: typing.Optional[builtins.bool] = None,
|
|
816
888
|
package_manager: typing.Optional[_NodePackageManager_3eb53bf6] = None,
|
|
817
889
|
package_name: typing.Optional[builtins.str] = None,
|
|
818
890
|
peer_dependency_options: typing.Optional[typing.Union[_PeerDependencyOptions_99d7d493, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
@@ -824,9 +896,11 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
824
896
|
scripts: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
825
897
|
stability: typing.Optional[builtins.str] = None,
|
|
826
898
|
yarn_berry_options: typing.Optional[typing.Union[_YarnBerryOptions_b6942539, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
899
|
+
bump_package: typing.Optional[builtins.str] = None,
|
|
827
900
|
jsii_release_version: typing.Optional[builtins.str] = None,
|
|
828
901
|
major_version: typing.Optional[jsii.Number] = None,
|
|
829
902
|
min_major_version: typing.Optional[jsii.Number] = None,
|
|
903
|
+
next_version_command: typing.Optional[builtins.str] = None,
|
|
830
904
|
npm_dist_tag: typing.Optional[builtins.str] = None,
|
|
831
905
|
post_build_steps: typing.Optional[typing.Sequence[typing.Union[_JobStep_c3287c05, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
832
906
|
prerelease: typing.Optional[builtins.str] = None,
|
|
@@ -834,12 +908,14 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
834
908
|
publish_tasks: typing.Optional[builtins.bool] = None,
|
|
835
909
|
releasable_commits: typing.Optional[_ReleasableCommits_d481ce10] = None,
|
|
836
910
|
release_branches: typing.Optional[typing.Mapping[builtins.str, typing.Union[_BranchOptions_13663d08, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
911
|
+
release_environment: typing.Optional[builtins.str] = None,
|
|
837
912
|
release_every_commit: typing.Optional[builtins.bool] = None,
|
|
838
913
|
release_failure_issue: typing.Optional[builtins.bool] = None,
|
|
839
914
|
release_failure_issue_label: typing.Optional[builtins.str] = None,
|
|
840
915
|
release_schedule: typing.Optional[builtins.str] = None,
|
|
841
916
|
release_tag_prefix: typing.Optional[builtins.str] = None,
|
|
842
917
|
release_trigger: typing.Optional[_ReleaseTrigger_e4dc221f] = None,
|
|
918
|
+
release_workflow_env: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
843
919
|
release_workflow_name: typing.Optional[builtins.str] = None,
|
|
844
920
|
release_workflow_setup_steps: typing.Optional[typing.Sequence[typing.Union[_JobStep_c3287c05, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
845
921
|
versionrc_options: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
|
|
@@ -848,8 +924,13 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
848
924
|
workflow_runs_on_group: typing.Optional[typing.Union[_GroupRunnerOptions_148c59c1, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
849
925
|
default_release_branch: builtins.str,
|
|
850
926
|
artifacts_directory: typing.Optional[builtins.str] = None,
|
|
927
|
+
audit_deps: typing.Optional[builtins.bool] = None,
|
|
928
|
+
audit_deps_options: typing.Optional[typing.Union[_AuditOptions_429c62df, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
851
929
|
auto_approve_upgrades: typing.Optional[builtins.bool] = None,
|
|
930
|
+
biome: typing.Optional[builtins.bool] = None,
|
|
931
|
+
biome_options: typing.Optional[typing.Union[_BiomeOptions_452ab984, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
852
932
|
build_workflow: typing.Optional[builtins.bool] = None,
|
|
933
|
+
build_workflow_options: typing.Optional[typing.Union[_BuildWorkflowOptions_b756f97f, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
853
934
|
build_workflow_triggers: typing.Optional[typing.Union[_Triggers_e9ae7617, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
854
935
|
bundler_options: typing.Optional[typing.Union[_BundlerOptions_d60b85ed, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
855
936
|
check_licenses: typing.Optional[typing.Union[_LicenseCheckerOptions_80bcd362, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
@@ -962,6 +1043,7 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
962
1043
|
:param bugs_email: (experimental) The email address to which issues should be reported.
|
|
963
1044
|
:param bugs_url: (experimental) The url to your project's issue tracker.
|
|
964
1045
|
:param bundled_deps: (experimental) List of dependencies to bundle into this module. These modules will be added both to the ``dependencies`` section and ``bundledDependencies`` section of your ``package.json``. The recommendation is to only specify the module name here (e.g. ``express``). This will behave similar to ``yarn add`` or ``npm install`` in the sense that it will add the module as a dependency to your ``package.json`` file with the latest version (``^``). You can specify semver requirements in the same syntax passed to ``npm i`` or ``yarn add`` (e.g. ``express@^2``) and this will be what you ``package.json`` will eventually include.
|
|
1046
|
+
:param bun_version: (experimental) The version of Bun to use if using Bun as a package manager. Default: "latest"
|
|
965
1047
|
:param code_artifact_options: (experimental) Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact Default: - undefined
|
|
966
1048
|
:param deps: (experimental) Runtime dependencies of this module. The recommendation is to only specify the module name here (e.g. ``express``). This will behave similar to ``yarn add`` or ``npm install`` in the sense that it will add the module as a dependency to your ``package.json`` file with the latest version (``^``). You can specify semver requirements in the same syntax passed to ``npm i`` or ``yarn add`` (e.g. ``express@^2``) and this will be what you ``package.json`` will eventually include. Default: []
|
|
967
1049
|
:param description: (experimental) The description is just a string that helps people understand the purpose of the package. It can be used when searching for packages in a package manager as well. See https://classic.yarnpkg.com/en/docs/package-json/#toc-description
|
|
@@ -971,26 +1053,30 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
971
1053
|
:param keywords: (experimental) Keywords to include in ``package.json``.
|
|
972
1054
|
:param license: (experimental) License's SPDX identifier. See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses. Use the ``licensed`` option if you want to no license to be specified. Default: "Apache-2.0"
|
|
973
1055
|
:param licensed: (experimental) Indicates if a license should be added. Default: true
|
|
974
|
-
:param max_node_version: (experimental)
|
|
975
|
-
:param min_node_version: (experimental)
|
|
1056
|
+
:param max_node_version: (experimental) The maximum node version supported by this package. Most projects should not use this option. The value indicates that the package is incompatible with any newer versions of node. This requirement is enforced via the engines field. You will normally not need to set this option. Consider this option only if your package is known to not function with newer versions of node. Default: - no maximum version is enforced
|
|
1057
|
+
:param min_node_version: (experimental) The minimum node version required by this package to function. Most projects should not use this option. The value indicates that the package is incompatible with any older versions of node. This requirement is enforced via the engines field. You will normally not need to set this option, even if your package is incompatible with EOL versions of node. Consider this option only if your package depends on a specific feature, that is not available in other LTS versions. Setting this option has very high impact on the consumers of your package, as package managers will actively prevent usage with node versions you have marked as incompatible. To change the node version of your CI/CD workflows, use ``workflowNodeVersion``. Default: - no minimum version is enforced
|
|
976
1058
|
:param npm_access: (experimental) Access level of the npm package. Default: - for scoped packages (e.g. ``foo@bar``), the default is ``NpmAccess.RESTRICTED``, for non-scoped packages, the default is ``NpmAccess.PUBLIC``.
|
|
1059
|
+
:param npm_provenance: (experimental) Should provenance statements be generated when the package is published. A supported package manager is required to publish a package with npm provenance statements and you will need to use a supported CI/CD provider. Note that the projen ``Release`` and ``Publisher`` components are using ``publib`` to publish packages, which is using npm internally and supports provenance statements independently of the package manager used. Default: - true for public packages, false otherwise
|
|
977
1060
|
:param npm_registry: (deprecated) The host name of the npm registry to publish to. Cannot be set together with ``npmRegistryUrl``.
|
|
978
1061
|
:param npm_registry_url: (experimental) The base URL of the npm package registry. Must be a URL (e.g. start with "https://" or "http://") Default: "https://registry.npmjs.org"
|
|
979
1062
|
:param npm_token_secret: (experimental) GitHub secret which contains the NPM token to use when publishing packages. Default: "NPM_TOKEN"
|
|
1063
|
+
:param npm_trusted_publishing: (experimental) Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. Default: - false
|
|
980
1064
|
:param package_manager: (experimental) The Node Package Manager used to execute scripts. Default: NodePackageManager.YARN_CLASSIC
|
|
981
1065
|
:param package_name: (experimental) The "name" in package.json. Default: - defaults to project name
|
|
982
1066
|
:param peer_dependency_options: (experimental) Options for ``peerDeps``.
|
|
983
1067
|
:param peer_deps: (experimental) Peer dependencies for this module. Dependencies listed here are required to be installed (and satisfied) by the *consumer* of this library. Using peer dependencies allows you to ensure that only a single module of a certain library exists in the ``node_modules`` tree of your consumers. Note that prior to npm@7, peer dependencies are *not* automatically installed, which means that adding peer dependencies to a library will be a breaking change for your customers. Unless ``peerDependencyOptions.pinnedDevDependency`` is disabled (it is enabled by default), projen will automatically add a dev dependency with a pinned version for each peer dependency. This will ensure that you build & test your module against the lowest peer version required. Default: []
|
|
984
|
-
:param pnpm_version: (experimental) The version of PNPM to use if using PNPM as a package manager. Default: "
|
|
1068
|
+
:param pnpm_version: (experimental) The version of PNPM to use if using PNPM as a package manager. Default: "9"
|
|
985
1069
|
:param repository: (experimental) The repository is the location where the actual code for your package lives. See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
|
|
986
1070
|
:param repository_directory: (experimental) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives.
|
|
987
1071
|
:param scoped_packages_options: (experimental) Options for privately hosted scoped packages. Default: - fetch all scoped packages from the public npm registry
|
|
988
1072
|
:param scripts: (deprecated) npm scripts to include. If a script has the same name as a standard script, the standard script will be overwritten. Also adds the script as a task. Default: {}
|
|
989
1073
|
:param stability: (experimental) Package's Stability.
|
|
990
1074
|
:param yarn_berry_options: (experimental) Options for Yarn Berry. Default: - Yarn Berry v4 with all default options
|
|
1075
|
+
:param bump_package: (experimental) The ``commit-and-tag-version`` compatible package used to bump the package version, as a dependency string. This can be any compatible package version, including the deprecated ``standard-version@9``. Default: - A recent version of "commit-and-tag-version"
|
|
991
1076
|
:param jsii_release_version: (experimental) Version requirement of ``publib`` which is used to publish modules to npm. Default: "latest"
|
|
992
1077
|
:param major_version: (experimental) Major version to release from the default branch. If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version. Default: - Major version is not enforced.
|
|
993
1078
|
:param min_major_version: (experimental) Minimal Major version to release. This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number. Can not be set together with ``majorVersion``. Default: - No minimum version is being enforced
|
|
1079
|
+
:param next_version_command: (experimental) A shell command to control the next version to release. If present, this shell command will be run before the bump is executed, and it determines what version to release. It will be executed in the following environment: - Working directory: the project directory. - ``$VERSION``: the current version. Looks like ``1.2.3``. - ``$LATEST_TAG``: the most recent tag. Looks like ``prefix-v1.2.3``, or may be unset. - ``$SUGGESTED_BUMP``: the suggested bump action based on commits. One of ``major|minor|patch|none``. The command should print one of the following to ``stdout``: - Nothing: the next version number will be determined based on commit history. - ``x.y.z``: the next version number will be ``x.y.z``. - ``major|minor|patch``: the next version number will be the current version number with the indicated component bumped. This setting cannot be specified together with ``minMajorVersion``; the invoked script can be used to achieve the effects of ``minMajorVersion``. Default: - The next version will be determined based on the commit history and project settings.
|
|
994
1080
|
:param npm_dist_tag: (experimental) The npmDistTag to use when publishing from the default branch. To set the npm dist-tag for release branches, set the ``npmDistTag`` property for each branch. Default: "latest"
|
|
995
1081
|
:param post_build_steps: (experimental) Steps to execute after build as part of the release workflow. Default: []
|
|
996
1082
|
:param prerelease: (experimental) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). Default: - normal semantic versions
|
|
@@ -998,27 +1084,34 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
998
1084
|
:param publish_tasks: (experimental) Define publishing tasks that can be executed manually as well as workflows. Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity. Default: false
|
|
999
1085
|
:param releasable_commits: (experimental) Find commits that should be considered releasable Used to decide if a release is required. Default: ReleasableCommits.everyCommit()
|
|
1000
1086
|
:param release_branches: (experimental) Defines additional release branches. A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch *must* be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the ``majorVersion`` field must also be provided for the default branch. Default: - no additional branches are used for release. you can use ``addBranch()`` to add additional branches.
|
|
1087
|
+
:param release_environment: (experimental) The GitHub Actions environment used for the release. This can be used to add an explicit approval step to the release or limit who can initiate a release through environment protection rules. When multiple artifacts are released, the environment can be overwritten on a per artifact basis. Default: - no environment used, unless set at the artifact level
|
|
1001
1088
|
:param release_every_commit: (deprecated) Automatically release new versions every commit to one of branches in ``releaseBranches``. Default: true
|
|
1002
1089
|
:param release_failure_issue: (experimental) Create a github issue on every failed publishing task. Default: false
|
|
1003
1090
|
:param release_failure_issue_label: (experimental) The label to apply to issues indicating publish failures. Only applies if ``releaseFailureIssue`` is true. Default: "failed-release"
|
|
1004
1091
|
:param release_schedule: (deprecated) CRON schedule to trigger new releases. Default: - no scheduled releases
|
|
1005
1092
|
:param release_tag_prefix: (experimental) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. Note: this prefix is used to detect the latest tagged version when bumping, so if you change this on a project with an existing version history, you may need to manually tag your latest release with the new prefix. Default: "v"
|
|
1006
1093
|
:param release_trigger: (experimental) The release trigger to use. Default: - Continuous releases (``ReleaseTrigger.continuous()``)
|
|
1094
|
+
:param release_workflow_env: (experimental) Build environment variables for release workflows. Default: {}
|
|
1007
1095
|
:param release_workflow_name: (experimental) The name of the default release workflow. Default: "release"
|
|
1008
1096
|
:param release_workflow_setup_steps: (experimental) A set of workflow steps to execute in order to setup the workflow container.
|
|
1009
|
-
:param versionrc_options: (experimental) Custom configuration used when creating changelog with
|
|
1097
|
+
:param versionrc_options: (experimental) Custom configuration used when creating changelog with commit-and-tag-version package. Given values either append to default configuration or overwrite values in it. Default: - standard configuration applicable for GitHub repositories
|
|
1010
1098
|
:param workflow_container_image: (experimental) Container image to use for GitHub workflows. Default: - default image
|
|
1011
1099
|
:param workflow_runs_on: (experimental) Github Runner selection labels. Default: ["ubuntu-latest"]
|
|
1012
1100
|
:param workflow_runs_on_group: (experimental) Github Runner Group selection options.
|
|
1013
1101
|
:param default_release_branch: (experimental) The name of the main release branch. Default: "main"
|
|
1014
1102
|
:param artifacts_directory: (experimental) A directory which will contain build artifacts. Default: "dist"
|
|
1103
|
+
:param audit_deps: (experimental) Run security audit on dependencies. When enabled, creates an "audit" task that checks for known security vulnerabilities in dependencies. By default, runs during every build and checks for "high" severity vulnerabilities or above in all dependencies (including dev dependencies). Default: false
|
|
1104
|
+
:param audit_deps_options: (experimental) Security audit options. Default: - default options
|
|
1015
1105
|
:param auto_approve_upgrades: (experimental) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). Throw if set to true but ``autoApproveOptions`` are not defined. Default: - true
|
|
1106
|
+
:param biome: (experimental) Setup Biome. Default: false
|
|
1107
|
+
:param biome_options: (experimental) Biome options. Default: - default options
|
|
1016
1108
|
:param build_workflow: (experimental) Define a GitHub workflow for building PRs. Default: - true if not a subproject
|
|
1017
|
-
:param
|
|
1109
|
+
:param build_workflow_options: (experimental) Options for PR build workflow.
|
|
1110
|
+
:param build_workflow_triggers: (deprecated) Build workflow triggers. Default: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
1018
1111
|
:param bundler_options: (experimental) Options for ``Bundler``.
|
|
1019
1112
|
:param check_licenses: (experimental) Configure which licenses should be deemed acceptable for use by dependencies. This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered. Default: - no license checks are run during the build and all licenses will be accepted
|
|
1020
|
-
:param code_cov: (experimental) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@
|
|
1021
|
-
:param code_cov_token_secret: (experimental) Define the secret name for a specified https://codecov.io/ token
|
|
1113
|
+
:param code_cov: (experimental) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via ``codeCovTokenSecret``. Default: false
|
|
1114
|
+
:param code_cov_token_secret: (experimental) Define the secret name for a specified https://codecov.io/ token. Default: - OIDC auth is used
|
|
1022
1115
|
:param copyright_owner: (experimental) License copyright owner. Default: - defaults to the value of authorName or "" if ``authorName`` is undefined.
|
|
1023
1116
|
:param copyright_period: (experimental) The copyright years to put in the LICENSE file. Default: - current year
|
|
1024
1117
|
:param dependabot: (experimental) Use dependabot to handle dependency upgrades. Cannot be used in conjunction with ``depsUpgrade``. Default: false
|
|
@@ -1028,14 +1121,14 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
1028
1121
|
:param gitignore: (experimental) Additional entries to .gitignore.
|
|
1029
1122
|
:param jest: (experimental) Setup jest unit tests. Default: true
|
|
1030
1123
|
:param jest_options: (experimental) Jest options. Default: - default options
|
|
1031
|
-
:param mutable_build: (
|
|
1124
|
+
:param mutable_build: (deprecated) Automatically update files modified during builds to pull-request branches. This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged. Implies that PR builds do not have anti-tamper checks. Default: true
|
|
1032
1125
|
:param npmignore: (deprecated) Additional entries to .npmignore.
|
|
1033
1126
|
:param npmignore_enabled: (experimental) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. Default: true
|
|
1034
1127
|
:param npm_ignore_options: (experimental) Configuration options for .npmignore file.
|
|
1035
1128
|
:param package: (experimental) Defines a ``package`` task that will produce an npm tarball under the artifacts directory (e.g. ``dist``). Default: true
|
|
1036
1129
|
:param prettier: (experimental) Setup prettier. Default: false
|
|
1037
1130
|
:param prettier_options: (experimental) Prettier options. Default: - default options
|
|
1038
|
-
:param projen_dev_dependency: (experimental) Indicates of "projen" should be installed as a devDependency. Default: true
|
|
1131
|
+
:param projen_dev_dependency: (experimental) Indicates of "projen" should be installed as a devDependency. Default: - true if not a subproject
|
|
1039
1132
|
:param projenrc_js: (experimental) Generate (once) .projenrc.js (in JavaScript). Set to ``false`` in order to disable .projenrc.js generation. Default: - true if projenrcJson is false
|
|
1040
1133
|
:param projenrc_js_options: (experimental) Options for .projenrc.js. Default: - default options
|
|
1041
1134
|
:param projen_version: (experimental) Version of projen to install. Default: - Defaults to the latest version.
|
|
@@ -1045,15 +1138,15 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
1045
1138
|
:param release_to_npm: (experimental) Automatically release to npm when new versions are introduced. Default: false
|
|
1046
1139
|
:param release_workflow: (deprecated) DEPRECATED: renamed to ``release``. Default: - true if not a subproject
|
|
1047
1140
|
:param workflow_bootstrap_steps: (experimental) Workflow steps to use in order to bootstrap this repo. Default: "yarn install --frozen-lockfile && yarn projen"
|
|
1048
|
-
:param workflow_git_identity: (experimental) The git identity to use in workflows. Default: - GitHub Actions
|
|
1049
|
-
:param workflow_node_version: (experimental) The node version
|
|
1141
|
+
:param workflow_git_identity: (experimental) The git identity to use in workflows. Default: - default GitHub Actions user
|
|
1142
|
+
:param workflow_node_version: (experimental) The node version used in GitHub Actions workflows. Always use this option if your GitHub Actions workflows require a specific to run. Default: - ``minNodeVersion`` if set, otherwise ``lts/*``.
|
|
1050
1143
|
:param workflow_package_cache: (experimental) Enable Node.js package cache in GitHub workflows. Default: false
|
|
1051
1144
|
:param disable_tsconfig: (experimental) Do not generate a ``tsconfig.json`` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). Default: false
|
|
1052
1145
|
:param disable_tsconfig_dev: (experimental) Do not generate a ``tsconfig.dev.json`` file. Default: false
|
|
1053
1146
|
:param docgen: (experimental) Docgen by Typedoc. Default: false
|
|
1054
1147
|
:param docs_directory: (experimental) Docs directory. Default: "docs"
|
|
1055
1148
|
:param entrypoint_types: (experimental) The .d.ts file that includes the type declarations for this module. Default: - .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
|
|
1056
|
-
:param eslint: (experimental) Setup eslint. Default: true
|
|
1149
|
+
:param eslint: (experimental) Setup eslint. Default: - true, unless biome is enabled
|
|
1057
1150
|
:param eslint_options: (experimental) Eslint options. Default: - opinionated default options
|
|
1058
1151
|
:param libdir: (experimental) Typescript artifacts output directory. Default: "lib"
|
|
1059
1152
|
:param projenrc_ts: (experimental) Use TypeScript for your projenrc file (``.projenrc.ts``). Default: false
|
|
@@ -1075,7 +1168,7 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
1075
1168
|
:param docgen_file_path: (experimental) File path for generated docs. Default: "API.md"
|
|
1076
1169
|
:param dotnet:
|
|
1077
1170
|
:param exclude_typescript: (experimental) Accepts a list of glob patterns. Files matching any of those patterns will be excluded from the TypeScript compiler input. By default, jsii will include all *.ts files (except .d.ts files) in the TypeScript compiler input. This can be problematic for example when the package's build or test procedure generates .ts files that cannot be compiled with jsii's compiler settings.
|
|
1078
|
-
:param jsii_version: (experimental) Version of the jsii compiler to use. Set to "*" if you want to manually manage the version of jsii in your project by managing updates to ``package.json`` on your own. NOTE: The jsii compiler releases since 5.0.0 are not semantically versioned and should remain on the same minor, so we recommend using a ``~`` dependency (e.g. ``~5.0.0``). Default: "
|
|
1171
|
+
:param jsii_version: (experimental) Version of the jsii compiler to use. Set to "*" if you want to manually manage the version of jsii in your project by managing updates to ``package.json`` on your own. NOTE: The jsii compiler releases since 5.0.0 are not semantically versioned and should remain on the same minor, so we recommend using a ``~`` dependency (e.g. ``~5.0.0``). Default: "~5.8.0"
|
|
1079
1172
|
:param publish_to_go: (experimental) Publish Go bindings to a git repository. Default: - no publishing
|
|
1080
1173
|
:param publish_to_maven: (experimental) Publish to maven. Default: - no publishing
|
|
1081
1174
|
:param publish_to_nuget: (experimental) Publish to NuGet. Default: - no publishing
|
|
@@ -1084,7 +1177,7 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
1084
1177
|
:param rootdir: Default: "."
|
|
1085
1178
|
:param catalog: (experimental) Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:. https://awscdk.io/packages/[@SCOPE/]PACKAGE@VERSION The catalog will also post a tweet to https://twitter.com/awscdkio with the package name, description and the above link. You can disable these tweets through ``{ announce: false }``. You can also add a Twitter handle through ``{ twitter: 'xx' }`` which will be mentioned in the tweet. Default: - new version will be announced
|
|
1086
1179
|
:param cdktf_version: (experimental) Minimum target version this library is tested against. Default: "^0.13.0"
|
|
1087
|
-
:param constructs_version: (experimental) Construct version to use. Default: "^10.0
|
|
1180
|
+
:param constructs_version: (experimental) Construct version to use. Default: "^10.3.0"
|
|
1088
1181
|
|
|
1089
1182
|
:stability: experimental
|
|
1090
1183
|
'''
|
|
@@ -1118,6 +1211,12 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
1118
1211
|
yarn_berry_options = _YarnBerryOptions_b6942539(**yarn_berry_options)
|
|
1119
1212
|
if isinstance(workflow_runs_on_group, dict):
|
|
1120
1213
|
workflow_runs_on_group = _GroupRunnerOptions_148c59c1(**workflow_runs_on_group)
|
|
1214
|
+
if isinstance(audit_deps_options, dict):
|
|
1215
|
+
audit_deps_options = _AuditOptions_429c62df(**audit_deps_options)
|
|
1216
|
+
if isinstance(biome_options, dict):
|
|
1217
|
+
biome_options = _BiomeOptions_452ab984(**biome_options)
|
|
1218
|
+
if isinstance(build_workflow_options, dict):
|
|
1219
|
+
build_workflow_options = _BuildWorkflowOptions_b756f97f(**build_workflow_options)
|
|
1121
1220
|
if isinstance(build_workflow_triggers, dict):
|
|
1122
1221
|
build_workflow_triggers = _Triggers_e9ae7617(**build_workflow_triggers)
|
|
1123
1222
|
if isinstance(bundler_options, dict):
|
|
@@ -1203,6 +1302,7 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
1203
1302
|
check_type(argname="argument bugs_email", value=bugs_email, expected_type=type_hints["bugs_email"])
|
|
1204
1303
|
check_type(argname="argument bugs_url", value=bugs_url, expected_type=type_hints["bugs_url"])
|
|
1205
1304
|
check_type(argname="argument bundled_deps", value=bundled_deps, expected_type=type_hints["bundled_deps"])
|
|
1305
|
+
check_type(argname="argument bun_version", value=bun_version, expected_type=type_hints["bun_version"])
|
|
1206
1306
|
check_type(argname="argument code_artifact_options", value=code_artifact_options, expected_type=type_hints["code_artifact_options"])
|
|
1207
1307
|
check_type(argname="argument deps", value=deps, expected_type=type_hints["deps"])
|
|
1208
1308
|
check_type(argname="argument description", value=description, expected_type=type_hints["description"])
|
|
@@ -1215,9 +1315,11 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
1215
1315
|
check_type(argname="argument max_node_version", value=max_node_version, expected_type=type_hints["max_node_version"])
|
|
1216
1316
|
check_type(argname="argument min_node_version", value=min_node_version, expected_type=type_hints["min_node_version"])
|
|
1217
1317
|
check_type(argname="argument npm_access", value=npm_access, expected_type=type_hints["npm_access"])
|
|
1318
|
+
check_type(argname="argument npm_provenance", value=npm_provenance, expected_type=type_hints["npm_provenance"])
|
|
1218
1319
|
check_type(argname="argument npm_registry", value=npm_registry, expected_type=type_hints["npm_registry"])
|
|
1219
1320
|
check_type(argname="argument npm_registry_url", value=npm_registry_url, expected_type=type_hints["npm_registry_url"])
|
|
1220
1321
|
check_type(argname="argument npm_token_secret", value=npm_token_secret, expected_type=type_hints["npm_token_secret"])
|
|
1322
|
+
check_type(argname="argument npm_trusted_publishing", value=npm_trusted_publishing, expected_type=type_hints["npm_trusted_publishing"])
|
|
1221
1323
|
check_type(argname="argument package_manager", value=package_manager, expected_type=type_hints["package_manager"])
|
|
1222
1324
|
check_type(argname="argument package_name", value=package_name, expected_type=type_hints["package_name"])
|
|
1223
1325
|
check_type(argname="argument peer_dependency_options", value=peer_dependency_options, expected_type=type_hints["peer_dependency_options"])
|
|
@@ -1229,9 +1331,11 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
1229
1331
|
check_type(argname="argument scripts", value=scripts, expected_type=type_hints["scripts"])
|
|
1230
1332
|
check_type(argname="argument stability", value=stability, expected_type=type_hints["stability"])
|
|
1231
1333
|
check_type(argname="argument yarn_berry_options", value=yarn_berry_options, expected_type=type_hints["yarn_berry_options"])
|
|
1334
|
+
check_type(argname="argument bump_package", value=bump_package, expected_type=type_hints["bump_package"])
|
|
1232
1335
|
check_type(argname="argument jsii_release_version", value=jsii_release_version, expected_type=type_hints["jsii_release_version"])
|
|
1233
1336
|
check_type(argname="argument major_version", value=major_version, expected_type=type_hints["major_version"])
|
|
1234
1337
|
check_type(argname="argument min_major_version", value=min_major_version, expected_type=type_hints["min_major_version"])
|
|
1338
|
+
check_type(argname="argument next_version_command", value=next_version_command, expected_type=type_hints["next_version_command"])
|
|
1235
1339
|
check_type(argname="argument npm_dist_tag", value=npm_dist_tag, expected_type=type_hints["npm_dist_tag"])
|
|
1236
1340
|
check_type(argname="argument post_build_steps", value=post_build_steps, expected_type=type_hints["post_build_steps"])
|
|
1237
1341
|
check_type(argname="argument prerelease", value=prerelease, expected_type=type_hints["prerelease"])
|
|
@@ -1239,12 +1343,14 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
1239
1343
|
check_type(argname="argument publish_tasks", value=publish_tasks, expected_type=type_hints["publish_tasks"])
|
|
1240
1344
|
check_type(argname="argument releasable_commits", value=releasable_commits, expected_type=type_hints["releasable_commits"])
|
|
1241
1345
|
check_type(argname="argument release_branches", value=release_branches, expected_type=type_hints["release_branches"])
|
|
1346
|
+
check_type(argname="argument release_environment", value=release_environment, expected_type=type_hints["release_environment"])
|
|
1242
1347
|
check_type(argname="argument release_every_commit", value=release_every_commit, expected_type=type_hints["release_every_commit"])
|
|
1243
1348
|
check_type(argname="argument release_failure_issue", value=release_failure_issue, expected_type=type_hints["release_failure_issue"])
|
|
1244
1349
|
check_type(argname="argument release_failure_issue_label", value=release_failure_issue_label, expected_type=type_hints["release_failure_issue_label"])
|
|
1245
1350
|
check_type(argname="argument release_schedule", value=release_schedule, expected_type=type_hints["release_schedule"])
|
|
1246
1351
|
check_type(argname="argument release_tag_prefix", value=release_tag_prefix, expected_type=type_hints["release_tag_prefix"])
|
|
1247
1352
|
check_type(argname="argument release_trigger", value=release_trigger, expected_type=type_hints["release_trigger"])
|
|
1353
|
+
check_type(argname="argument release_workflow_env", value=release_workflow_env, expected_type=type_hints["release_workflow_env"])
|
|
1248
1354
|
check_type(argname="argument release_workflow_name", value=release_workflow_name, expected_type=type_hints["release_workflow_name"])
|
|
1249
1355
|
check_type(argname="argument release_workflow_setup_steps", value=release_workflow_setup_steps, expected_type=type_hints["release_workflow_setup_steps"])
|
|
1250
1356
|
check_type(argname="argument versionrc_options", value=versionrc_options, expected_type=type_hints["versionrc_options"])
|
|
@@ -1253,8 +1359,13 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
1253
1359
|
check_type(argname="argument workflow_runs_on_group", value=workflow_runs_on_group, expected_type=type_hints["workflow_runs_on_group"])
|
|
1254
1360
|
check_type(argname="argument default_release_branch", value=default_release_branch, expected_type=type_hints["default_release_branch"])
|
|
1255
1361
|
check_type(argname="argument artifacts_directory", value=artifacts_directory, expected_type=type_hints["artifacts_directory"])
|
|
1362
|
+
check_type(argname="argument audit_deps", value=audit_deps, expected_type=type_hints["audit_deps"])
|
|
1363
|
+
check_type(argname="argument audit_deps_options", value=audit_deps_options, expected_type=type_hints["audit_deps_options"])
|
|
1256
1364
|
check_type(argname="argument auto_approve_upgrades", value=auto_approve_upgrades, expected_type=type_hints["auto_approve_upgrades"])
|
|
1365
|
+
check_type(argname="argument biome", value=biome, expected_type=type_hints["biome"])
|
|
1366
|
+
check_type(argname="argument biome_options", value=biome_options, expected_type=type_hints["biome_options"])
|
|
1257
1367
|
check_type(argname="argument build_workflow", value=build_workflow, expected_type=type_hints["build_workflow"])
|
|
1368
|
+
check_type(argname="argument build_workflow_options", value=build_workflow_options, expected_type=type_hints["build_workflow_options"])
|
|
1258
1369
|
check_type(argname="argument build_workflow_triggers", value=build_workflow_triggers, expected_type=type_hints["build_workflow_triggers"])
|
|
1259
1370
|
check_type(argname="argument bundler_options", value=bundler_options, expected_type=type_hints["bundler_options"])
|
|
1260
1371
|
check_type(argname="argument check_licenses", value=check_licenses, expected_type=type_hints["check_licenses"])
|
|
@@ -1410,6 +1521,8 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
1410
1521
|
self._values["bugs_url"] = bugs_url
|
|
1411
1522
|
if bundled_deps is not None:
|
|
1412
1523
|
self._values["bundled_deps"] = bundled_deps
|
|
1524
|
+
if bun_version is not None:
|
|
1525
|
+
self._values["bun_version"] = bun_version
|
|
1413
1526
|
if code_artifact_options is not None:
|
|
1414
1527
|
self._values["code_artifact_options"] = code_artifact_options
|
|
1415
1528
|
if deps is not None:
|
|
@@ -1434,12 +1547,16 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
1434
1547
|
self._values["min_node_version"] = min_node_version
|
|
1435
1548
|
if npm_access is not None:
|
|
1436
1549
|
self._values["npm_access"] = npm_access
|
|
1550
|
+
if npm_provenance is not None:
|
|
1551
|
+
self._values["npm_provenance"] = npm_provenance
|
|
1437
1552
|
if npm_registry is not None:
|
|
1438
1553
|
self._values["npm_registry"] = npm_registry
|
|
1439
1554
|
if npm_registry_url is not None:
|
|
1440
1555
|
self._values["npm_registry_url"] = npm_registry_url
|
|
1441
1556
|
if npm_token_secret is not None:
|
|
1442
1557
|
self._values["npm_token_secret"] = npm_token_secret
|
|
1558
|
+
if npm_trusted_publishing is not None:
|
|
1559
|
+
self._values["npm_trusted_publishing"] = npm_trusted_publishing
|
|
1443
1560
|
if package_manager is not None:
|
|
1444
1561
|
self._values["package_manager"] = package_manager
|
|
1445
1562
|
if package_name is not None:
|
|
@@ -1462,12 +1579,16 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
1462
1579
|
self._values["stability"] = stability
|
|
1463
1580
|
if yarn_berry_options is not None:
|
|
1464
1581
|
self._values["yarn_berry_options"] = yarn_berry_options
|
|
1582
|
+
if bump_package is not None:
|
|
1583
|
+
self._values["bump_package"] = bump_package
|
|
1465
1584
|
if jsii_release_version is not None:
|
|
1466
1585
|
self._values["jsii_release_version"] = jsii_release_version
|
|
1467
1586
|
if major_version is not None:
|
|
1468
1587
|
self._values["major_version"] = major_version
|
|
1469
1588
|
if min_major_version is not None:
|
|
1470
1589
|
self._values["min_major_version"] = min_major_version
|
|
1590
|
+
if next_version_command is not None:
|
|
1591
|
+
self._values["next_version_command"] = next_version_command
|
|
1471
1592
|
if npm_dist_tag is not None:
|
|
1472
1593
|
self._values["npm_dist_tag"] = npm_dist_tag
|
|
1473
1594
|
if post_build_steps is not None:
|
|
@@ -1482,6 +1603,8 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
1482
1603
|
self._values["releasable_commits"] = releasable_commits
|
|
1483
1604
|
if release_branches is not None:
|
|
1484
1605
|
self._values["release_branches"] = release_branches
|
|
1606
|
+
if release_environment is not None:
|
|
1607
|
+
self._values["release_environment"] = release_environment
|
|
1485
1608
|
if release_every_commit is not None:
|
|
1486
1609
|
self._values["release_every_commit"] = release_every_commit
|
|
1487
1610
|
if release_failure_issue is not None:
|
|
@@ -1494,6 +1617,8 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
1494
1617
|
self._values["release_tag_prefix"] = release_tag_prefix
|
|
1495
1618
|
if release_trigger is not None:
|
|
1496
1619
|
self._values["release_trigger"] = release_trigger
|
|
1620
|
+
if release_workflow_env is not None:
|
|
1621
|
+
self._values["release_workflow_env"] = release_workflow_env
|
|
1497
1622
|
if release_workflow_name is not None:
|
|
1498
1623
|
self._values["release_workflow_name"] = release_workflow_name
|
|
1499
1624
|
if release_workflow_setup_steps is not None:
|
|
@@ -1508,10 +1633,20 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
1508
1633
|
self._values["workflow_runs_on_group"] = workflow_runs_on_group
|
|
1509
1634
|
if artifacts_directory is not None:
|
|
1510
1635
|
self._values["artifacts_directory"] = artifacts_directory
|
|
1636
|
+
if audit_deps is not None:
|
|
1637
|
+
self._values["audit_deps"] = audit_deps
|
|
1638
|
+
if audit_deps_options is not None:
|
|
1639
|
+
self._values["audit_deps_options"] = audit_deps_options
|
|
1511
1640
|
if auto_approve_upgrades is not None:
|
|
1512
1641
|
self._values["auto_approve_upgrades"] = auto_approve_upgrades
|
|
1642
|
+
if biome is not None:
|
|
1643
|
+
self._values["biome"] = biome
|
|
1644
|
+
if biome_options is not None:
|
|
1645
|
+
self._values["biome_options"] = biome_options
|
|
1513
1646
|
if build_workflow is not None:
|
|
1514
1647
|
self._values["build_workflow"] = build_workflow
|
|
1648
|
+
if build_workflow_options is not None:
|
|
1649
|
+
self._values["build_workflow_options"] = build_workflow_options
|
|
1515
1650
|
if build_workflow_triggers is not None:
|
|
1516
1651
|
self._values["build_workflow_triggers"] = build_workflow_triggers
|
|
1517
1652
|
if bundler_options is not None:
|
|
@@ -2111,6 +2246,17 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
2111
2246
|
result = self._values.get("bundled_deps")
|
|
2112
2247
|
return typing.cast(typing.Optional[typing.List[builtins.str]], result)
|
|
2113
2248
|
|
|
2249
|
+
@builtins.property
|
|
2250
|
+
def bun_version(self) -> typing.Optional[builtins.str]:
|
|
2251
|
+
'''(experimental) The version of Bun to use if using Bun as a package manager.
|
|
2252
|
+
|
|
2253
|
+
:default: "latest"
|
|
2254
|
+
|
|
2255
|
+
:stability: experimental
|
|
2256
|
+
'''
|
|
2257
|
+
result = self._values.get("bun_version")
|
|
2258
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
2259
|
+
|
|
2114
2260
|
@builtins.property
|
|
2115
2261
|
def code_artifact_options(self) -> typing.Optional[_CodeArtifactOptions_e4782b3e]:
|
|
2116
2262
|
'''(experimental) Options for npm packages using AWS CodeArtifact.
|
|
@@ -2245,9 +2391,15 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
2245
2391
|
|
|
2246
2392
|
@builtins.property
|
|
2247
2393
|
def max_node_version(self) -> typing.Optional[builtins.str]:
|
|
2248
|
-
'''(experimental)
|
|
2394
|
+
'''(experimental) The maximum node version supported by this package. Most projects should not use this option.
|
|
2395
|
+
|
|
2396
|
+
The value indicates that the package is incompatible with any newer versions of node.
|
|
2397
|
+
This requirement is enforced via the engines field.
|
|
2249
2398
|
|
|
2250
|
-
|
|
2399
|
+
You will normally not need to set this option.
|
|
2400
|
+
Consider this option only if your package is known to not function with newer versions of node.
|
|
2401
|
+
|
|
2402
|
+
:default: - no maximum version is enforced
|
|
2251
2403
|
|
|
2252
2404
|
:stability: experimental
|
|
2253
2405
|
'''
|
|
@@ -2256,9 +2408,19 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
2256
2408
|
|
|
2257
2409
|
@builtins.property
|
|
2258
2410
|
def min_node_version(self) -> typing.Optional[builtins.str]:
|
|
2259
|
-
'''(experimental)
|
|
2411
|
+
'''(experimental) The minimum node version required by this package to function. Most projects should not use this option.
|
|
2412
|
+
|
|
2413
|
+
The value indicates that the package is incompatible with any older versions of node.
|
|
2414
|
+
This requirement is enforced via the engines field.
|
|
2260
2415
|
|
|
2261
|
-
|
|
2416
|
+
You will normally not need to set this option, even if your package is incompatible with EOL versions of node.
|
|
2417
|
+
Consider this option only if your package depends on a specific feature, that is not available in other LTS versions.
|
|
2418
|
+
Setting this option has very high impact on the consumers of your package,
|
|
2419
|
+
as package managers will actively prevent usage with node versions you have marked as incompatible.
|
|
2420
|
+
|
|
2421
|
+
To change the node version of your CI/CD workflows, use ``workflowNodeVersion``.
|
|
2422
|
+
|
|
2423
|
+
:default: - no minimum version is enforced
|
|
2262
2424
|
|
|
2263
2425
|
:stability: experimental
|
|
2264
2426
|
'''
|
|
@@ -2280,6 +2442,24 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
2280
2442
|
result = self._values.get("npm_access")
|
|
2281
2443
|
return typing.cast(typing.Optional[_NpmAccess_134fa228], result)
|
|
2282
2444
|
|
|
2445
|
+
@builtins.property
|
|
2446
|
+
def npm_provenance(self) -> typing.Optional[builtins.bool]:
|
|
2447
|
+
'''(experimental) Should provenance statements be generated when the package is published.
|
|
2448
|
+
|
|
2449
|
+
A supported package manager is required to publish a package with npm provenance statements and
|
|
2450
|
+
you will need to use a supported CI/CD provider.
|
|
2451
|
+
|
|
2452
|
+
Note that the projen ``Release`` and ``Publisher`` components are using ``publib`` to publish packages,
|
|
2453
|
+
which is using npm internally and supports provenance statements independently of the package manager used.
|
|
2454
|
+
|
|
2455
|
+
:default: - true for public packages, false otherwise
|
|
2456
|
+
|
|
2457
|
+
:see: https://docs.npmjs.com/generating-provenance-statements
|
|
2458
|
+
:stability: experimental
|
|
2459
|
+
'''
|
|
2460
|
+
result = self._values.get("npm_provenance")
|
|
2461
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
|
2462
|
+
|
|
2283
2463
|
@builtins.property
|
|
2284
2464
|
def npm_registry(self) -> typing.Optional[builtins.str]:
|
|
2285
2465
|
'''(deprecated) The host name of the npm registry to publish to.
|
|
@@ -2317,6 +2497,17 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
2317
2497
|
result = self._values.get("npm_token_secret")
|
|
2318
2498
|
return typing.cast(typing.Optional[builtins.str], result)
|
|
2319
2499
|
|
|
2500
|
+
@builtins.property
|
|
2501
|
+
def npm_trusted_publishing(self) -> typing.Optional[builtins.bool]:
|
|
2502
|
+
'''(experimental) Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
|
|
2503
|
+
|
|
2504
|
+
:default: - false
|
|
2505
|
+
|
|
2506
|
+
:stability: experimental
|
|
2507
|
+
'''
|
|
2508
|
+
result = self._values.get("npm_trusted_publishing")
|
|
2509
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
|
2510
|
+
|
|
2320
2511
|
@builtins.property
|
|
2321
2512
|
def package_manager(self) -> typing.Optional[_NodePackageManager_3eb53bf6]:
|
|
2322
2513
|
'''(experimental) The Node Package Manager used to execute scripts.
|
|
@@ -2380,7 +2571,7 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
2380
2571
|
def pnpm_version(self) -> typing.Optional[builtins.str]:
|
|
2381
2572
|
'''(experimental) The version of PNPM to use if using PNPM as a package manager.
|
|
2382
2573
|
|
|
2383
|
-
:default: "
|
|
2574
|
+
:default: "9"
|
|
2384
2575
|
|
|
2385
2576
|
:stability: experimental
|
|
2386
2577
|
'''
|
|
@@ -2457,6 +2648,19 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
2457
2648
|
result = self._values.get("yarn_berry_options")
|
|
2458
2649
|
return typing.cast(typing.Optional[_YarnBerryOptions_b6942539], result)
|
|
2459
2650
|
|
|
2651
|
+
@builtins.property
|
|
2652
|
+
def bump_package(self) -> typing.Optional[builtins.str]:
|
|
2653
|
+
'''(experimental) The ``commit-and-tag-version`` compatible package used to bump the package version, as a dependency string.
|
|
2654
|
+
|
|
2655
|
+
This can be any compatible package version, including the deprecated ``standard-version@9``.
|
|
2656
|
+
|
|
2657
|
+
:default: - A recent version of "commit-and-tag-version"
|
|
2658
|
+
|
|
2659
|
+
:stability: experimental
|
|
2660
|
+
'''
|
|
2661
|
+
result = self._values.get("bump_package")
|
|
2662
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
2663
|
+
|
|
2460
2664
|
@builtins.property
|
|
2461
2665
|
def jsii_release_version(self) -> typing.Optional[builtins.str]:
|
|
2462
2666
|
'''(experimental) Version requirement of ``publib`` which is used to publish modules to npm.
|
|
@@ -2498,6 +2702,36 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
2498
2702
|
result = self._values.get("min_major_version")
|
|
2499
2703
|
return typing.cast(typing.Optional[jsii.Number], result)
|
|
2500
2704
|
|
|
2705
|
+
@builtins.property
|
|
2706
|
+
def next_version_command(self) -> typing.Optional[builtins.str]:
|
|
2707
|
+
'''(experimental) A shell command to control the next version to release.
|
|
2708
|
+
|
|
2709
|
+
If present, this shell command will be run before the bump is executed, and
|
|
2710
|
+
it determines what version to release. It will be executed in the following
|
|
2711
|
+
environment:
|
|
2712
|
+
|
|
2713
|
+
- Working directory: the project directory.
|
|
2714
|
+
- ``$VERSION``: the current version. Looks like ``1.2.3``.
|
|
2715
|
+
- ``$LATEST_TAG``: the most recent tag. Looks like ``prefix-v1.2.3``, or may be unset.
|
|
2716
|
+
- ``$SUGGESTED_BUMP``: the suggested bump action based on commits. One of ``major|minor|patch|none``.
|
|
2717
|
+
|
|
2718
|
+
The command should print one of the following to ``stdout``:
|
|
2719
|
+
|
|
2720
|
+
- Nothing: the next version number will be determined based on commit history.
|
|
2721
|
+
- ``x.y.z``: the next version number will be ``x.y.z``.
|
|
2722
|
+
- ``major|minor|patch``: the next version number will be the current version number
|
|
2723
|
+
with the indicated component bumped.
|
|
2724
|
+
|
|
2725
|
+
This setting cannot be specified together with ``minMajorVersion``; the invoked
|
|
2726
|
+
script can be used to achieve the effects of ``minMajorVersion``.
|
|
2727
|
+
|
|
2728
|
+
:default: - The next version will be determined based on the commit history and project settings.
|
|
2729
|
+
|
|
2730
|
+
:stability: experimental
|
|
2731
|
+
'''
|
|
2732
|
+
result = self._values.get("next_version_command")
|
|
2733
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
2734
|
+
|
|
2501
2735
|
@builtins.property
|
|
2502
2736
|
def npm_dist_tag(self) -> typing.Optional[builtins.str]:
|
|
2503
2737
|
'''(experimental) The npmDistTag to use when publishing from the default branch.
|
|
@@ -2593,6 +2827,23 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
2593
2827
|
result = self._values.get("release_branches")
|
|
2594
2828
|
return typing.cast(typing.Optional[typing.Mapping[builtins.str, _BranchOptions_13663d08]], result)
|
|
2595
2829
|
|
|
2830
|
+
@builtins.property
|
|
2831
|
+
def release_environment(self) -> typing.Optional[builtins.str]:
|
|
2832
|
+
'''(experimental) The GitHub Actions environment used for the release.
|
|
2833
|
+
|
|
2834
|
+
This can be used to add an explicit approval step to the release
|
|
2835
|
+
or limit who can initiate a release through environment protection rules.
|
|
2836
|
+
|
|
2837
|
+
When multiple artifacts are released, the environment can be overwritten
|
|
2838
|
+
on a per artifact basis.
|
|
2839
|
+
|
|
2840
|
+
:default: - no environment used, unless set at the artifact level
|
|
2841
|
+
|
|
2842
|
+
:stability: experimental
|
|
2843
|
+
'''
|
|
2844
|
+
result = self._values.get("release_environment")
|
|
2845
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
2846
|
+
|
|
2596
2847
|
@builtins.property
|
|
2597
2848
|
def release_every_commit(self) -> typing.Optional[builtins.bool]:
|
|
2598
2849
|
'''(deprecated) Automatically release new versions every commit to one of branches in ``releaseBranches``.
|
|
@@ -2670,6 +2921,19 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
2670
2921
|
result = self._values.get("release_trigger")
|
|
2671
2922
|
return typing.cast(typing.Optional[_ReleaseTrigger_e4dc221f], result)
|
|
2672
2923
|
|
|
2924
|
+
@builtins.property
|
|
2925
|
+
def release_workflow_env(
|
|
2926
|
+
self,
|
|
2927
|
+
) -> typing.Optional[typing.Mapping[builtins.str, builtins.str]]:
|
|
2928
|
+
'''(experimental) Build environment variables for release workflows.
|
|
2929
|
+
|
|
2930
|
+
:default: {}
|
|
2931
|
+
|
|
2932
|
+
:stability: experimental
|
|
2933
|
+
'''
|
|
2934
|
+
result = self._values.get("release_workflow_env")
|
|
2935
|
+
return typing.cast(typing.Optional[typing.Mapping[builtins.str, builtins.str]], result)
|
|
2936
|
+
|
|
2673
2937
|
@builtins.property
|
|
2674
2938
|
def release_workflow_name(self) -> typing.Optional[builtins.str]:
|
|
2675
2939
|
'''(experimental) The name of the default release workflow.
|
|
@@ -2696,7 +2960,7 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
2696
2960
|
def versionrc_options(
|
|
2697
2961
|
self,
|
|
2698
2962
|
) -> typing.Optional[typing.Mapping[builtins.str, typing.Any]]:
|
|
2699
|
-
'''(experimental) Custom configuration used when creating changelog with
|
|
2963
|
+
'''(experimental) Custom configuration used when creating changelog with commit-and-tag-version package.
|
|
2700
2964
|
|
|
2701
2965
|
Given values either append to default configuration or overwrite values in it.
|
|
2702
2966
|
|
|
@@ -2765,6 +3029,32 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
2765
3029
|
result = self._values.get("artifacts_directory")
|
|
2766
3030
|
return typing.cast(typing.Optional[builtins.str], result)
|
|
2767
3031
|
|
|
3032
|
+
@builtins.property
|
|
3033
|
+
def audit_deps(self) -> typing.Optional[builtins.bool]:
|
|
3034
|
+
'''(experimental) Run security audit on dependencies.
|
|
3035
|
+
|
|
3036
|
+
When enabled, creates an "audit" task that checks for known security vulnerabilities
|
|
3037
|
+
in dependencies. By default, runs during every build and checks for "high" severity
|
|
3038
|
+
vulnerabilities or above in all dependencies (including dev dependencies).
|
|
3039
|
+
|
|
3040
|
+
:default: false
|
|
3041
|
+
|
|
3042
|
+
:stability: experimental
|
|
3043
|
+
'''
|
|
3044
|
+
result = self._values.get("audit_deps")
|
|
3045
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
|
3046
|
+
|
|
3047
|
+
@builtins.property
|
|
3048
|
+
def audit_deps_options(self) -> typing.Optional[_AuditOptions_429c62df]:
|
|
3049
|
+
'''(experimental) Security audit options.
|
|
3050
|
+
|
|
3051
|
+
:default: - default options
|
|
3052
|
+
|
|
3053
|
+
:stability: experimental
|
|
3054
|
+
'''
|
|
3055
|
+
result = self._values.get("audit_deps_options")
|
|
3056
|
+
return typing.cast(typing.Optional[_AuditOptions_429c62df], result)
|
|
3057
|
+
|
|
2768
3058
|
@builtins.property
|
|
2769
3059
|
def auto_approve_upgrades(self) -> typing.Optional[builtins.bool]:
|
|
2770
3060
|
'''(experimental) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
|
|
@@ -2778,6 +3068,28 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
2778
3068
|
result = self._values.get("auto_approve_upgrades")
|
|
2779
3069
|
return typing.cast(typing.Optional[builtins.bool], result)
|
|
2780
3070
|
|
|
3071
|
+
@builtins.property
|
|
3072
|
+
def biome(self) -> typing.Optional[builtins.bool]:
|
|
3073
|
+
'''(experimental) Setup Biome.
|
|
3074
|
+
|
|
3075
|
+
:default: false
|
|
3076
|
+
|
|
3077
|
+
:stability: experimental
|
|
3078
|
+
'''
|
|
3079
|
+
result = self._values.get("biome")
|
|
3080
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
|
3081
|
+
|
|
3082
|
+
@builtins.property
|
|
3083
|
+
def biome_options(self) -> typing.Optional[_BiomeOptions_452ab984]:
|
|
3084
|
+
'''(experimental) Biome options.
|
|
3085
|
+
|
|
3086
|
+
:default: - default options
|
|
3087
|
+
|
|
3088
|
+
:stability: experimental
|
|
3089
|
+
'''
|
|
3090
|
+
result = self._values.get("biome_options")
|
|
3091
|
+
return typing.cast(typing.Optional[_BiomeOptions_452ab984], result)
|
|
3092
|
+
|
|
2781
3093
|
@builtins.property
|
|
2782
3094
|
def build_workflow(self) -> typing.Optional[builtins.bool]:
|
|
2783
3095
|
'''(experimental) Define a GitHub workflow for building PRs.
|
|
@@ -2789,13 +3101,24 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
2789
3101
|
result = self._values.get("build_workflow")
|
|
2790
3102
|
return typing.cast(typing.Optional[builtins.bool], result)
|
|
2791
3103
|
|
|
3104
|
+
@builtins.property
|
|
3105
|
+
def build_workflow_options(self) -> typing.Optional[_BuildWorkflowOptions_b756f97f]:
|
|
3106
|
+
'''(experimental) Options for PR build workflow.
|
|
3107
|
+
|
|
3108
|
+
:stability: experimental
|
|
3109
|
+
'''
|
|
3110
|
+
result = self._values.get("build_workflow_options")
|
|
3111
|
+
return typing.cast(typing.Optional[_BuildWorkflowOptions_b756f97f], result)
|
|
3112
|
+
|
|
2792
3113
|
@builtins.property
|
|
2793
3114
|
def build_workflow_triggers(self) -> typing.Optional[_Triggers_e9ae7617]:
|
|
2794
|
-
'''(
|
|
3115
|
+
'''(deprecated) Build workflow triggers.
|
|
2795
3116
|
|
|
2796
3117
|
:default: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
2797
3118
|
|
|
2798
|
-
:
|
|
3119
|
+
:deprecated: - Use ``buildWorkflowOptions.workflowTriggers``
|
|
3120
|
+
|
|
3121
|
+
:stability: deprecated
|
|
2799
3122
|
'''
|
|
2800
3123
|
result = self._values.get("build_workflow_triggers")
|
|
2801
3124
|
return typing.cast(typing.Optional[_Triggers_e9ae7617], result)
|
|
@@ -2824,7 +3147,7 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
2824
3147
|
|
|
2825
3148
|
@builtins.property
|
|
2826
3149
|
def code_cov(self) -> typing.Optional[builtins.bool]:
|
|
2827
|
-
'''(experimental) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@
|
|
3150
|
+
'''(experimental) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via ``codeCovTokenSecret``.
|
|
2828
3151
|
|
|
2829
3152
|
:default: false
|
|
2830
3153
|
|
|
@@ -2835,9 +3158,9 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
2835
3158
|
|
|
2836
3159
|
@builtins.property
|
|
2837
3160
|
def code_cov_token_secret(self) -> typing.Optional[builtins.str]:
|
|
2838
|
-
'''(experimental) Define the secret name for a specified https://codecov.io/ token
|
|
3161
|
+
'''(experimental) Define the secret name for a specified https://codecov.io/ token.
|
|
2839
3162
|
|
|
2840
|
-
:default: -
|
|
3163
|
+
:default: - OIDC auth is used
|
|
2841
3164
|
|
|
2842
3165
|
:stability: experimental
|
|
2843
3166
|
'''
|
|
@@ -2949,7 +3272,7 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
2949
3272
|
|
|
2950
3273
|
@builtins.property
|
|
2951
3274
|
def mutable_build(self) -> typing.Optional[builtins.bool]:
|
|
2952
|
-
'''(
|
|
3275
|
+
'''(deprecated) Automatically update files modified during builds to pull-request branches.
|
|
2953
3276
|
|
|
2954
3277
|
This means
|
|
2955
3278
|
that any files synthesized by projen or e.g. test snapshots will always be up-to-date
|
|
@@ -2959,7 +3282,9 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
2959
3282
|
|
|
2960
3283
|
:default: true
|
|
2961
3284
|
|
|
2962
|
-
:
|
|
3285
|
+
:deprecated: - Use ``buildWorkflowOptions.mutableBuild``
|
|
3286
|
+
|
|
3287
|
+
:stability: deprecated
|
|
2963
3288
|
'''
|
|
2964
3289
|
result = self._values.get("mutable_build")
|
|
2965
3290
|
return typing.cast(typing.Optional[builtins.bool], result)
|
|
@@ -3032,7 +3357,7 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
3032
3357
|
def projen_dev_dependency(self) -> typing.Optional[builtins.bool]:
|
|
3033
3358
|
'''(experimental) Indicates of "projen" should be installed as a devDependency.
|
|
3034
3359
|
|
|
3035
|
-
:default: true
|
|
3360
|
+
:default: - true if not a subproject
|
|
3036
3361
|
|
|
3037
3362
|
:stability: experimental
|
|
3038
3363
|
'''
|
|
@@ -3148,7 +3473,7 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
3148
3473
|
def workflow_git_identity(self) -> typing.Optional[_GitIdentity_6effc3de]:
|
|
3149
3474
|
'''(experimental) The git identity to use in workflows.
|
|
3150
3475
|
|
|
3151
|
-
:default: - GitHub Actions
|
|
3476
|
+
:default: - default GitHub Actions user
|
|
3152
3477
|
|
|
3153
3478
|
:stability: experimental
|
|
3154
3479
|
'''
|
|
@@ -3157,9 +3482,11 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
3157
3482
|
|
|
3158
3483
|
@builtins.property
|
|
3159
3484
|
def workflow_node_version(self) -> typing.Optional[builtins.str]:
|
|
3160
|
-
'''(experimental) The node version
|
|
3485
|
+
'''(experimental) The node version used in GitHub Actions workflows.
|
|
3486
|
+
|
|
3487
|
+
Always use this option if your GitHub Actions workflows require a specific to run.
|
|
3161
3488
|
|
|
3162
|
-
:default: -
|
|
3489
|
+
:default: - ``minNodeVersion`` if set, otherwise ``lts/*``.
|
|
3163
3490
|
|
|
3164
3491
|
:stability: experimental
|
|
3165
3492
|
'''
|
|
@@ -3236,7 +3563,7 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
3236
3563
|
def eslint(self) -> typing.Optional[builtins.bool]:
|
|
3237
3564
|
'''(experimental) Setup eslint.
|
|
3238
3565
|
|
|
3239
|
-
:default: true
|
|
3566
|
+
:default: - true, unless biome is enabled
|
|
3240
3567
|
|
|
3241
3568
|
:stability: experimental
|
|
3242
3569
|
'''
|
|
@@ -3499,10 +3826,10 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
3499
3826
|
and should remain on the same minor, so we recommend using a ``~`` dependency
|
|
3500
3827
|
(e.g. ``~5.0.0``).
|
|
3501
3828
|
|
|
3502
|
-
:default: "
|
|
3829
|
+
:default: "~5.8.0"
|
|
3503
3830
|
|
|
3504
3831
|
:stability: experimental
|
|
3505
|
-
:pjnew: "~5.
|
|
3832
|
+
:pjnew: "~5.9.0"
|
|
3506
3833
|
'''
|
|
3507
3834
|
result = self._values.get("jsii_version")
|
|
3508
3835
|
return typing.cast(typing.Optional[builtins.str], result)
|
|
@@ -3609,7 +3936,7 @@ class ConstructLibraryCdktfOptions(_ConstructLibraryOptions_dcd2adc0):
|
|
|
3609
3936
|
def constructs_version(self) -> typing.Optional[builtins.str]:
|
|
3610
3937
|
'''(experimental) Construct version to use.
|
|
3611
3938
|
|
|
3612
|
-
:default: "^10.0
|
|
3939
|
+
:default: "^10.3.0"
|
|
3613
3940
|
|
|
3614
3941
|
:stability: experimental
|
|
3615
3942
|
'''
|
|
@@ -3676,6 +4003,7 @@ def _typecheckingstub__bbf02af18148d47e66a6d0672a809602f782953da7a849545a808c276
|
|
|
3676
4003
|
bugs_email: typing.Optional[builtins.str] = None,
|
|
3677
4004
|
bugs_url: typing.Optional[builtins.str] = None,
|
|
3678
4005
|
bundled_deps: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
4006
|
+
bun_version: typing.Optional[builtins.str] = None,
|
|
3679
4007
|
code_artifact_options: typing.Optional[typing.Union[_CodeArtifactOptions_e4782b3e, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
3680
4008
|
deps: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
3681
4009
|
description: typing.Optional[builtins.str] = None,
|
|
@@ -3688,9 +4016,11 @@ def _typecheckingstub__bbf02af18148d47e66a6d0672a809602f782953da7a849545a808c276
|
|
|
3688
4016
|
max_node_version: typing.Optional[builtins.str] = None,
|
|
3689
4017
|
min_node_version: typing.Optional[builtins.str] = None,
|
|
3690
4018
|
npm_access: typing.Optional[_NpmAccess_134fa228] = None,
|
|
4019
|
+
npm_provenance: typing.Optional[builtins.bool] = None,
|
|
3691
4020
|
npm_registry: typing.Optional[builtins.str] = None,
|
|
3692
4021
|
npm_registry_url: typing.Optional[builtins.str] = None,
|
|
3693
4022
|
npm_token_secret: typing.Optional[builtins.str] = None,
|
|
4023
|
+
npm_trusted_publishing: typing.Optional[builtins.bool] = None,
|
|
3694
4024
|
package_manager: typing.Optional[_NodePackageManager_3eb53bf6] = None,
|
|
3695
4025
|
package_name: typing.Optional[builtins.str] = None,
|
|
3696
4026
|
peer_dependency_options: typing.Optional[typing.Union[_PeerDependencyOptions_99d7d493, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
@@ -3702,9 +4032,11 @@ def _typecheckingstub__bbf02af18148d47e66a6d0672a809602f782953da7a849545a808c276
|
|
|
3702
4032
|
scripts: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
3703
4033
|
stability: typing.Optional[builtins.str] = None,
|
|
3704
4034
|
yarn_berry_options: typing.Optional[typing.Union[_YarnBerryOptions_b6942539, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
4035
|
+
bump_package: typing.Optional[builtins.str] = None,
|
|
3705
4036
|
jsii_release_version: typing.Optional[builtins.str] = None,
|
|
3706
4037
|
major_version: typing.Optional[jsii.Number] = None,
|
|
3707
4038
|
min_major_version: typing.Optional[jsii.Number] = None,
|
|
4039
|
+
next_version_command: typing.Optional[builtins.str] = None,
|
|
3708
4040
|
npm_dist_tag: typing.Optional[builtins.str] = None,
|
|
3709
4041
|
post_build_steps: typing.Optional[typing.Sequence[typing.Union[_JobStep_c3287c05, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
3710
4042
|
prerelease: typing.Optional[builtins.str] = None,
|
|
@@ -3712,12 +4044,14 @@ def _typecheckingstub__bbf02af18148d47e66a6d0672a809602f782953da7a849545a808c276
|
|
|
3712
4044
|
publish_tasks: typing.Optional[builtins.bool] = None,
|
|
3713
4045
|
releasable_commits: typing.Optional[_ReleasableCommits_d481ce10] = None,
|
|
3714
4046
|
release_branches: typing.Optional[typing.Mapping[builtins.str, typing.Union[_BranchOptions_13663d08, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
4047
|
+
release_environment: typing.Optional[builtins.str] = None,
|
|
3715
4048
|
release_every_commit: typing.Optional[builtins.bool] = None,
|
|
3716
4049
|
release_failure_issue: typing.Optional[builtins.bool] = None,
|
|
3717
4050
|
release_failure_issue_label: typing.Optional[builtins.str] = None,
|
|
3718
4051
|
release_schedule: typing.Optional[builtins.str] = None,
|
|
3719
4052
|
release_tag_prefix: typing.Optional[builtins.str] = None,
|
|
3720
4053
|
release_trigger: typing.Optional[_ReleaseTrigger_e4dc221f] = None,
|
|
4054
|
+
release_workflow_env: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
3721
4055
|
release_workflow_name: typing.Optional[builtins.str] = None,
|
|
3722
4056
|
release_workflow_setup_steps: typing.Optional[typing.Sequence[typing.Union[_JobStep_c3287c05, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
3723
4057
|
versionrc_options: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
|
|
@@ -3726,8 +4060,13 @@ def _typecheckingstub__bbf02af18148d47e66a6d0672a809602f782953da7a849545a808c276
|
|
|
3726
4060
|
workflow_runs_on_group: typing.Optional[typing.Union[_GroupRunnerOptions_148c59c1, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
3727
4061
|
default_release_branch: builtins.str,
|
|
3728
4062
|
artifacts_directory: typing.Optional[builtins.str] = None,
|
|
4063
|
+
audit_deps: typing.Optional[builtins.bool] = None,
|
|
4064
|
+
audit_deps_options: typing.Optional[typing.Union[_AuditOptions_429c62df, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
3729
4065
|
auto_approve_upgrades: typing.Optional[builtins.bool] = None,
|
|
4066
|
+
biome: typing.Optional[builtins.bool] = None,
|
|
4067
|
+
biome_options: typing.Optional[typing.Union[_BiomeOptions_452ab984, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
3730
4068
|
build_workflow: typing.Optional[builtins.bool] = None,
|
|
4069
|
+
build_workflow_options: typing.Optional[typing.Union[_BuildWorkflowOptions_b756f97f, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
3731
4070
|
build_workflow_triggers: typing.Optional[typing.Union[_Triggers_e9ae7617, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
3732
4071
|
bundler_options: typing.Optional[typing.Union[_BundlerOptions_d60b85ed, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
3733
4072
|
check_licenses: typing.Optional[typing.Union[_LicenseCheckerOptions_80bcd362, typing.Dict[builtins.str, typing.Any]]] = None,
|