projen-modules 3.1.0__tar.gz → 3.2.1__tar.gz

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.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: projen_modules
3
- Version: 3.1.0
3
+ Version: 3.2.1
4
4
  Summary: A collection of projen modules
5
5
  Home-page: https://github.com/daveshepherd/projen-modules.git
6
6
  Author: Dave Shepherd<dave.shepherd@endor.me.uk>
@@ -73,6 +73,10 @@ In **Settings → General → Pull Requests**:
73
73
  * Untick **Allow auto-merge**, because GitHub's own auto-merge merges outside the queue.
74
74
  * Tick **Automatically delete head branches**.
75
75
 
76
+ ### Code scanning
77
+
78
+ CodeQL runs from `.github/workflows/codeql.yml`, which is managed by projen. In **Settings → Advanced Security**, leave CodeQL **Default setup** off, because it cannot run alongside this workflow. Under **Protection rules**, keep the **Check run failure threshold** at **High or higher** for security alerts and **Errors** for other alerts, as this decides whether the `CodeQL` check fails. Private repositories also need GitHub Code Security enabled there for code scanning results to be uploaded.
79
+
76
80
  ### Branch ruleset
77
81
 
78
82
  In **Settings → Rules → Rulesets**, create a branch ruleset with enforcement **Active** that targets the default branch, and set:
@@ -82,6 +86,7 @@ In **Settings → Rules → Rulesets**, create a branch ruleset with enforcement
82
86
  * **Restrict deletions** and **Block force pushes**.
83
87
  * **Require a pull request before merging**, with 0 required approvals.
84
88
  * **Require status checks to pass**, listing the checks that `.mergify.yml` waits for: `build`, `package-js`, `package-python`. Leave **Require branches to be up to date before merging** unticked, as the queue already updates and retests each pull request.
89
+ * **Require code scanning results**, with the tool **CodeQL**, security alerts set to **High or higher** and alerts set to **Errors**. Mergify is exempt from this rule, so `.mergify.yml` also waits for the `CodeQL` check instead.
85
90
 
86
91
  Do not enable GitHub's own **Require merge queue** rule, as it competes with Mergify.
87
92
 
@@ -45,6 +45,10 @@ In **Settings → General → Pull Requests**:
45
45
  * Untick **Allow auto-merge**, because GitHub's own auto-merge merges outside the queue.
46
46
  * Tick **Automatically delete head branches**.
47
47
 
48
+ ### Code scanning
49
+
50
+ CodeQL runs from `.github/workflows/codeql.yml`, which is managed by projen. In **Settings → Advanced Security**, leave CodeQL **Default setup** off, because it cannot run alongside this workflow. Under **Protection rules**, keep the **Check run failure threshold** at **High or higher** for security alerts and **Errors** for other alerts, as this decides whether the `CodeQL` check fails. Private repositories also need GitHub Code Security enabled there for code scanning results to be uploaded.
51
+
48
52
  ### Branch ruleset
49
53
 
50
54
  In **Settings → Rules → Rulesets**, create a branch ruleset with enforcement **Active** that targets the default branch, and set:
@@ -54,6 +58,7 @@ In **Settings → Rules → Rulesets**, create a branch ruleset with enforcement
54
58
  * **Restrict deletions** and **Block force pushes**.
55
59
  * **Require a pull request before merging**, with 0 required approvals.
56
60
  * **Require status checks to pass**, listing the checks that `.mergify.yml` waits for: `build`, `package-js`, `package-python`. Leave **Require branches to be up to date before merging** unticked, as the queue already updates and retests each pull request.
61
+ * **Require code scanning results**, with the tool **CodeQL**, security alerts set to **High or higher** and alerts set to **Errors**. Mergify is exempt from this rule, so `.mergify.yml` also waits for the `CodeQL` check instead.
57
62
 
58
63
  Do not enable GitHub's own **Require merge queue** rule, as it competes with Mergify.
