projen-modules 3.0.2__tar.gz → 3.2.0__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.0.2
3
+ Version: 3.2.0
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>
@@ -55,6 +55,43 @@ Types of testing:
55
55
  * Snapshot - projen project outputs are stored as a snapshot in the corresponding `__snapshots__` directory. When the project changes then it is expected that these snapshots change too and should be reviewed committed alongside the project.
56
56
  * Unit tests - these assert on specific functionality of the project and should be written for any new functionality added.
57
57
 
58
+ ## GitHub Configuration
59
+
60
+ All pull requests are merged by the [Mergify](https://mergify.com) merge queue, configured in `.mergify.yml`. Once a pull request's checks pass, Mergify queues it, brings it up to date with the default branch, waits for the checks again and squash merges it. Draft pull requests and those labelled `do-not-merge` are not merged.
61
+
62
+ The repository must be configured as below so that nothing can be merged without going through the queue.
63
+
64
+ ### Mergify
65
+
66
+ Install the [Mergify GitHub App](https://github.com/apps/mergify) and give it access to this repository.
67
+
68
+ ### Pull request settings
69
+
70
+ In **Settings → General → Pull Requests**:
71
+
72
+ * Allow squash merging only (untick merge commits and rebase merging), matching the queue's merge method.
73
+ * Untick **Allow auto-merge**, because GitHub's own auto-merge merges outside the queue.
74
+ * Tick **Automatically delete head branches**.
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
+
80
+ ### Branch ruleset
81
+
82
+ In **Settings → Rules → Rulesets**, create a branch ruleset with enforcement **Active** that targets the default branch, and set:
83
+
84
+ * **Bypass list**: the **Mergify** app only, in **Exempt** mode. Do not add admins or other roles, as anyone on this list can merge without the queue.
85
+ * **Restrict updates**: only bypass actors can update the branch, so pull requests cannot be merged from the GitHub UI or CLI and commits cannot be pushed directly.
86
+ * **Restrict deletions** and **Block force pushes**.
87
+ * **Require a pull request before merging**, with 0 required approvals.
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.
90
+
91
+ Do not enable GitHub's own **Require merge queue** rule, as it competes with Mergify.
92
+
93
+ If the queue is unavailable and a change has to be merged, add yourself to the bypass list temporarily and remove yourself afterwards.
94
+
58
95
  ## Creating a New Project
59
96
 
60
97
  ```
@@ -0,0 +1,92 @@
1
+ # projen-modules
2
+
3
+ A collection of custom projen modules, that can be used to bootstrap and maintain consistent project configuration, tooling, dependencies, and builds.
4
+
5
+ ## Getting Started
6
+
7
+ ```sh
8
+ yarn install
9
+ npx projen build
10
+ ```
11
+
12
+ This will:
13
+
14
+ * Install the dependencies
15
+ * Apply any projen changes
16
+ * Run tests
17
+ * Package project locally
18
+
19
+ Any files changed by projen should be committed to git.
20
+
21
+ Running the tests like this will update any snapshot files, this should be reviewed and committed to git.
22
+
23
+ ## Testing
24
+
25
+ Types of testing:
26
+
27
+ * Snapshot - projen project outputs are stored as a snapshot in the corresponding `__snapshots__` directory. When the project changes then it is expected that these snapshots change too and should be reviewed committed alongside the project.
28
+ * Unit tests - these assert on specific functionality of the project and should be written for any new functionality added.
29
+
30
+ ## GitHub Configuration
31
+
32
+ All pull requests are merged by the [Mergify](https://mergify.com) merge queue, configured in `.mergify.yml`. Once a pull request's checks pass, Mergify queues it, brings it up to date with the default branch, waits for the checks again and squash merges it. Draft pull requests and those labelled `do-not-merge` are not merged.
33
+
34
+ The repository must be configured as below so that nothing can be merged without going through the queue.
35
+
36
+ ### Mergify
37
+
38
+ Install the [Mergify GitHub App](https://github.com/apps/mergify) and give it access to this repository.
39
+
40
+ ### Pull request settings
41
+
42
+ In **Settings → General → Pull Requests**:
43
+
44
+ * Allow squash merging only (untick merge commits and rebase merging), matching the queue's merge method.
45
+ * Untick **Allow auto-merge**, because GitHub's own auto-merge merges outside the queue.
46
+ * Tick **Automatically delete head branches**.
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
+
52
+ ### Branch ruleset
53
+
54
+ In **Settings → Rules → Rulesets**, create a branch ruleset with enforcement **Active** that targets the default branch, and set:
55
+
56
+ * **Bypass list**: the **Mergify** app only, in **Exempt** mode. Do not add admins or other roles, as anyone on this list can merge without the queue.
57
+ * **Restrict updates**: only bypass actors can update the branch, so pull requests cannot be merged from the GitHub UI or CLI and commits cannot be pushed directly.
58
+ * **Restrict deletions** and **Block force pushes**.
59
+ * **Require a pull request before merging**, with 0 required approvals.
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.
62
+
63
+ Do not enable GitHub's own **Require merge queue** rule, as it competes with Mergify.
64
+
65
+ If the queue is unavailable and a change has to be merged, add yourself to the bypass list temporarily and remove yourself afterwards.
66
+
67
+ ## Creating a New Project
68
+
69
+ ```
70
+ npx projen new {project} --from projen-modules
71
+ ```
72
+
73
+ Some projects may have required fields that need to be specified as part of this command, review any errors for details what needs to be specified.
74
+
75
+ ### Project Types
76
+
77
+ | Project type | Description |
78
+ | ---------------------------------------------- | -------------------------- |
79
+ | [cdk-typescript-app](API.md#cdktypescriptapp-) | A typescript CDK app |
80
+ | [npm-package](API.md#npmpackage-) | A typescript npm package |
81
+ | [python-package](API.md#pythonpackage-) | A python package |
82
+ | [jsii-package](API.md#jsiiproject-) | A typescript JSII package |
83
+
84
+ ## Project Structure
85
+
86
+ All source is located in `src` and is grouped by:
87
+
88
+ * `components` - these are common building blocks that can be used by projects to implement specific project functionality.
89
+ * `projects` - these are projects that can be built from this project (see #something)
90
+ * `utils` - these are helper functions that are often reused
91
+
92
+ `test` contains tests, and mirrors the `src` directory structure. Within here there are `__snapshots__` which contain snapshots of project tests (see #section).
@@ -5,7 +5,7 @@ kwargs = json.loads(
5
5
  """
6
6
  {
7
7
  "name": "projen_modules",
8
- "version": "3.0.2",
8
+ "version": "3.2.0",
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.0.2.jsii.tgz"
29
+ "projen-modules@3.2.0.jsii.tgz"
30
30
  ],
31
31
  "projen_modules": [
32
32
  "py.typed"
@@ -28,6 +28,43 @@ Types of testing:
28
28
  * Snapshot - projen project outputs are stored as a snapshot in the corresponding `__snapshots__` directory. When the project changes then it is expected that these snapshots change too and should be reviewed committed alongside the project.
29
29
  * Unit tests - these assert on specific functionality of the project and should be written for any new functionality added.
30
30
 
31
+ ## GitHub Configuration
32
+
33
+ All pull requests are merged by the [Mergify](https://mergify.com) merge queue, configured in `.mergify.yml`. Once a pull request's checks pass, Mergify queues it, brings it up to date with the default branch, waits for the checks again and squash merges it. Draft pull requests and those labelled `do-not-merge` are not merged.
34
+
35
+ The repository must be configured as below so that nothing can be merged without going through the queue.
36
+
37
+ ### Mergify
38
+
39
+ Install the [Mergify GitHub App](https://github.com/apps/mergify) and give it access to this repository.
40
+
41
+ ### Pull request settings
42
+
43
+ In **Settings → General → Pull Requests**:
44
+
45
+ * Allow squash merging only (untick merge commits and rebase merging), matching the queue's merge method.
46
+ * Untick **Allow auto-merge**, because GitHub's own auto-merge merges outside the queue.
47
+ * Tick **Automatically delete head branches**.
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
+
53
+ ### Branch ruleset
54
+
55
+ In **Settings → Rules → Rulesets**, create a branch ruleset with enforcement **Active** that targets the default branch, and set:
56
+
57
+ * **Bypass list**: the **Mergify** app only, in **Exempt** mode. Do not add admins or other roles, as anyone on this list can merge without the queue.
58
+ * **Restrict updates**: only bypass actors can update the branch, so pull requests cannot be merged from the GitHub UI or CLI and commits cannot be pushed directly.
59
+ * **Restrict deletions** and **Block force pushes**.
60
+ * **Require a pull request before merging**, with 0 required approvals.
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.
63
+
64
+ Do not enable GitHub's own **Require merge queue** rule, as it competes with Mergify.
65
+
66
+ If the queue is unavailable and a change has to be merged, add yourself to the bypass list temporarily and remove yourself afterwards.
67
+
31
68
  ## Creating a New Project
32
69
 
33
70
  ```
@@ -162,6 +199,7 @@ class CdkTypeScriptApp(
162
199
  code_artifact_options: typing.Optional[typing.Union["_projen_javascript_04054675.CodeArtifactOptions", typing.Dict[builtins.str, typing.Any]]] = None,
163
200
  code_cov: typing.Optional[builtins.bool] = None,
164
201
  code_cov_token_secret: typing.Optional[builtins.str] = None,
202
+ codeql: typing.Optional[builtins.bool] = None,
165
203
  commit_generated: typing.Optional[builtins.bool] = None,
166
204
  config: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
167
205
  constructs_version: typing.Optional[builtins.str] = None,
@@ -339,6 +377,7 @@ class CdkTypeScriptApp(
339
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
340
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
341
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
342
381
  :param commit_generated: (experimental) Whether to commit the managed files by default. Default: true
343
382
  :param config: (experimental) Configuration values available to package scripts at runtime. Values should be JSON-serializable. Default: - no package configuration
344
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".
@@ -516,6 +555,7 @@ class CdkTypeScriptApp(
516
555
  code_artifact_options=code_artifact_options,
517
556
  code_cov=code_cov,
518
557
  code_cov_token_secret=code_cov_token_secret,
558
+ codeql=codeql,
519
559
  commit_generated=commit_generated,
520
560
  config=config,
521
561
  constructs_version=constructs_version,
@@ -712,6 +752,7 @@ class CdkTypeScriptApp(
712
752
  "code_artifact_options": "codeArtifactOptions",
713
753
  "code_cov": "codeCov",
714
754
  "code_cov_token_secret": "codeCovTokenSecret",
755
+ "codeql": "codeql",
715
756
  "commit_generated": "commitGenerated",
716
757
  "config": "config",
717
758
  "constructs_version": "constructsVersion",
@@ -893,6 +934,7 @@ class CdkTypeScriptAppOptions:
893
934
  code_artifact_options: typing.Optional[typing.Union["_projen_javascript_04054675.CodeArtifactOptions", typing.Dict[builtins.str, typing.Any]]] = None,
894
935
  code_cov: typing.Optional[builtins.bool] = None,
895
936
  code_cov_token_secret: typing.Optional[builtins.str] = None,
937
+ codeql: typing.Optional[builtins.bool] = None,
896
938
  commit_generated: typing.Optional[builtins.bool] = None,
897
939
  config: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
898
940
  constructs_version: typing.Optional[builtins.str] = None,
@@ -1071,6 +1113,7 @@ class CdkTypeScriptAppOptions:
1071
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
1072
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
1073
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
1074
1117
  :param commit_generated: (experimental) Whether to commit the managed files by default. Default: true
1075
1118
  :param config: (experimental) Configuration values available to package scripts at runtime. Values should be JSON-serializable. Default: - no package configuration
1076
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".
@@ -1317,6 +1360,7 @@ class CdkTypeScriptAppOptions:
1317
1360
  check_type(argname="argument code_artifact_options", value=code_artifact_options, expected_type=type_hints["code_artifact_options"])
1318
1361
  check_type(argname="argument code_cov", value=code_cov, expected_type=type_hints["code_cov"])
1319
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"])
1320
1364
  check_type(argname="argument commit_generated", value=commit_generated, expected_type=type_hints["commit_generated"])
1321
1365
  check_type(argname="argument config", value=config, expected_type=type_hints["config"])
1322
1366
  check_type(argname="argument constructs_version", value=constructs_version, expected_type=type_hints["constructs_version"])
@@ -1531,6 +1575,8 @@ class CdkTypeScriptAppOptions:
1531
1575
  self._values["code_cov"] = code_cov
1532
1576
  if code_cov_token_secret is not None:
1533
1577
  self._values["code_cov_token_secret"] = code_cov_token_secret
1578
+ if codeql is not None:
1579
+ self._values["codeql"] = codeql
1534
1580
  if commit_generated is not None:
1535
1581
  self._values["commit_generated"] = commit_generated
1536
1582
  if config is not None:
@@ -2310,6 +2356,15 @@ class CdkTypeScriptAppOptions:
2310
2356
  result = self._values.get("code_cov_token_secret")
2311
2357
  return typing.cast(typing.Optional[builtins.str], result)
2312
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
+
2313
2368
  @builtins.property
2314
2369
  def commit_generated(self) -> typing.Optional[builtins.bool]:
2315
2370
  '''(experimental) Whether to commit the managed files by default.
@@ -4162,6 +4217,7 @@ class JsiiProject(
4162
4217
  code_artifact_options: typing.Optional[typing.Union["_projen_javascript_04054675.CodeArtifactOptions", typing.Dict[builtins.str, typing.Any]]] = None,
4163
4218
  code_cov: typing.Optional[builtins.bool] = None,
4164
4219
  code_cov_token_secret: typing.Optional[builtins.str] = None,
4220
+ codeql: typing.Optional[builtins.bool] = None,
4165
4221
  commit_generated: typing.Optional[builtins.bool] = None,
4166
4222
  compat: typing.Optional[builtins.bool] = None,
4167
4223
  compat_ignore: typing.Optional[builtins.str] = None,
@@ -4334,6 +4390,7 @@ class JsiiProject(
4334
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
4335
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
4336
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
4337
4394
  :param commit_generated: (experimental) Whether to commit the managed files by default. Default: true
4338
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
4339
4396
  :param compat_ignore: (experimental) Name of the ignore file for API compatibility tests. Default: ".compatignore"
@@ -4506,6 +4563,7 @@ class JsiiProject(
4506
4563
  code_artifact_options=code_artifact_options,
4507
4564
  code_cov=code_cov,
4508
4565
  code_cov_token_secret=code_cov_token_secret,
4566
+ codeql=codeql,
4509
4567
  commit_generated=commit_generated,
4510
4568
  compat=compat,
4511
4569
  compat_ignore=compat_ignore,
@@ -4697,6 +4755,7 @@ class JsiiProject(
4697
4755
  "code_artifact_options": "codeArtifactOptions",
4698
4756
  "code_cov": "codeCov",
4699
4757
  "code_cov_token_secret": "codeCovTokenSecret",
4758
+ "codeql": "codeql",
4700
4759
  "commit_generated": "commitGenerated",
4701
4760
  "compat": "compat",
4702
4761
  "compat_ignore": "compatIgnore",
@@ -4873,6 +4932,7 @@ class JsiiProjectOptions:
4873
4932
  code_artifact_options: typing.Optional[typing.Union["_projen_javascript_04054675.CodeArtifactOptions", typing.Dict[builtins.str, typing.Any]]] = None,
4874
4933
  code_cov: typing.Optional[builtins.bool] = None,
4875
4934
  code_cov_token_secret: typing.Optional[builtins.str] = None,
4935
+ codeql: typing.Optional[builtins.bool] = None,
4876
4936
  commit_generated: typing.Optional[builtins.bool] = None,
4877
4937
  compat: typing.Optional[builtins.bool] = None,
4878
4938
  compat_ignore: typing.Optional[builtins.str] = None,
@@ -5046,6 +5106,7 @@ class JsiiProjectOptions:
5046
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
5047
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
5048
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
5049
5110
  :param commit_generated: (experimental) Whether to commit the managed files by default. Default: true
5050
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
5051
5112
  :param compat_ignore: (experimental) Name of the ignore file for API compatibility tests. Default: ".compatignore"
@@ -5293,6 +5354,7 @@ class JsiiProjectOptions:
5293
5354
  check_type(argname="argument code_artifact_options", value=code_artifact_options, expected_type=type_hints["code_artifact_options"])
5294
5355
  check_type(argname="argument code_cov", value=code_cov, expected_type=type_hints["code_cov"])
5295
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"])
5296
5358
  check_type(argname="argument commit_generated", value=commit_generated, expected_type=type_hints["commit_generated"])
5297
5359
  check_type(argname="argument compat", value=compat, expected_type=type_hints["compat"])
5298
5360
  check_type(argname="argument compat_ignore", value=compat_ignore, expected_type=type_hints["compat_ignore"])
@@ -5496,6 +5558,8 @@ class JsiiProjectOptions:
5496
5558
  self._values["code_cov"] = code_cov
5497
5559
  if code_cov_token_secret is not None:
5498
5560
  self._values["code_cov_token_secret"] = code_cov_token_secret
5561
+ if codeql is not None:
5562
+ self._values["codeql"] = codeql
5499
5563
  if commit_generated is not None:
5500
5564
  self._values["commit_generated"] = commit_generated
5501
5565
  if compat is not None:
@@ -6219,6 +6283,15 @@ class JsiiProjectOptions:
6219
6283
  result = self._values.get("code_cov_token_secret")
6220
6284
  return typing.cast(typing.Optional[builtins.str], result)
6221
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
+
6222
6295
  @builtins.property
6223
6296
  def commit_generated(self) -> typing.Optional[builtins.bool]:
6224
6297
  '''(experimental) Whether to commit the managed files by default.
@@ -11526,6 +11599,7 @@ class PythonPackage(
11526
11599
  auto_merge_options: typing.Optional[typing.Union["_projen_github_04054675.AutoMergeOptions", typing.Dict[builtins.str, typing.Any]]] = None,
11527
11600
  classifiers: typing.Optional[typing.Sequence[builtins.str]] = None,
11528
11601
  clobber: typing.Optional[builtins.bool] = None,
11602
+ codeql: typing.Optional[builtins.bool] = None,
11529
11603
  commit_generated: typing.Optional[builtins.bool] = None,
11530
11604
  deps: typing.Optional[typing.Sequence[builtins.str]] = None,
11531
11605
  description: typing.Optional[builtins.str] = None,
@@ -11588,6 +11662,7 @@ class PythonPackage(
11588
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``
11589
11663
  :param classifiers: (experimental) A list of PyPI trove classifiers that describe the project.
11590
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
11591
11666
  :param commit_generated: (experimental) Whether to commit the managed files by default. Default: true
11592
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: []
11593
11668
  :param description: (experimental) A short description of the package.
@@ -11650,6 +11725,7 @@ class PythonPackage(
11650
11725
  auto_merge_options=auto_merge_options,
11651
11726
  classifiers=classifiers,
11652
11727
  clobber=clobber,
11728
+ codeql=codeql,
11653
11729
  commit_generated=commit_generated,
11654
11730
  deps=deps,
11655
11731
  description=description,
@@ -11703,6 +11779,11 @@ class PythonPackage(
11703
11779
 
11704
11780
  jsii.create(self.__class__, self, [options])
11705
11781
 
11782
+ @builtins.property
11783
+ @jsii.member(jsii_name="autoMerge")
11784
+ def auto_merge(self) -> typing.Optional["_projen_github_04054675.AutoMerge"]:
11785
+ return typing.cast(typing.Optional["_projen_github_04054675.AutoMerge"], jsii.get(self, "autoMerge"))
11786
+
11706
11787
  @builtins.property
11707
11788
  @jsii.member(jsii_name="readme")
11708
11789
  def readme(self) -> "Readme":
@@ -11731,6 +11812,7 @@ class PythonPackage(
11731
11812
  "auto_merge_options": "autoMergeOptions",
11732
11813
  "classifiers": "classifiers",
11733
11814
  "clobber": "clobber",
11815
+ "codeql": "codeql",
11734
11816
  "commit_generated": "commitGenerated",
11735
11817
  "deps": "deps",
11736
11818
  "description": "description",
@@ -11797,6 +11879,7 @@ class PythonPackageOptions:
11797
11879
  auto_merge_options: typing.Optional[typing.Union["_projen_github_04054675.AutoMergeOptions", typing.Dict[builtins.str, typing.Any]]] = None,
11798
11880
  classifiers: typing.Optional[typing.Sequence[builtins.str]] = None,
11799
11881
  clobber: typing.Optional[builtins.bool] = None,
11882
+ codeql: typing.Optional[builtins.bool] = None,
11800
11883
  commit_generated: typing.Optional[builtins.bool] = None,
11801
11884
  deps: typing.Optional[typing.Sequence[builtins.str]] = None,
11802
11885
  description: typing.Optional[builtins.str] = None,
@@ -11860,6 +11943,7 @@ class PythonPackageOptions:
11860
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``
11861
11944
  :param classifiers: (experimental) A list of PyPI trove classifiers that describe the project.
11862
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
11863
11947
  :param commit_generated: (experimental) Whether to commit the managed files by default. Default: true
11864
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: []
11865
11949
  :param description: (experimental) A short description of the package.
@@ -11957,6 +12041,7 @@ class PythonPackageOptions:
11957
12041
  check_type(argname="argument auto_merge_options", value=auto_merge_options, expected_type=type_hints["auto_merge_options"])
11958
12042
  check_type(argname="argument classifiers", value=classifiers, expected_type=type_hints["classifiers"])
11959
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"])
11960
12045
  check_type(argname="argument commit_generated", value=commit_generated, expected_type=type_hints["commit_generated"])
11961
12046
  check_type(argname="argument deps", value=deps, expected_type=type_hints["deps"])
11962
12047
  check_type(argname="argument description", value=description, expected_type=type_hints["description"])
@@ -12024,6 +12109,8 @@ class PythonPackageOptions:
12024
12109
  self._values["classifiers"] = classifiers
12025
12110
  if clobber is not None:
12026
12111
  self._values["clobber"] = clobber
12112
+ if codeql is not None:
12113
+ self._values["codeql"] = codeql
12027
12114
  if commit_generated is not None:
12028
12115
  self._values["commit_generated"] = commit_generated
12029
12116
  if deps is not None:
@@ -12257,6 +12344,15 @@ class PythonPackageOptions:
12257
12344
  result = self._values.get("clobber")
12258
12345
  return typing.cast(typing.Optional[builtins.bool], result)
12259
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
+
12260
12356
  @builtins.property
12261
12357
  def commit_generated(self) -> typing.Optional[builtins.bool]:
12262
12358
  '''(experimental) Whether to commit the managed files by default.
@@ -13039,6 +13135,7 @@ def _typecheckingstub__3a6354f4c0532263f309ca59025d89b070b95588f76bd5815340cc71a
13039
13135
  code_artifact_options: typing.Optional[typing.Union[_projen_javascript_04054675.CodeArtifactOptions, typing.Dict[builtins.str, typing.Any]]] = None,
13040
13136
  code_cov: typing.Optional[builtins.bool] = None,
13041
13137
  code_cov_token_secret: typing.Optional[builtins.str] = None,
13138
+ codeql: typing.Optional[builtins.bool] = None,
13042
13139
  commit_generated: typing.Optional[builtins.bool] = None,
13043
13140
  config: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
13044
13141
  constructs_version: typing.Optional[builtins.str] = None,
@@ -13234,6 +13331,7 @@ def _typecheckingstub__bcc0f0f3d874afabc142961b7ca192083fcad906385166f2e47f7e739
13234
13331
  code_artifact_options: typing.Optional[typing.Union[_projen_javascript_04054675.CodeArtifactOptions, typing.Dict[builtins.str, typing.Any]]] = None,
13235
13332
  code_cov: typing.Optional[builtins.bool] = None,
13236
13333
  code_cov_token_secret: typing.Optional[builtins.str] = None,
13334
+ codeql: typing.Optional[builtins.bool] = None,
13237
13335
  commit_generated: typing.Optional[builtins.bool] = None,
13238
13336
  compat: typing.Optional[builtins.bool] = None,
13239
13337
  compat_ignore: typing.Optional[builtins.str] = None,
@@ -13558,6 +13656,7 @@ def _typecheckingstub__882525f8fb69251a060fbbe97c2383313ea4b9c0269874cb1d13172a5
13558
13656
  auto_merge_options: typing.Optional[typing.Union[_projen_github_04054675.AutoMergeOptions, typing.Dict[builtins.str, typing.Any]]] = None,
13559
13657
  classifiers: typing.Optional[typing.Sequence[builtins.str]] = None,
13560
13658
  clobber: typing.Optional[builtins.bool] = None,
13659
+ codeql: typing.Optional[builtins.bool] = None,
13561
13660
  commit_generated: typing.Optional[builtins.bool] = None,
13562
13661
  deps: typing.Optional[typing.Sequence[builtins.str]] = None,
13563
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.0.2", __name__[0:-6], "projen-modules@3.0.2.jsii.tgz"
21
+ "projen-modules", "3.2.0", __name__[0:-6], "projen-modules@3.2.0.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.0.2
3
+ Version: 3.2.0
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>
@@ -55,6 +55,43 @@ Types of testing:
55
55
  * Snapshot - projen project outputs are stored as a snapshot in the corresponding `__snapshots__` directory. When the project changes then it is expected that these snapshots change too and should be reviewed committed alongside the project.
56
56
  * Unit tests - these assert on specific functionality of the project and should be written for any new functionality added.
57
57
 
58
+ ## GitHub Configuration
59
+
60
+ All pull requests are merged by the [Mergify](https://mergify.com) merge queue, configured in `.mergify.yml`. Once a pull request's checks pass, Mergify queues it, brings it up to date with the default branch, waits for the checks again and squash merges it. Draft pull requests and those labelled `do-not-merge` are not merged.
61
+
62
+ The repository must be configured as below so that nothing can be merged without going through the queue.
63
+
64
+ ### Mergify
65
+
66
+ Install the [Mergify GitHub App](https://github.com/apps/mergify) and give it access to this repository.
67
+
68
+ ### Pull request settings
69
+
70
+ In **Settings → General → Pull Requests**:
71
+
72
+ * Allow squash merging only (untick merge commits and rebase merging), matching the queue's merge method.
73
+ * Untick **Allow auto-merge**, because GitHub's own auto-merge merges outside the queue.
74
+ * Tick **Automatically delete head branches**.
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
+
80
+ ### Branch ruleset
81
+
82
+ In **Settings → Rules → Rulesets**, create a branch ruleset with enforcement **Active** that targets the default branch, and set:
83
+
84
+ * **Bypass list**: the **Mergify** app only, in **Exempt** mode. Do not add admins or other roles, as anyone on this list can merge without the queue.
85
+ * **Restrict updates**: only bypass actors can update the branch, so pull requests cannot be merged from the GitHub UI or CLI and commits cannot be pushed directly.
86
+ * **Restrict deletions** and **Block force pushes**.
87
+ * **Require a pull request before merging**, with 0 required approvals.
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.
90
+
91
+ Do not enable GitHub's own **Require merge queue** rule, as it competes with Mergify.
92
+
93
+ If the queue is unavailable and a change has to be merged, add yourself to the bypass list temporarily and remove yourself afterwards.
94
+
58
95
  ## Creating a New Project
59
96
 
60
97
  ```
@@ -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.0.2.jsii.tgz
14
+ src/projen_modules/_jsii/projen-modules@3.2.0.jsii.tgz
@@ -1,55 +0,0 @@
1
- # projen-modules
2
-
3
- A collection of custom projen modules, that can be used to bootstrap and maintain consistent project configuration, tooling, dependencies, and builds.
4
-
5
- ## Getting Started
6
-
7
- ```sh
8
- yarn install
9
- npx projen build
10
- ```
11
-
12
- This will:
13
-
14
- * Install the dependencies
15
- * Apply any projen changes
16
- * Run tests
17
- * Package project locally
18
-
19
- Any files changed by projen should be committed to git.
20
-
21
- Running the tests like this will update any snapshot files, this should be reviewed and committed to git.
22
-
23
- ## Testing
24
-
25
- Types of testing:
26
-
27
- * Snapshot - projen project outputs are stored as a snapshot in the corresponding `__snapshots__` directory. When the project changes then it is expected that these snapshots change too and should be reviewed committed alongside the project.
28
- * Unit tests - these assert on specific functionality of the project and should be written for any new functionality added.
29
-
30
- ## Creating a New Project
31
-
32
- ```
33
- npx projen new {project} --from projen-modules
34
- ```
35
-
36
- Some projects may have required fields that need to be specified as part of this command, review any errors for details what needs to be specified.
37
-
38
- ### Project Types
39
-
40
- | Project type | Description |
41
- | ---------------------------------------------- | -------------------------- |
42
- | [cdk-typescript-app](API.md#cdktypescriptapp-) | A typescript CDK app |
43
- | [npm-package](API.md#npmpackage-) | A typescript npm package |
44
- | [python-package](API.md#pythonpackage-) | A python package |
45
- | [jsii-package](API.md#jsiiproject-) | A typescript JSII package |
46
-
47
- ## Project Structure
48
-
49
- All source is located in `src` and is grouped by:
50
-
51
- * `components` - these are common building blocks that can be used by projects to implement specific project functionality.
52
- * `projects` - these are projects that can be built from this project (see #something)
53
- * `utils` - these are helper functions that are often reused
54
-
55
- `test` contains tests, and mirrors the `src` directory structure. Within here there are `__snapshots__` which contain snapshots of project tests (see #section).
File without changes
File without changes