projen 0.28.31 → 0.28.35

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (99) hide show
  1. package/.jsii +254 -307
  2. package/API.md +113 -150
  3. package/lib/awscdk-app-ts.js +1 -1
  4. package/lib/awscdk-construct.js +2 -2
  5. package/lib/cdk8s-app-ts.js +1 -1
  6. package/lib/cdk8s-construct.js +1 -1
  7. package/lib/cdktf-construct.js +1 -1
  8. package/lib/component.js +1 -1
  9. package/lib/construct-lib.js +1 -1
  10. package/lib/deps/dependencies.js +1 -1
  11. package/lib/dev-env.js +1 -1
  12. package/lib/docker-compose.js +2 -2
  13. package/lib/eslint.js +1 -1
  14. package/lib/file.js +1 -1
  15. package/lib/git/gitattributes.js +1 -1
  16. package/lib/github/auto-approve.js +1 -1
  17. package/lib/github/auto-merge.js +1 -1
  18. package/lib/github/constants.d.ts +14 -0
  19. package/lib/github/constants.js +23 -0
  20. package/lib/github/dependabot.d.ts +6 -0
  21. package/lib/github/dependabot.js +7 -6
  22. package/lib/github/github.js +1 -1
  23. package/lib/github/mergify.js +1 -1
  24. package/lib/github/pr-template.js +1 -1
  25. package/lib/github/stale.js +1 -1
  26. package/lib/github/task-workflow.js +4 -9
  27. package/lib/github/workflows.js +1 -1
  28. package/lib/gitpod.js +1 -1
  29. package/lib/ignore-file.js +1 -1
  30. package/lib/ini.js +1 -1
  31. package/lib/inventory.js +6 -1
  32. package/lib/java/java-project.js +1 -1
  33. package/lib/java/junit.js +1 -1
  34. package/lib/java/maven-compile.js +1 -1
  35. package/lib/java/maven-packaging.js +1 -1
  36. package/lib/java/maven-sample.js +1 -1
  37. package/lib/java/pom.js +1 -1
  38. package/lib/java/projenrc.js +1 -1
  39. package/lib/javascript/npm-config.js +1 -1
  40. package/lib/javascript/projenrc.js +1 -1
  41. package/lib/jest.js +1 -1
  42. package/lib/jsii-project.js +1 -1
  43. package/lib/json/projenrc.js +1 -1
  44. package/lib/json.js +1 -1
  45. package/lib/license.js +1 -1
  46. package/lib/logger.js +1 -1
  47. package/lib/makefile.js +1 -1
  48. package/lib/node-package.js +1 -1
  49. package/lib/node-project.d.ts +18 -43
  50. package/lib/node-project.js +56 -100
  51. package/lib/object-file.js +1 -1
  52. package/lib/project.js +2 -2
  53. package/lib/python/pip.js +1 -1
  54. package/lib/python/poetry.js +2 -2
  55. package/lib/python/projenrc.js +1 -1
  56. package/lib/python/pytest.js +1 -1
  57. package/lib/python/python-project.js +1 -1
  58. package/lib/python/python-sample.js +1 -1
  59. package/lib/python/requirements-file.js +1 -1
  60. package/lib/python/setuppy.js +1 -1
  61. package/lib/python/setuptools.js +1 -1
  62. package/lib/python/venv.js +1 -1
  63. package/lib/readme.js +1 -1
  64. package/lib/release/publisher.d.ts +1 -1
  65. package/lib/release/publisher.js +5 -4
  66. package/lib/release/release.js +1 -1
  67. package/lib/sample-file.js +2 -2
  68. package/lib/semver.js +1 -1
  69. package/lib/source-code.js +1 -1
  70. package/lib/tasks/runtime.js +1 -1
  71. package/lib/tasks/task.js +1 -1
  72. package/lib/tasks/tasks.js +1 -1
  73. package/lib/textfile.js +1 -1
  74. package/lib/toml.js +1 -1
  75. package/lib/typescript/projenrc.js +1 -1
  76. package/lib/typescript-config.js +1 -1
  77. package/lib/typescript.js +3 -3
  78. package/lib/upgrade-dependencies.d.ts +13 -0
  79. package/lib/upgrade-dependencies.js +25 -19
  80. package/lib/version.js +1 -1
  81. package/lib/vscode/devcontainer.js +1 -1
  82. package/lib/vscode/launch-config.js +1 -1
  83. package/lib/vscode/vscode.js +1 -1
  84. package/lib/web/next.js +3 -3
  85. package/lib/web/postcss.js +1 -1
  86. package/lib/web/react.js +4 -4
  87. package/lib/web/tailwind.js +1 -1
  88. package/lib/xmlfile.js +1 -1
  89. package/lib/yaml.js +1 -1
  90. package/node_modules/is-core-module/CHANGELOG.md +10 -0
  91. package/node_modules/is-core-module/core.json +56 -56
  92. package/node_modules/is-core-module/package.json +3 -2
  93. package/node_modules/is-core-module/test/index.js +22 -0
  94. package/node_modules/{string-width/node_modules/is-fullwidth-code-point → is-fullwidth-code-point}/index.d.ts +0 -0
  95. package/node_modules/{string-width/node_modules/is-fullwidth-code-point → is-fullwidth-code-point}/index.js +0 -0
  96. package/node_modules/{string-width/node_modules/is-fullwidth-code-point → is-fullwidth-code-point}/license +0 -0
  97. package/node_modules/{string-width/node_modules/is-fullwidth-code-point → is-fullwidth-code-point}/package.json +0 -0
  98. package/node_modules/{string-width/node_modules/is-fullwidth-code-point → is-fullwidth-code-point}/readme.md +0 -0
  99. package/package.json +4 -4