59
64
 
@@ -5,7 +5,7 @@ kwargs = json.loads(
5
5
  """
6
6
  {
7
7
  "name": "projen_modules",
8
- "version": "3.1.0",
8
+ "version": "3.2.1",
9
9
  "description": "A collection of projen modules",
10
10
  "license": "Apache-2.0",
11
11
  "url": "https://github.com/daveshepherd/projen-modules.git",
@@ -26,7 +26,7 @@ kwargs = json.loads(
26
26
  ],
27
27
  "package_data": {
28
28
  "projen_modules._jsii": [
29
- "projen-modules@3.1.0.jsii.tgz"
29
+ "projen-modules@3.2.1.jsii.tgz"
30
30
  ],
31
31
  "projen_modules": [
32
32
  "py.typed"
@@ -46,6 +46,10 @@ In **Settings → General → Pull Requests**:
46
46
  * Untick **Allow auto-merge**, because GitHub's own auto-merge merges outside the queue.
47
47
  * Tick **Automatically delete head branches**.
48
48
 
49
+ ### Code scanning
50
+
51
+ CodeQL runs from `.github/workflows/codeql.yml`, which is managed by projen. In **Settings → Advanced Security**, leave CodeQL **Default setup** off, because it cannot run alongside this workflow. Under **Protection rules**, keep the **Check run failure threshold** at **High or higher** for security alerts and **Errors** for other alerts, as this decides whether the `CodeQL` check fails. Private repositories also need GitHub Code Security enabled there for code scanning results to be uploaded.
52
+
49
53
  ### Branch ruleset
50
54
 
51
55
  In **Settings → Rules → Rulesets**, create a branch ruleset with enforcement **Active** that targets the default branch, and set:
@@ -55,6 +59,7 @@ In **Settings → Rules → Rulesets**, create a branch ruleset with enforcement
55
59
  * **Restrict deletions** and **Block force pushes**.
56
60
  * **Require a pull request before merging**, with 0 required approvals.
57
61
  * **Require status checks to pass**, listing the checks that `.mergify.yml` waits for: `build`, `package-js`, `package-python`. Leave **Require branches to be up to date before merging** unticked, as the queue already updates and retests each pull request.
62
+ * **Require code scanning results**, with the tool **CodeQL**, security alerts set to **High or higher** and alerts set to **Errors**. Mergify is exempt from this rule, so `.mergify.yml` also waits for the `CodeQL` check instead.
58
63
 
59
64
  Do not enable GitHub's own **Require merge queue** rule, as it competes with Mergify.
60
65
 
@@ -194,6 +199,7 @@ class CdkTypeScriptApp(
194
199
  code_artifact_options: typing.Optional[typing.Union["_projen_javascript_04054675.CodeArtifactOptions", typing.Dict[builtins.str, typing.Any]]] = None,
195
200
  code_cov: typing.Optional[builtins.bool] = None,
196
201
  code_cov_token_secret: typing.Optional[builtins.str] = None,
202
+ codeql: typing.Optional[builtins.bool] = None,
197
203
  commit_generated: typing.Optional[builtins.bool] = None,
198
204
  config: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
199
205
  constructs_version: typing.Optional[builtins.str] = None,
@@ -371,6 +377,7 @@ class CdkTypeScriptApp(
371
377
  :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
372
378
  :param code_cov: (experimental) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. Uses codecov/codecov-action. By default, OIDC auth is used. Alternatively a token can be provided via ``codeCovTokenSecret``. Default: false
373
379
  :param code_cov_token_secret: (experimental) Define the secret name for a specified https://codecov.io/ token. Default: - OIDC auth is used
380
+ :param codeql: Scan the code with CodeQL on pull requests, pushes to the default branch and weekly. Default: true
374
381
  :param commit_generated: (experimental) Whether to commit the managed files by default. Default: true
375
382
  :param config: (experimental) Configuration values available to package scripts at runtime. Values should be JSON-serializable. Default: - no package configuration
376
383
  :param constructs_version: (experimental) Minimum version of the ``constructs`` library to depend on. Default: - for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.5.1".
@@ -548,6 +555,7 @@ class CdkTypeScriptApp(
548
555
  code_artifact_options=code_artifact_options,
549
556
  code_cov=code_cov,
550
557
  code_cov_token_secret=code_cov_token_secret,
558
+ codeql=codeql,
551
559
  commit_generated=commit_generated,
552
560
  config=config,
553
561
  constructs_version=constructs_version,
@@ -744,6 +752,7 @@ class CdkTypeScriptApp(
744
752
  "code_artifact_options": "codeArtifactOptions",
745
753
  "code_cov": "codeCov",
746
754
  "code_cov_token_secret": "codeCovTokenSecret",
755
+ "codeql": "codeql",
747
756
  "commit_generated": "commitGenerated",
748
757
  "config": "config",
749
758
  "constructs_version": "constructsVersion",
@@ -925,6 +934,7 @@ class CdkTypeScriptAppOptions:
925
934
  code_artifact_options: typing.Optional[typing.Union["_projen_javascript_04054675.CodeArtifactOptions", typing.Dict[builtins.str, typing.Any]]] = None,
926
935
  code_cov: typing.Optional[builtins.bool] = None,
927
936
  code_cov_token_secret: typing.Optional[builtins.str] = None,
937
+ codeql: typing.Optional[builtins.bool] = None,
928
938
  commit_generated: typing.Optional[builtins.bool] = None,
929
939
  config: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
930
940
  constructs_version: typing.Optional[builtins.str] = None,
@@ -1103,6 +1113,7 @@ class CdkTypeScriptAppOptions:
1103
1113
  :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
1104
1114
  :param code_cov: (experimental) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. Uses codecov/codecov-action. By default, OIDC auth is used. Alternatively a token can be provided via ``codeCovTokenSecret``. Default: false
1105
1115
  :param code_cov_token_secret: (experimental) Define the secret name for a specified https://codecov.io/ token. Default: - OIDC auth is used
1116
+ :param codeql: Scan the code with CodeQL on pull requests, pushes to the default branch and weekly. Default: true
1106
1117
  :param commit_generated: (experimental) Whether to commit the managed files by default. Default: true
1107
1118
  :param config: (experimental) Configuration values available to package scripts at runtime. Values should be JSON-serializable. Default: - no package configuration
1108
1119
  :param constructs_version: (experimental) Minimum version of the ``constructs`` library to depend on. Default: - for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.5.1".
@@ -1349,6 +1360,7 @@ class CdkTypeScriptAppOptions:
1349
1360
  check_type(argname="argument code_artifact_options", value=code_artifact_options, expected_type=type_hints["code_artifact_options"])
1350
1361
  check_type(argname="argument code_cov", value=code_cov, expected_type=type_hints["code_cov"])
1351
1362
  check_type(argname="argument code_cov_token_secret", value=code_cov_token_secret, expected_type=type_hints["code_cov_token_secret"])
1363
+ check_type(argname="argument codeql", value=codeql, expected_type=type_hints["codeql"])
1352
1364
  check_type(argname="argument commit_generated", value=commit_generated, expected_type=type_hints["commit_generated"])
1353
1365
  check_type(argname="argument config", value=config, expected_type=type_hints["config"])
1354
1366
  check_type(argname="argument constructs_version", value=constructs_version, expected_type=type_hints["constructs_version"])
@@ -1563,6 +1575,8 @@ class CdkTypeScriptAppOptions:
1563
1575
  self._values["code_cov"] = code_cov
1564
1576
  if code_cov_token_secret is not None:
1565
1577
  self._values["code_cov_token_secret"] = code_cov_token_secret
1578
+ if codeql is not None:
1579
+ self._values["codeql"] = codeql
1566
1580
  if commit_generated is not None:
1567
1581
  self._values["commit_generated"] = commit_generated
1568
1582
  if config is not None:
@@ -2342,6 +2356,15 @@ class CdkTypeScriptAppOptions:
2342
2356
  result = self._values.get("code_cov_token_secret")
2343
2357
  return typing.cast(typing.Optional[builtins.str], result)
2344
2358
 
2359
+ @builtins.property
2360
+ def codeql(self) -> typing.Optional[builtins.bool]:
2361
+ '''Scan the code with CodeQL on pull requests, pushes to the default branch and weekly.
2362
+
2363
+ :default: true
2364
+ '''
2365
+ result = self._values.get("codeql")
2366
+ return typing.cast(typing.Optional[builtins.bool], result)
2367
+
2345
2368
  @builtins.property
2346
2369
  def commit_generated(self) -> typing.Optional[builtins.bool]:
2347
2370
  '''(experimental) Whether to commit the managed files by default.
@@ -4194,6 +4217,7 @@ class JsiiProject(
4194
4217
  code_artifact_options: typing.Optional[typing.Union["_projen_javascript_04054675.CodeArtifactOptions", typing.Dict[builtins.str, typing.Any]]] = None,
4195
4218
  code_cov: typing.Optional[builtins.bool] = None,
4196
4219
  code_cov_token_secret: typing.Optional[builtins.str] = None,
4220
+ codeql: typing.Optional[builtins.bool] = None,
4197
4221
  commit_generated: typing.Optional[builtins.bool] = None,
4198
4222
  compat: typing.Optional[builtins.bool] = None,
4199
4223
  compat_ignore: typing.Optional[builtins.str] = None,
@@ -4366,6 +4390,7 @@ class JsiiProject(
4366
4390
  :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
4367
4391
  :param code_cov: (experimental) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. Uses codecov/codecov-action. By default, OIDC auth is used. Alternatively a token can be provided via ``codeCovTokenSecret``. Default: false
4368
4392
  :param code_cov_token_secret: (experimental) Define the secret name for a specified https://codecov.io/ token. Default: - OIDC auth is used
4393
+ :param codeql: Scan the code with CodeQL on pull requests, pushes to the default branch and weekly. Default: true
4369
4394
  :param commit_generated: (experimental) Whether to commit the managed files by default. Default: true
4370
4395
  :param compat: (experimental) Automatically run API compatibility test against the latest version published to npm after compilation. - You can manually run compatibility tests using ``yarn compat`` if this feature is disabled. - You can ignore compatibility failures by adding lines to a ".compatignore" file. Default: false
4371
4396
  :param compat_ignore: (experimental) Name of the ignore file for API compatibility tests. Default: ".compatignore"
@@ -4538,6 +4563,7 @@ class JsiiProject(
4538
4563
  code_artifact_options=code_artifact_options,
4539
4564
  code_cov=code_cov,
4540
4565
  code_cov_token_secret=code_cov_token_secret,
4566
+ codeql=codeql,
4541
4567
  commit_generated=commit_generated,
4542
4568
  compat=compat,
4543
4569
  compat_ignore=compat_ignore,
@@ -4729,6 +4755,7 @@ class JsiiProject(
4729
4755
  "code_artifact_options": "codeArtifactOptions",
4730
4756
  "code_cov": "codeCov",
4731
4757
  "code_cov_token_secret": "codeCovTokenSecret",
4758
+ "codeql": "codeql",
4732
4759
  "commit_generated": "commitGenerated",
4733
4760
  "compat": "compat",
4734
4761
  "compat_ignore": "compatIgnore",
@@ -4905,6 +4932,7 @@ class JsiiProjectOptions:
4905
4932
  code_artifact_options: typing.Optional[typing.Union["_projen_javascript_04054675.CodeArtifactOptions", typing.Dict[builtins.str, typing.Any]]] = None,
4906
4933
  code_cov: typing.Optional[builtins.bool] = None,
4907
4934
  code_cov_token_secret: typing.Optional[builtins.str] = None,
4935
+ codeql: typing.Optional[builtins.bool] = None,
4908
4936
  commit_generated: typing.Optional[builtins.bool] = None,
4909
4937
  compat: typing.Optional[builtins.bool] = None,
4910
4938
  compat_ignore: typing.Optional[builtins.str] = None,
@@ -5078,6 +5106,7 @@ class JsiiProjectOptions:
5078
5106
  :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
5079
5107
  :param code_cov: (experimental) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. Uses codecov/codecov-action. By default, OIDC auth is used. Alternatively a token can be provided via ``codeCovTokenSecret``. Default: false
5080
5108
  :param code_cov_token_secret: (experimental) Define the secret name for a specified https://codecov.io/ token. Default: - OIDC auth is used
5109
+ :param codeql: Scan the code with CodeQL on pull requests, pushes to the default branch and weekly. Default: true
5081
5110
  :param commit_generated: (experimental) Whether to commit the managed files by default. Default: true
5082
5111
  :param compat: (experimental) Automatically run API compatibility test against the latest version published to npm after compilation. - You can manually run compatibility tests using ``yarn compat`` if this feature is disabled. - You can ignore compatibility failures by adding lines to a ".compatignore" file. Default: false
5083
5112
  :param compat_ignore: (experimental) Name of the ignore file for API compatibility tests. Default: ".compatignore"
@@ -5325,6 +5354,7 @@ class JsiiProjectOptions:
5325
5354
  check_type(argname="argument code_artifact_options", value=code_artifact_options, expected_type=type_hints["code_artifact_options"])
5326
5355
  check_type(argname="argument code_cov", value=code_cov, expected_type=type_hints["code_cov"])
5327
5356
  check_type(argname="argument code_cov_token_secret", value=code_cov_token_secret, expected_type=type_hints["code_cov_token_secret"])
5357
+ check_type(argname="argument codeql", value=codeql, expected_type=type_hints["codeql"])
5328
5358
  check_type(argname="argument commit_generated", value=commit_generated, expected_type=type_hints["commit_generated"])
5329
5359
  check_type(argname="argument compat", value=compat, expected_type=type_hints["compat"])
5330
5360
  check_type(argname="argument compat_ignore", value=compat_ignore, expected_type=type_hints["compat_ignore"])
@@ -5528,6 +5558,8 @@ class JsiiProjectOptions:
5528
5558
  self._values["code_cov"] = code_cov
5529
5559
  if code_cov_token_secret is not None:
5530
5560
  self._values["code_cov_token_secret"] = code_cov_token_secret
5561
+ if codeql is not None:
5562
+ self._values["codeql"] = codeql
5531
5563
  if commit_generated is not None:
5532
5564
  self._values["commit_generated"] = commit_generated
5533
5565
  if compat is not None:
@@ -6251,6 +6283,15 @@ class JsiiProjectOptions:
6251
6283
  result = self._values.get("code_cov_token_secret")
6252
6284
  return typing.cast(typing.Optional[builtins.str], result)
6253
6285
 
6286
+ @builtins.property
6287
+ def codeql(self) -> typing.Optional[builtins.bool]:
6288
+ '''Scan the code with CodeQL on pull requests, pushes to the default branch and weekly.
6289
+
6290
+ :default: true
6291
+ '''
6292
+ result = self._values.get("codeql")
6293
+ return typing.cast(typing.Optional[builtins.bool], result)
6294
+
6254
6295
  @builtins.property
6255
6296
  def commit_generated(self) -> typing.Optional[builtins.bool]:
6256
6297
  '''(experimental) Whether to commit the managed files by default.
@@ -11558,6 +11599,7 @@ class PythonPackage(
11558
11599
  auto_merge_options: typing.Optional[typing.Union["_projen_github_04054675.AutoMergeOptions", typing.Dict[builtins.str, typing.Any]]] = None,
11559
11600
  classifiers: typing.Optional[typing.Sequence[builtins.str]] = None,
11560
11601
  clobber: typing.Optional[builtins.bool] = None,
11602
+ codeql: typing.Optional[builtins.bool] = None,
11561
11603
  commit_generated: typing.Optional[builtins.bool] = None,
11562
11604
  deps: typing.Optional[typing.Sequence[builtins.str]] = None,
11563
11605
  description: typing.Optional[builtins.str] = None,
@@ -11620,6 +11662,7 @@ class PythonPackage(
11620
11662
  :param auto_merge_options: (experimental) Configure options for automatic merging on GitHub. Has no effect if ``github.mergify`` or ``autoMerge`` is set to false. Default: - see defaults in ``AutoMergeOptions``
11621
11663
  :param classifiers: (experimental) A list of PyPI trove classifiers that describe the project.
11622
11664
  :param clobber: (experimental) Add a ``clobber`` task which resets the repo to origin. Default: - true, but false for subprojects
11665
+ :param codeql: Scan the code with CodeQL on pull requests, pushes to the default branch and weekly. Default: true
11623
11666
  :param commit_generated: (experimental) Whether to commit the managed files by default. Default: true
11624
11667
  :param deps: (experimental) List of runtime dependencies for this project. Dependencies use the format: ``<module>@<semver>``. Additional dependencies can be added via ``project.addDependency()``. Default: []
11625
11668
  :param description: (experimental) A short description of the package.
@@ -11682,6 +11725,7 @@ class PythonPackage(
11682
11725
  auto_merge_options=auto_merge_options,
11683
11726
  classifiers=classifiers,
11684
11727
  clobber=clobber,
11728
+ codeql=codeql,
11685
11729
  commit_generated=commit_generated,
11686
11730
  deps=deps,
11687
11731
  description=description,
@@ -11768,6 +11812,7 @@ class PythonPackage(
11768
11812
  "auto_merge_options": "autoMergeOptions",
11769
11813
  "classifiers": "classifiers",
11770
11814
  "clobber": "clobber",
11815
+ "codeql": "codeql",
11771
11816
  "commit_generated": "commitGenerated",
11772
11817
  "deps": "deps",
11773
11818
  "description": "description",
@@ -11834,6 +11879,7 @@ class PythonPackageOptions:
11834
11879
  auto_merge_options: typing.Optional[typing.Union["_projen_github_04054675.AutoMergeOptions", typing.Dict[builtins.str, typing.Any]]] = None,
11835
11880
  classifiers: typing.Optional[typing.Sequence[builtins.str]] = None,
11836
11881
  clobber: typing.Optional[builtins.bool] = None,
11882
+ codeql: typing.Optional[builtins.bool] = None,
11837
11883
  commit_generated: typing.Optional[builtins.bool] = None,
11838
11884
  deps: typing.Optional[typing.Sequence[builtins.str]] = None,
11839
11885
  description: typing.Optional[builtins.str] = None,
@@ -11897,6 +11943,7 @@ class PythonPackageOptions:
11897
11943
  :param auto_merge_options: (experimental) Configure options for automatic merging on GitHub. Has no effect if ``github.mergify`` or ``autoMerge`` is set to false. Default: - see defaults in ``AutoMergeOptions``
11898
11944
  :param classifiers: (experimental) A list of PyPI trove classifiers that describe the project.
11899
11945
  :param clobber: (experimental) Add a ``clobber`` task which resets the repo to origin. Default: - true, but false for subprojects
11946
+ :param codeql: Scan the code with CodeQL on pull requests, pushes to the default branch and weekly. Default: true
11900
11947
  :param commit_generated: (experimental) Whether to commit the managed files by default. Default: true
11901
11948
  :param deps: (experimental) List of runtime dependencies for this project. Dependencies use the format: ``<module>@<semver>``. Additional dependencies can be added via ``project.addDependency()``. Default: []
11902
11949
  :param description: (experimental) A short description of the package.
@@ -11994,6 +12041,7 @@ class PythonPackageOptions:
11994
12041
  check_type(argname="argument auto_merge_options", value=auto_merge_options, expected_type=type_hints["auto_merge_options"])
11995
12042
  check_type(argname="argument classifiers", value=classifiers, expected_type=type_hints["classifiers"])
11996
12043
  check_type(argname="argument clobber", value=clobber, expected_type=type_hints["clobber"])
12044
+ check_type(argname="argument codeql", value=codeql, expected_type=type_hints["codeql"])
11997
12045
  check_type(argname="argument commit_generated", value=commit_generated, expected_type=type_hints["commit_generated"])
11998
12046
  check_type(argname="argument deps", value=deps, expected_type=type_hints["deps"])
11999
12047
  check_type(argname="argument description", value=description, expected_type=type_hints["description"])
@@ -12061,6 +12109,8 @@ class PythonPackageOptions:
12061
12109
  self._values["classifiers"] = classifiers
12062
12110
  if clobber is not None:
12063
12111
  self._values["clobber"] = clobber
12112
+ if codeql is not None:
12113
+ self._values["codeql"] = codeql
12064
12114
  if commit_generated is not None:
12065
12115
  self._values["commit_generated"] = commit_generated
12066
12116
  if deps is not None:
@@ -12294,6 +12344,15 @@ class PythonPackageOptions:
12294
12344
  result = self._values.get("clobber")
12295
12345
  return typing.cast(typing.Optional[builtins.bool], result)
12296
12346
 
12347
+ @builtins.property
12348
+ def codeql(self) -> typing.Optional[builtins.bool]:
12349
+ '''Scan the code with CodeQL on pull requests, pushes to the default branch and weekly.
12350
+
12351
+ :default: true
12352
+ '''
12353
+ result = self._values.get("codeql")
12354
+ return typing.cast(typing.Optional[builtins.bool], result)
12355
+
12297
12356
  @builtins.property
12298
12357
  def commit_generated(self) -> typing.Optional[builtins.bool]:
12299
12358
  '''(experimental) Whether to commit the managed files by default.
@@ -13076,6 +13135,7 @@ def _typecheckingstub__3a6354f4c0532263f309ca59025d89b070b95588f76bd5815340cc71a
13076
13135
  code_artifact_options: typing.Optional[typing.Union[_projen_javascript_04054675.CodeArtifactOptions, typing.Dict[builtins.str, typing.Any]]] = None,
13077
13136
  code_cov: typing.Optional[builtins.bool] = None,
13078
13137
  code_cov_token_secret: typing.Optional[builtins.str] = None,
13138
+ codeql: typing.Optional[builtins.bool] = None,
13079
13139
  commit_generated: typing.Optional[builtins.bool] = None,
13080
13140
  config: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
13081
13141
  constructs_version: typing.Optional[builtins.str] = None,
@@ -13271,6 +13331,7 @@ def _typecheckingstub__bcc0f0f3d874afabc142961b7ca192083fcad906385166f2e47f7e739
13271
13331
  code_artifact_options: typing.Optional[typing.Union[_projen_javascript_04054675.CodeArtifactOptions, typing.Dict[builtins.str, typing.Any]]] = None,
13272
13332
  code_cov: typing.Optional[builtins.bool] = None,
13273
13333
  code_cov_token_secret: typing.Optional[builtins.str] = None,
13334
+ codeql: typing.Optional[builtins.bool] = None,
13274
13335
  commit_generated: typing.Optional[builtins.bool] = None,
13275
13336
  compat: typing.Optional[builtins.bool] = None,
13276
13337
  compat_ignore: typing.Optional[builtins.str] = None,
@@ -13595,6 +13656,7 @@ def _typecheckingstub__882525f8fb69251a060fbbe97c2383313ea4b9c0269874cb1d13172a5
13595
13656
  auto_merge_options: typing.Optional[typing.Union[_projen_github_04054675.AutoMergeOptions, typing.Dict[builtins.str, typing.Any]]] = None,
13596
13657
  classifiers: typing.Optional[typing.Sequence[builtins.str]] = None,
13597
13658
  clobber: typing.Optional[builtins.bool] = None,
13659
+ codeql: typing.Optional[builtins.bool] = None,
13598
13660
  commit_generated: typing.Optional[builtins.bool] = None,
13599
13661
  deps: typing.Optional[typing.Sequence[builtins.str]] = None,
13600
13662
  description: typing.Optional[builtins.str] = None,
@@ -18,7 +18,7 @@ import constructs._jsii
18
18
  import projen._jsii
19
19
 
20
20
  __jsii_assembly__ = jsii.JSIIAssembly.load(
21
- "projen-modules", "3.1.0", __name__[0:-6], "projen-modules@3.1.0.jsii.tgz"
21
+ "projen-modules", "3.2.1", __name__[0:-6], "projen-modules@3.2.1.jsii.tgz"
22
22
  )
23
23
 
24
24
  __all__ = [
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: projen_modules
3
- Version: 3.1.0
3
+ Version: 3.2.1
4
4
  Summary: A collection of projen modules
5
5
  Home-page: https://github.com/daveshepherd/projen-modules.git
6
6
  Author: Dave Shepherd<dave.shepherd@endor.me.uk>
@@ -73,6 +73,10 @@ In **Settings → General → Pull Requests**:
73
73
  * Untick **Allow auto-merge**, because GitHub's own auto-merge merges outside the queue.
74
74
  * Tick **Automatically delete head branches**.
75
75
 
76
+ ### Code scanning
77
+
78
+ CodeQL runs from `.github/workflows/codeql.yml`, which is managed by projen. In **Settings → Advanced Security**, leave CodeQL **Default setup** off, because it cannot run alongside this workflow. Under **Protection rules**, keep the **Check run failure threshold** at **High or higher** for security alerts and **Errors** for other alerts, as this decides whether the `CodeQL` check fails. Private repositories also need GitHub Code Security enabled there for code scanning results to be uploaded.
79
+
76
80
  ### Branch ruleset
77
81
 
78
82
  In **Settings → Rules → Rulesets**, create a branch ruleset with enforcement **Active** that targets the default branch, and set:
@@ -82,6 +86,7 @@ In **Settings → Rules → Rulesets**, create a branch ruleset with enforcement
82
86
  * **Restrict deletions** and **Block force pushes**.
83
87
  * **Require a pull request before merging**, with 0 required approvals.
84
88
  * **Require status checks to pass**, listing the checks that `.mergify.yml` waits for: `build`, `package-js`, `package-python`. Leave **Require branches to be up to date before merging** unticked, as the queue already updates and retests each pull request.
89
+ * **Require code scanning results**, with the tool **CodeQL**, security alerts set to **High or higher** and alerts set to **Errors**. Mergify is exempt from this rule, so `.mergify.yml` also waits for the `CodeQL` check instead.
85
90
 
86
91
  Do not enable GitHub's own **Require merge queue** rule, as it competes with Mergify.
87
92
 
@@ -11,4 +11,4 @@ src/projen_modules.egg-info/dependency_links.txt
11
11
  src/projen_modules.egg-info/requires.txt
12
12
  src/projen_modules.egg-info/top_level.txt
13
13
  src/projen_modules/_jsii/__init__.py
14
- src/projen_modules/_jsii/projen-modules@3.1.0.jsii.tgz
14
+ src/projen_modules/_jsii/projen-modules@3.2.1.jsii.tgz
File without changes
File without changes