package/API.md CHANGED
@@ -12,7 +12,6 @@ Name|Description
12
12
  [ConstructLibraryAws](#projen-constructlibraryaws)|*No description*
13
13
  [ConstructLibraryCdk8s](#projen-constructlibrarycdk8s)|CDK8s construct library project.
14
14
  [ConstructLibraryCdktf](#projen-constructlibrarycdktf)|CDKTF construct library project.
15
- [DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)|Dependencies upgrade mechanism.
16
15
  [DevEnvironmentDockerImage](#projen-devenvironmentdockerimage)|Options for specifying the Docker image of the container.
17
16
  [DockerCompose](#projen-dockercompose)|Create a docker-compose YAML file.
18
17
  [DockerComposeService](#projen-dockercomposeservice)|A docker-compose service.
@@ -439,9 +438,10 @@ new AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
439
438
  * **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
440
439
  * **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
441
440
  * **copyrightPeriod** (<code>string</code>) The copyright years to put in the LICENSE file. __*Default*__: current year
442
- * **dependabot** (<code>boolean</code>) Include dependabot configuration. __*Default*__: false
441
+ * **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
443
442
  * **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
444
- * **depsUpgrade** (<code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code>) How to handle dependency upgrades. __*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
443
+ * **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
444
+ * **depsUpgradeOptions** (<code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code>) Options for depsUpgrade. __*Default*__: default options
445
445
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
446
446
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
447
447
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
@@ -642,9 +642,10 @@ new AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
642
642
  * **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
643
643
  * **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
644
644
  * **copyrightPeriod** (<code>string</code>) The copyright years to put in the LICENSE file. __*Default*__: current year
645
- * **dependabot** (<code>boolean</code>) Include dependabot configuration. __*Default*__: false
645
+ * **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
646
646
  * **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
647
- * **depsUpgrade** (<code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code>) How to handle dependency upgrades. __*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
647
+ * **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
648
+ * **depsUpgradeOptions** (<code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code>) Options for depsUpgrade. __*Default*__: default options
648
649
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
649
650
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
650
651
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
@@ -809,9 +810,10 @@ new Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
809
810
  * **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
810
811
  * **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
811
812
  * **copyrightPeriod** (<code>string</code>) The copyright years to put in the LICENSE file. __*Default*__: current year
812
- * **dependabot** (<code>boolean</code>) Include dependabot configuration. __*Default*__: false
813
+ * **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
813
814
  * **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
814
- * **depsUpgrade** (<code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code>) How to handle dependency upgrades. __*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
815
+ * **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
816
+ * **depsUpgradeOptions** (<code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code>) Options for depsUpgrade. __*Default*__: default options
815
817
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
816
818
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
817
819
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
@@ -1034,9 +1036,10 @@ new ConstructLibrary(options: ConstructLibraryOptions)
1034
1036
  * **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
1035
1037
  * **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
1036
1038
  * **copyrightPeriod** (<code>string</code>) The copyright years to put in the LICENSE file. __*Default*__: current year
1037
- * **dependabot** (<code>boolean</code>) Include dependabot configuration. __*Default*__: false
1039
+ * **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
1038
1040
  * **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
1039
- * **depsUpgrade** (<code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code>) How to handle dependency upgrades. __*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
1041
+ * **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
1042
+ * **depsUpgradeOptions** (<code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code>) Options for depsUpgrade. __*Default*__: default options
1040
1043
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
1041
1044
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
1042
1045
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
@@ -1183,9 +1186,10 @@ new ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
1183
1186
  * **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
1184
1187
  * **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
1185
1188
  * **copyrightPeriod** (<code>string</code>) The copyright years to put in the LICENSE file. __*Default*__: current year
1186
- * **dependabot** (<code>boolean</code>) Include dependabot configuration. __*Default*__: false
1189
+ * **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
1187
1190
  * **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
1188
- * **depsUpgrade** (<code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code>) How to handle dependency upgrades. __*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
1191
+ * **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
1192
+ * **depsUpgradeOptions** (<code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code>) Options for depsUpgrade. __*Default*__: default options
1189
1193
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
1190
1194
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
1191
1195
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
@@ -1343,9 +1347,10 @@ new ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
1343
1347
  * **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
1344
1348
  * **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
1345
1349
  * **copyrightPeriod** (<code>string</code>) The copyright years to put in the LICENSE file. __*Default*__: current year
1346
- * **dependabot** (<code>boolean</code>) Include dependabot configuration. __*Default*__: false
1350
+ * **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
1347
1351
  * **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
1348
- * **depsUpgrade** (<code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code>) How to handle dependency upgrades. __*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
1352
+ * **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
1353
+ * **depsUpgradeOptions** (<code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code>) Options for depsUpgrade. __*Default*__: default options
1349
1354
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
1350
1355
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
1351
1356
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
@@ -1512,9 +1517,10 @@ new ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
1512
1517
  * **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
1513
1518
  * **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
1514
1519
  * **copyrightPeriod** (<code>string</code>) The copyright years to put in the LICENSE file. __*Default*__: current year
1515
- * **dependabot** (<code>boolean</code>) Include dependabot configuration. __*Default*__: false
1520
+ * **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
1516
1521
  * **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
1517
- * **depsUpgrade** (<code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code>) How to handle dependency upgrades. __*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
1522
+ * **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
1523
+ * **depsUpgradeOptions** (<code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code>) Options for depsUpgrade. __*Default*__: default options
1518
1524
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
1519
1525
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
1520
1526
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
@@ -1572,77 +1578,6 @@ new ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
1572
1578
 
1573
1579
 
1574
1580
 
1575
- ## class DependenciesUpgradeMechanism 🔹 <a id="projen-dependenciesupgrademechanism"></a>
1576
-
1577
- Dependencies upgrade mechanism.
1578
-
1579
-
1580
-
1581
- ### Properties
1582
-
1583
-
1584
- Name | Type | Description
1585
- -----|------|-------------
1586
- **ignoresProjen**🔹 | <code>boolean</code> | <span></span>
1587
- *static* **NONE**🔹 | <code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code> | Disable.
1588
-
1589
- ### Methods
1590
-
1591
-
1592
- #### bind(project)🔹 <a id="projen-dependenciesupgrademechanism-bind"></a>
1593
-
1594
-
1595
-
1596
- ```ts
1597
- bind(project: NodeProject): void
1598
- ```
1599
-
1600
- * **project** (<code>[NodeProject](#projen-nodeproject)</code>) *No description*
1601
-
1602
-
1603
-
1604
-
1605
- #### *static* dependabot(options?)🔹 <a id="projen-dependenciesupgrademechanism-dependabot"></a>
1606
-
1607
- Upgrade via dependabot.
1608
-
1609
- ```ts
1610
- static dependabot(options?: DependabotOptions): DependenciesUpgradeMechanism
1611
- ```
1612
-
1613
- * **options** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) *No description*
1614
- * **ignore** (<code>Array<[github.DependabotIgnore](#projen-github-dependabotignore)></code>) You can use the `ignore` option to customize which dependencies are updated. __*Default*__: []
1615
- * **ignoreProjen** (<code>boolean</code>) Ignores updates to `projen`. __*Default*__: true
1616
- * **labels** (<code>Array<string></code>) List of labels to apply to the created PR's. __*Optional*__
1617
- * **registries** (<code>Map<string, [github.DependabotRegistry](#projen-github-dependabotregistry)></code>) Map of package registries to use. __*Default*__: use public registries
1618
- * **scheduleInterval** (<code>[github.DependabotScheduleInterval](#projen-github-dependabotscheduleinterval)</code>) How often to check for new versions and raise pull requests. __*Default*__: ScheduleInterval.DAILY
1619
- * **versioningStrategy** (<code>[github.VersioningStrategy](#projen-github-versioningstrategy)</code>) The strategy to use when edits manifest and lock files. __*Default*__: VersioningStrategy.LOCKFILE_ONLY The default is to only update the lock file because package.json is controlled by projen and any outside updates will fail the build.
1620
-
1621
- __Returns__:
1622
- * <code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code>
1623
-
1624
- #### *static* githubWorkflow(options?)🔹 <a id="projen-dependenciesupgrademechanism-githubworkflow"></a>
1625
-
1626
- Upgrade via a custom github workflow.
1627
-
1628
- ```ts
1629
- static githubWorkflow(options?: UpgradeDependenciesOptions): DependenciesUpgradeMechanism
1630
- ```
1631
-
1632
- * **options** (<code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code>) *No description*
1633
- * **exclude** (<code>Array<string></code>) List of package names to exclude during the upgrade. __*Default*__: Nothing is excluded.
1634
- * **ignoreProjen** (<code>boolean</code>) Whether or not to ignore projen upgrades. __*Default*__: true
1635
- * **include** (<code>Array<string></code>) List of package names to include during the upgrade. __*Default*__: Everything is included.
1636
- * **pullRequestTitle** (<code>string</code>) Title of the pull request to use (should be all lower-case). __*Default*__: "upgrade dependencies"
1637
- * **taskName** (<code>string</code>) The name of the task that will be created. __*Default*__: "upgrade".
1638
- * **workflow** (<code>boolean</code>) Include a github workflow for creating PR's that upgrades the required dependencies, either by manual dispatch, or by a schedule. __*Default*__: true for root projects, false for sub-projects.
1639
- * **workflowOptions** (<code>[UpgradeDependenciesWorkflowOptions](#projen-upgradedependenciesworkflowoptions)</code>) Options for the github workflow. __*Default*__: default options.
1640
-
1641
- __Returns__:
1642
- * <code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code>
1643
-
1644
-
1645
-
1646
1581
  ## class DevEnvironmentDockerImage 🔹 <a id="projen-devenvironmentdockerimage"></a>
1647
1582
 
1648
1583
  Options for specifying the Docker image of the container.
@@ -2639,9 +2574,10 @@ new JsiiProject(options: JsiiProjectOptions)
2639
2574
  * **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
2640
2575
  * **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
2641
2576
  * **copyrightPeriod** (<code>string</code>) The copyright years to put in the LICENSE file. __*Default*__: current year
2642
- * **dependabot** (<code>boolean</code>) Include dependabot configuration. __*Default*__: false
2577
+ * **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
2643
2578
  * **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
2644
- * **depsUpgrade** (<code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code>) How to handle dependency upgrades. __*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
2579
+ * **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
2580
+ * **depsUpgradeOptions** (<code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code>) Options for depsUpgrade. __*Default*__: default options
2645
2581
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
2646
2582
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
2647
2583
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
@@ -3386,9 +3322,10 @@ new NodeProject(options: NodeProjectOptions)
3386
3322
  * **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
3387
3323
  * **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
3388
3324
  * **copyrightPeriod** (<code>string</code>) The copyright years to put in the LICENSE file. __*Default*__: current year
3389
- * **dependabot** (<code>boolean</code>) Include dependabot configuration. __*Default*__: false
3325
+ * **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
3390
3326
  * **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
3391
- * **depsUpgrade** (<code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code>) How to handle dependency upgrades. __*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
3327
+ * **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
3328
+ * **depsUpgradeOptions** (<code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code>) Options for depsUpgrade. __*Default*__: default options
3392
3329
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
3393
3330
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
3394
3331
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
@@ -4476,9 +4413,10 @@ new TypeScriptAppProject(options: TypeScriptProjectOptions)
4476
4413
  * **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
4477
4414
  * **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
4478
4415
  * **copyrightPeriod** (<code>string</code>) The copyright years to put in the LICENSE file. __*Default*__: current year
4479
- * **dependabot** (<code>boolean</code>) Include dependabot configuration. __*Default*__: false
4416
+ * **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
4480
4417
  * **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
4481
- * **depsUpgrade** (<code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code>) How to handle dependency upgrades. __*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
4418
+ * **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
4419
+ * **depsUpgradeOptions** (<code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code>) Options for depsUpgrade. __*Default*__: default options
4482
4420
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
4483
4421
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
4484
4422
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
@@ -4611,9 +4549,10 @@ new TypeScriptLibraryProject(options: TypeScriptProjectOptions)
4611
4549
  * **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
4612
4550
  * **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
4613
4551
  * **copyrightPeriod** (<code>string</code>) The copyright years to put in the LICENSE file. __*Default*__: current year
4614
- * **dependabot** (<code>boolean</code>) Include dependabot configuration. __*Default*__: false
4552
+ * **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
4615
4553
  * **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
4616
- * **depsUpgrade** (<code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code>) How to handle dependency upgrades. __*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
4554
+ * **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
4555
+ * **depsUpgradeOptions** (<code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code>) Options for depsUpgrade. __*Default*__: default options
4617
4556
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
4618
4557
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
4619
4558
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
@@ -4746,9 +4685,10 @@ new TypeScriptProject(options: TypeScriptProjectOptions)
4746
4685
  * **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
4747
4686
  * **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
4748
4687
  * **copyrightPeriod** (<code>string</code>) The copyright years to put in the LICENSE file. __*Default*__: current year
4749
- * **dependabot** (<code>boolean</code>) Include dependabot configuration. __*Default*__: false
4688
+ * **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
4750
4689
  * **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
4751
- * **depsUpgrade** (<code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code>) How to handle dependency upgrades. __*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
4690
+ * **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
4691
+ * **depsUpgradeOptions** (<code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code>) Options for depsUpgrade. __*Default*__: default options
4752
4692
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
4753
4693
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
4754
4694
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
@@ -4894,6 +4834,7 @@ new UpgradeDependencies(project: NodeProject, options?: UpgradeDependenciesOptio
4894
4834
  * **ignoreProjen** (<code>boolean</code>) Whether or not to ignore projen upgrades. __*Default*__: true
4895
4835
  * **include** (<code>Array<string></code>) List of package names to include during the upgrade. __*Default*__: Everything is included.
4896
4836
  * **pullRequestTitle** (<code>string</code>) Title of the pull request to use (should be all lower-case). __*Default*__: "upgrade dependencies"
4837
+ * **signoff** (<code>boolean</code>) Add Signed-off-by line by the committer at the end of the commit log message. __*Default*__: true
4897
4838
  * **taskName** (<code>string</code>) The name of the task that will be created. __*Default*__: "upgrade".
4898
4839
  * **workflow** (<code>boolean</code>) Include a github workflow for creating PR's that upgrades the required dependencies, either by manual dispatch, or by a schedule. __*Default*__: true for root projects, false for sub-projects.
4899
4840
  * **workflowOptions** (<code>[UpgradeDependenciesWorkflowOptions](#projen-upgradedependenciesworkflowoptions)</code>) Options for the github workflow. __*Default*__: default options.
@@ -4905,6 +4846,7 @@ new UpgradeDependencies(project: NodeProject, options?: UpgradeDependenciesOptio
4905
4846
 
4906
4847
  Name | Type | Description
4907
4848
  -----|------|-------------
4849
+ **ignoresProjen**🔹 | <code>boolean</code> | Whether or not projen is also upgraded in this workflow,.
4908
4850
  **workflow**?🔹 | <code>[github.GithubWorkflow](#projen-github-githubworkflow)</code> | The workflow that executes the upgrade.<br/>__*Optional*__
4909
4851
 
4910
4852
 
@@ -5328,6 +5270,7 @@ new github.Dependabot(github: GitHub, options?: DependabotOptions)
5328
5270
  Name | Type | Description
5329
5271
  -----|------|-------------
5330
5272
  **config**🔹 | <code>any</code> | The raw dependabot configuration.
5273
+ **ignoresProjen**🔹 | <code>boolean</code> | Whether or not projen is also upgraded in this config,.
5331
5274
 
5332
5275
  ### Methods
5333
5276
 
@@ -6846,7 +6789,7 @@ publishToGo(options?: GoPublishOptions): void
6846
6789
  * **githubRepo** (<code>string</code>) GitHub repository to push to. __*Default*__: derived from `moduleName`
6847
6790
  * **githubTokenSecret** (<code>string</code>) The name of the secret that includes a personal GitHub access token used to push to the GitHub repository. __*Default*__: "GO_GITHUB_TOKEN"
6848
6791
  * **gitUserEmail** (<code>string</code>) The email to use in the release git commit. __*Default*__: "github-actions
6849
- * **gitUserName** (<code>string</code>) The user name to use for the release git commit. __*Default*__: "GitHub Actions"
6792
+ * **gitUserName** (<code>string</code>) The user name to use for the release git commit. __*Default*__: "github-actions"
6850
6793
 
6851
6794
 
6852
6795
 
@@ -7723,9 +7666,10 @@ new web.NextJsProject(options: NextJsProjectOptions)
7723
7666
  * **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
7724
7667
  * **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
7725
7668
  * **copyrightPeriod** (<code>string</code>) The copyright years to put in the LICENSE file. __*Default*__: current year
7726
- * **dependabot** (<code>boolean</code>) Include dependabot configuration. __*Default*__: false
7669
+ * **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
7727
7670
  * **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
7728
- * **depsUpgrade** (<code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code>) How to handle dependency upgrades. __*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
7671
+ * **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
7672
+ * **depsUpgradeOptions** (<code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code>) Options for depsUpgrade. __*Default*__: default options
7729
7673
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
7730
7674
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
7731
7675
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
@@ -7858,9 +7802,10 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
7858
7802
  * **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
7859
7803
  * **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
7860
7804
  * **copyrightPeriod** (<code>string</code>) The copyright years to put in the LICENSE file. __*Default*__: current year
7861
- * **dependabot** (<code>boolean</code>) Include dependabot configuration. __*Default*__: false
7805
+ * **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
7862
7806
  * **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
7863
- * **depsUpgrade** (<code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code>) How to handle dependency upgrades. __*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
7807
+ * **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
7808
+ * **depsUpgradeOptions** (<code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code>) Options for depsUpgrade. __*Default*__: default options
7864
7809
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
7865
7810
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
7866
7811
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
@@ -8065,9 +8010,10 @@ new web.ReactProject(options: ReactProjectOptions)
8065
8010
  * **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
8066
8011
  * **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
8067
8012
  * **copyrightPeriod** (<code>string</code>) The copyright years to put in the LICENSE file. __*Default*__: current year
8068
- * **dependabot** (<code>boolean</code>) Include dependabot configuration. __*Default*__: false
8013
+ * **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
8069
8014
  * **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
8070
- * **depsUpgrade** (<code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code>) How to handle dependency upgrades. __*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
8015
+ * **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
8016
+ * **depsUpgradeOptions** (<code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code>) Options for depsUpgrade. __*Default*__: default options
8071
8017
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
8072
8018
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
8073
8019
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
@@ -8241,9 +8187,10 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
8241
8187
  * **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
8242
8188
  * **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
8243
8189
  * **copyrightPeriod** (<code>string</code>) The copyright years to put in the LICENSE file. __*Default*__: current year
8244
- * **dependabot** (<code>boolean</code>) Include dependabot configuration. __*Default*__: false
8190
+ * **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
8245
8191
  * **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
8246
- * **depsUpgrade** (<code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code>) How to handle dependency upgrades. __*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
8192
+ * **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
8193
+ * **depsUpgradeOptions** (<code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code>) Options for depsUpgrade. __*Default*__: default options
8247
8194
  * **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
8248
8195
  * **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
8249
8196
  * **jestOptions** (<code>[JestOptions](#projen-jestoptions)</code>) Jest options. __*Default*__: default options
@@ -8376,10 +8323,11 @@ Name | Type | Description
8376
8323
  **constructsVersion**?🔹 | <code>string</code> | Minimum target version of constructs being tested against. If not provided, the default value depends on the configured `cdkVersion`:.<br/>__*Default*__: When the default behavior is used, the dependency on `constructs` will only be added as a `peerDependency`. Otherwise, a `devDependency` will also be added, set to the exact version configrued here.
8377
8324
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
8378
8325
  **copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
8379
- **dependabot**?⚠️ | <code>boolean</code> | Include dependabot configuration.<br/>__*Default*__: false
8380
- **dependabotOptions**?⚠️ | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
8326
+ **dependabot**?🔹 | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
8327
+ **dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
8381
8328
  **deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
8382
- **depsUpgrade**?🔹 | <code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code> | How to handle dependency upgrades.<br/>__*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
8329
+ **depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
8330
+ **depsUpgradeOptions**?🔹 | <code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code> | Options for depsUpgrade.<br/>__*Default*__: default options
8383
8331
  **description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
8384
8332
  **devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
8385
8333
  **devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
@@ -8516,10 +8464,11 @@ Name | Type | Description
8516
8464
  **context**?🔹 | <code>Map<string, string></code> | Additional context to include in `cdk.json`.<br/>__*Optional*__
8517
8465
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
8518
8466
  **copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
8519
- **dependabot**?⚠️ | <code>boolean</code> | Include dependabot configuration.<br/>__*Default*__: false
8520
- **dependabotOptions**?⚠️ | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
8467
+ **dependabot**?🔹 | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
8468
+ **dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
8521
8469
  **deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
8522
- **depsUpgrade**?🔹 | <code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code> | How to handle dependency upgrades.<br/>__*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
8470
+ **depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
8471
+ **depsUpgradeOptions**?🔹 | <code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code> | Options for depsUpgrade.<br/>__*Default*__: default options
8523
8472
  **description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
8524
8473
  **devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
8525
8474
  **devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
@@ -8667,10 +8616,11 @@ Name | Type | Description
8667
8616
  **constructsVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for constructs.<br/>__*Default*__: false
8668
8617
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
8669
8618
  **copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
8670
- **dependabot**?⚠️ | <code>boolean</code> | Include dependabot configuration.<br/>__*Default*__: false
8671
- **dependabotOptions**?⚠️ | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
8619
+ **dependabot**?🔹 | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
8620
+ **dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
8672
8621
  **deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
8673
- **depsUpgrade**?🔹 | <code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code> | How to handle dependency upgrades.<br/>__*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
8622
+ **depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
8623
+ **depsUpgradeOptions**?🔹 | <code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code> | Options for depsUpgrade.<br/>__*Default*__: default options
8674
8624
  **description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
8675
8625
  **devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
8676
8626
  **devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
@@ -8807,10 +8757,11 @@ Name | Type | Description
8807
8757
  **constructsVersion**?⚠️ | <code>string</code> | Minimum target version of constructs being tested against. If not provided, the default value depends on the configured `cdkVersion`:.<br/>__*Default*__: When the default behavior is used, the dependency on `constructs` will only be added as a `peerDependency`. Otherwise, a `devDependency` will also be added, set to the exact version configrued here.
8808
8758
  **copyrightOwner**?⚠️ | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
8809
8759
  **copyrightPeriod**?⚠️ | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
8810
- **dependabot**?⚠️ | <code>boolean</code> | Include dependabot configuration.<br/>__*Default*__: false
8760
+ **dependabot**?⚠️ | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
8811
8761
  **dependabotOptions**?⚠️ | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
8812
8762
  **deps**?⚠️ | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
8813
- **depsUpgrade**?⚠️ | <code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code> | How to handle dependency upgrades.<br/>__*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
8763
+ **depsUpgrade**?⚠️ | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
8764
+ **depsUpgradeOptions**?⚠️ | <code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code> | Options for depsUpgrade.<br/>__*Default*__: default options
8814
8765
  **description**?⚠️ | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
8815
8766
  **devContainer**?⚠️ | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
8816
8767
  **devDeps**?⚠️ | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
@@ -8954,10 +8905,11 @@ Name | Type | Description
8954
8905
  **constructsVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for constructs.<br/>__*Default*__: false
8955
8906
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
8956
8907
  **copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
8957
- **dependabot**?⚠️ | <code>boolean</code> | Include dependabot configuration.<br/>__*Default*__: false
8958
- **dependabotOptions**?⚠️ | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
8908
+ **dependabot**?🔹 | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
8909
+ **dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
8959
8910
  **deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
8960
- **depsUpgrade**?🔹 | <code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code> | How to handle dependency upgrades.<br/>__*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
8911
+ **depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
8912
+ **depsUpgradeOptions**?🔹 | <code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code> | Options for depsUpgrade.<br/>__*Default*__: default options
8961
8913
  **description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
8962
8914
  **devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
8963
8915
  **devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
@@ -9096,10 +9048,11 @@ Name | Type | Description
9096
9048
  **compileBeforeTest**?🔹 | <code>boolean</code> | Compile the code before running tests.<br/>__*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false.
9097
9049
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
9098
9050
  **copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
9099
- **dependabot**?⚠️ | <code>boolean</code> | Include dependabot configuration.<br/>__*Default*__: false
9100
- **dependabotOptions**?⚠️ | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
9051
+ **dependabot**?🔹 | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
9052
+ **dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
9101
9053
  **deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
9102
- **depsUpgrade**?🔹 | <code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code> | How to handle dependency upgrades.<br/>__*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
9054
+ **depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
9055
+ **depsUpgradeOptions**?🔹 | <code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code> | Options for depsUpgrade.<br/>__*Default*__: default options
9103
9056
  **description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
9104
9057
  **devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
9105
9058
  **devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
@@ -9237,10 +9190,11 @@ Name | Type | Description
9237
9190
  **compileBeforeTest**?🔹 | <code>boolean</code> | Compile the code before running tests.<br/>__*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false.
9238
9191
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
9239
9192
  **copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
9240
- **dependabot**?⚠️ | <code>boolean</code> | Include dependabot configuration.<br/>__*Default*__: false
9241
- **dependabotOptions**?⚠️ | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
9193
+ **dependabot**?🔹 | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
9194
+ **dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
9242
9195
  **deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
9243
- **depsUpgrade**?🔹 | <code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code> | How to handle dependency upgrades.<br/>__*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
9196
+ **depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
9197
+ **depsUpgradeOptions**?🔹 | <code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code> | Options for depsUpgrade.<br/>__*Default*__: default options
9244
9198
  **description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
9245
9199
  **devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
9246
9200
  **devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
@@ -9980,7 +9934,7 @@ Name | Type | Description
9980
9934
  **gitBranch**?⚠️ | <code>string</code> | Branch to push to.<br/>__*Default*__: "main"
9981
9935
  **gitCommitMessage**?⚠️ | <code>string</code> | The commit message.<br/>__*Default*__: "chore(release): $VERSION"
9982
9936
  **gitUserEmail**?⚠️ | <code>string</code> | The email to use in the release git commit.<br/>__*Default*__: "github-actions
9983
- **gitUserName**?⚠️ | <code>string</code> | The user name to use for the release git commit.<br/>__*Default*__: "GitHub Actions"
9937
+ **gitUserName**?⚠️ | <code>string</code> | The user name to use for the release git commit.<br/>__*Default*__: "github-actions"
9984
9938
  **githubRepo**?⚠️ | <code>string</code> | GitHub repository to push to.<br/>__*Default*__: derived from `moduleName`
9985
9939
  **githubTokenSecret**?⚠️ | <code>string</code> | The name of the secret that includes a personal GitHub access token used to push to the GitHub repository.<br/>__*Default*__: "GO_GITHUB_TOKEN"
9986
9940
 
@@ -10046,10 +10000,11 @@ Name | Type | Description
10046
10000
  **compileBeforeTest**?🔹 | <code>boolean</code> | Compile the code before running tests.<br/>__*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false.
10047
10001
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
10048
10002
  **copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
10049
- **dependabot**?⚠️ | <code>boolean</code> | Include dependabot configuration.<br/>__*Default*__: false
10050
- **dependabotOptions**?⚠️ | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
10003
+ **dependabot**?🔹 | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
10004
+ **dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
10051
10005
  **deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
10052
- **depsUpgrade**?🔹 | <code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code> | How to handle dependency upgrades.<br/>__*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
10006
+ **depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
10007
+ **depsUpgradeOptions**?🔹 | <code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code> | Options for depsUpgrade.<br/>__*Default*__: default options
10053
10008
  **description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
10054
10009
  **devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
10055
10010
  **devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
@@ -10325,10 +10280,11 @@ Name | Type | Description
10325
10280
  **codeCovTokenSecret**?🔹 | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.<br/>__*Default*__: if this option is not specified, only public repositories are supported
10326
10281
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
10327
10282
  **copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
10328
- **dependabot**?⚠️ | <code>boolean</code> | Include dependabot configuration.<br/>__*Default*__: false
10329
- **dependabotOptions**?⚠️ | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
10283
+ **dependabot**?🔹 | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
10284
+ **dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
10330
10285
  **deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
10331
- **depsUpgrade**?🔹 | <code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code> | How to handle dependency upgrades.<br/>__*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
10286
+ **depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
10287
+ **depsUpgradeOptions**?🔹 | <code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code> | Options for depsUpgrade.<br/>__*Default*__: default options
10332
10288
  **description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
10333
10289
  **devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
10334
10290
  **devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
@@ -10671,10 +10627,11 @@ Name | Type | Description
10671
10627
  **compileBeforeTest**?⚠️ | <code>boolean</code> | Compile the code before running tests.<br/>__*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false.
10672
10628
  **copyrightOwner**?⚠️ | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
10673
10629
  **copyrightPeriod**?⚠️ | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
10674
- **dependabot**?⚠️ | <code>boolean</code> | Include dependabot configuration.<br/>__*Default*__: false
10630
+ **dependabot**?⚠️ | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
10675
10631
  **dependabotOptions**?⚠️ | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
10676
10632
  **deps**?⚠️ | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
10677
- **depsUpgrade**?⚠️ | <code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code> | How to handle dependency upgrades.<br/>__*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
10633
+ **depsUpgrade**?⚠️ | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
10634
+ **depsUpgradeOptions**?⚠️ | <code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code> | Options for depsUpgrade.<br/>__*Default*__: default options
10678
10635
  **description**?⚠️ | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
10679
10636
  **devContainer**?⚠️ | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
10680
10637
  **devDeps**?⚠️ | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
@@ -10798,10 +10755,11 @@ Name | Type | Description
10798
10755
  **compileBeforeTest**?🔹 | <code>boolean</code> | Compile the code before running tests.<br/>__*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false.
10799
10756
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
10800
10757
  **copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
10801
- **dependabot**?⚠️ | <code>boolean</code> | Include dependabot configuration.<br/>__*Default*__: false
10802
- **dependabotOptions**?⚠️ | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
10758
+ **dependabot**?🔹 | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
10759
+ **dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
10803
10760
  **deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
10804
- **depsUpgrade**?🔹 | <code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code> | How to handle dependency upgrades.<br/>__*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
10761
+ **depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
10762
+ **depsUpgradeOptions**?🔹 | <code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code> | Options for depsUpgrade.<br/>__*Default*__: default options
10805
10763
  **description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
10806
10764
  **devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
10807
10765
  **devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
@@ -10922,6 +10880,7 @@ Name | Type | Description
10922
10880
  **ignoreProjen**?🔹 | <code>boolean</code> | Whether or not to ignore projen upgrades.<br/>__*Default*__: true
10923
10881
  **include**?🔹 | <code>Array<string></code> | List of package names to include during the upgrade.<br/>__*Default*__: Everything is included.
10924
10882
  **pullRequestTitle**?🔹 | <code>string</code> | Title of the pull request to use (should be all lower-case).<br/>__*Default*__: "upgrade dependencies"
10883
+ **signoff**?🔹 | <code>boolean</code> | Add Signed-off-by line by the committer at the end of the commit log message.<br/>__*Default*__: true
10925
10884
  **taskName**?🔹 | <code>string</code> | The name of the task that will be created.<br/>__*Default*__: "upgrade".
10926
10885
  **workflow**?🔹 | <code>boolean</code> | Include a github workflow for creating PR's that upgrades the required dependencies, either by manual dispatch, or by a schedule.<br/>__*Default*__: true for root projects, false for sub-projects.
10927
10886
  **workflowOptions**?🔹 | <code>[UpgradeDependenciesWorkflowOptions](#projen-upgradedependenciesworkflowoptions)</code> | Options for the github workflow.<br/>__*Default*__: default options.
@@ -11854,7 +11813,7 @@ Name | Type | Description
11854
11813
  **gitBranch**?⚠️ | <code>string</code> | Branch to push to.<br/>__*Default*__: "main"
11855
11814
  **gitCommitMessage**?⚠️ | <code>string</code> | The commit message.<br/>__*Default*__: "chore(release): $VERSION"
11856
11815
  **gitUserEmail**?⚠️ | <code>string</code> | The email to use in the release git commit.<br/>__*Default*__: "github-actions
11857
- **gitUserName**?⚠️ | <code>string</code> | The user name to use for the release git commit.<br/>__*Default*__: "GitHub Actions"
11816
+ **gitUserName**?⚠️ | <code>string</code> | The user name to use for the release git commit.<br/>__*Default*__: "github-actions"
11858
11817
  **githubRepo**?⚠️ | <code>string</code> | GitHub repository to push to.<br/>__*Default*__: derived from `moduleName`
11859
11818
  **githubTokenSecret**?⚠️ | <code>string</code> | The name of the secret that includes a personal GitHub access token used to push to the GitHub repository.<br/>__*Default*__: "GO_GITHUB_TOKEN"
11860
11819
 
@@ -12315,10 +12274,11 @@ Name | Type | Description
12315
12274
  **codeCovTokenSecret**?🔹 | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.<br/>__*Default*__: if this option is not specified, only public repositories are supported
12316
12275
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
12317
12276
  **copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
12318
- **dependabot**?⚠️ | <code>boolean</code> | Include dependabot configuration.<br/>__*Default*__: false
12319
- **dependabotOptions**?⚠️ | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
12277
+ **dependabot**?🔹 | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
12278
+ **dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
12320
12279
  **deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
12321
- **depsUpgrade**?🔹 | <code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code> | How to handle dependency upgrades.<br/>__*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
12280
+ **depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
12281
+ **depsUpgradeOptions**?🔹 | <code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code> | Options for depsUpgrade.<br/>__*Default*__: default options
12322
12282
  **description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
12323
12283
  **devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
12324
12284
  **devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
@@ -12431,10 +12391,11 @@ Name | Type | Description
12431
12391
  **compileBeforeTest**?🔹 | <code>boolean</code> | Compile the code before running tests.<br/>__*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false.
12432
12392
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
12433
12393
  **copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
12434
- **dependabot**?⚠️ | <code>boolean</code> | Include dependabot configuration.<br/>__*Default*__: false
12435
- **dependabotOptions**?⚠️ | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
12394
+ **dependabot**?🔹 | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
12395
+ **dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
12436
12396
  **deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
12437
- **depsUpgrade**?🔹 | <code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code> | How to handle dependency upgrades.<br/>__*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
12397
+ **depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
12398
+ **depsUpgradeOptions**?🔹 | <code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code> | Options for depsUpgrade.<br/>__*Default*__: default options
12438
12399
  **description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
12439
12400
  **devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
12440
12401
  **devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
@@ -12587,10 +12548,11 @@ Name | Type | Description
12587
12548
  **codeCovTokenSecret**?🔹 | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.<br/>__*Default*__: if this option is not specified, only public repositories are supported
12588
12549
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
12589
12550
  **copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
12590
- **dependabot**?⚠️ | <code>boolean</code> | Include dependabot configuration.<br/>__*Default*__: false
12591
- **dependabotOptions**?⚠️ | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
12551
+ **dependabot**?🔹 | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
12552
+ **dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
12592
12553
  **deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
12593
- **depsUpgrade**?🔹 | <code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code> | How to handle dependency upgrades.<br/>__*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
12554
+ **depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
12555
+ **depsUpgradeOptions**?🔹 | <code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code> | Options for depsUpgrade.<br/>__*Default*__: default options
12594
12556
  **description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
12595
12557
  **devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
12596
12558
  **devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
@@ -12731,10 +12693,11 @@ Name | Type | Description
12731
12693
  **compileBeforeTest**?🔹 | <code>boolean</code> | Compile the code before running tests.<br/>__*Default*__: if `testdir` is under `src/**`, the default is `true`, otherwise the default is `false.
12732
12694
  **copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
12733
12695
  **copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
12734
- **dependabot**?⚠️ | <code>boolean</code> | Include dependabot configuration.<br/>__*Default*__: false
12735
- **dependabotOptions**?⚠️ | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
12696
+ **dependabot**?🔹 | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
12697
+ **dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
12736
12698
  **deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
12737
- **depsUpgrade**?🔹 | <code>[DependenciesUpgradeMechanism](#projen-dependenciesupgrademechanism)</code> | How to handle dependency upgrades.<br/>__*Default*__: DependenciesUpgradeMechanism.dependabot if dependabot is true, otherwise a DependenciesUpgradeMechanism.githubWorkflow configured from other passed-in NodeProjectOptions
12699
+ **depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
12700
+ **depsUpgradeOptions**?🔹 | <code>[UpgradeDependenciesOptions](#projen-upgradedependenciesoptions)</code> | Options for depsUpgrade.<br/>__*Default*__: default options
12738
12701
  **description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
12739
12702
  **devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
12740
12703
  **devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []