projen-modules 5.2.0__tar.gz → 5.4.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: 5.2.0
3
+ Version: 5.4.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>
@@ -34,6 +34,11 @@ A collection of custom projen modules, that can be used to bootstrap and maintai
34
34
 
35
35
  ## Getting Started
36
36
 
37
+ Prerequisites:
38
+
39
+ * Node.js 22
40
+ * Yarn 1 (classic)
41
+
37
42
  ```sh
38
43
  yarn install
39
44
  npx projen build
@@ -86,44 +91,7 @@ All source is located in `src` and is grouped by:
86
91
 
87
92
  ## GitHub Configuration
88
93
 
89
- All pull requests are merged by the [Mergify](https://mergify.com) merge queue, configured in `.mergify.yml`. Once a pull request is approved, or is opened by `daveshepherd`, and its 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.
90
-
91
- The repository must be configured as below so that nothing can be merged without going through the queue.
92
-
93
- ### Mergify
94
-
95
- Install the [Mergify GitHub App](https://github.com/apps/mergify) and give it access to this repository.
96
-
97
- ### Pull request settings
98
-
99
- In **Settings → General → Pull Requests**:
100
-
101
- * Allow squash merging only (untick merge commits and rebase merging), matching the queue's merge method.
102
- * Untick **Allow auto-merge**, because GitHub's own auto-merge merges outside the queue.
103
- * Tick **Automatically delete head branches**.
104
-
105
- ### Actions settings
106
-
107
- In **Settings → Actions → General**, set **Approval for running fork pull request workflows from contributors** to **Require approval for all external contributors**. A pull request from a fork runs its own copy of the workflows, so it can change how the required checks pass.
108
-
109
- ### Code scanning
110
-
111
- 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.
112
-
113
- ### Branch ruleset
114
-
115
- In **Settings → Rules → Rulesets**, create a branch ruleset with enforcement **Active** that targets the default branch, and set:
116
-
117
- * **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.
118
- * **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.
119
- * **Restrict deletions** and **Block force pushes**.
120
- * **Require a pull request before merging**, with 0 required approvals, because Mergify requires approvals itself for authors other than `daveshepherd` and is exempt from this rule. Tick **Dismiss stale pull request approvals when new commits are pushed**, so that commits pushed after an approval need approving again before the queue merges them.
121
- * **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.
122
- * **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.
123
-
124
- Do not enable GitHub's own **Require merge queue** rule, as it competes with Mergify.
125
-
126
- If the queue is unavailable and a change has to be merged, add yourself to the bypass list temporarily and remove yourself afterwards.
94
+ The one-off configuration that this repository needs on GitHub, such as the Mergify merge queue and the branch ruleset, is described in [docs/github-configuration.md](docs/github-configuration.md).
127
95
 
128
96
  ## Known Issues
129
97
 
@@ -0,0 +1,74 @@
1
+ <!-- ~~ Generated by projen. To modify, edit .projenrc.ts and run "npx projen". -->
2
+
3
+ # projen-modules
4
+
5
+ A collection of custom projen modules, that can be used to bootstrap and maintain consistent project configuration, tooling, dependencies, and builds.
6
+
7
+ ## Getting Started
8
+
9
+ Prerequisites:
10
+
11
+ * Node.js 22
12
+ * Yarn 1 (classic)
13
+
14
+ ```sh
15
+ yarn install
16
+ npx projen build
17
+ ```
18
+
19
+ This will:
20
+
21
+ * Install the dependencies
22
+ * Apply any projen changes
23
+ * Run tests
24
+ * Package project locally
25
+
26
+ Any files changed by projen should be committed to git.
27
+
28
+ Running the tests like this will update any snapshot files, this should be reviewed and committed to git.
29
+
30
+ ## Testing
31
+
32
+ Types of testing:
33
+
34
+ * 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.
35
+ * Unit tests - these assert on specific functionality of the project and should be written for any new functionality added.
36
+
37
+ ## Creating a New Project
38
+
39
+ ```
40
+ npx projen new {project} --from projen-modules
41
+ ```
42
+
43
+ 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.
44
+
45
+ ### Project Types
46
+
47
+ | Project type | Description |
48
+ | ---------------------------------------------- | -------------------------- |
49
+ | [cdk-typescript-app](API.md#cdktypescriptapp-) | A typescript CDK app |
50
+ | [npm-package](API.md#npmpackage-) | A typescript npm package |
51
+ | [python-package](API.md#pythonpackage-) | A python package |
52
+ | [jsii-package](API.md#jsiiproject-) | A typescript JSII package |
53
+
54
+ ## Project Structure
55
+
56
+ All source is located in `src` and is grouped by:
57
+
58
+ * `components` - these are common building blocks that can be used by projects to implement specific project functionality.
59
+ * `projects` - these are projects that can be built from this project (see #something)
60
+ * `utils` - these are helper functions that are often reused
61
+
62
+ `test` contains tests, and mirrors the `src` directory structure. Within here there are `__snapshots__` which contain snapshots of project tests (see #section).
63
+
64
+ ## GitHub Configuration
65
+
66
+ The one-off configuration that this repository needs on GitHub, such as the Mergify merge queue and the branch ruleset, is described in [docs/github-configuration.md](docs/github-configuration.md).
67
+
68
+ ## Known Issues
69
+
70
+ `cdk-typescript-app` defaults to Jest 30, which hoists `@sinonjs/fake-timers` 15 whose bundled types conflict with the `@types/sinon` used by `aws-sdk-client-mock`. Projects using `aws-sdk-client-mock` can set `compilerOptions.skipLibCheck` on the test tsconfig:
71
+
72
+ ```python
73
+ project.tryFindObjectFile('test/tsconfig.json')?.addOverride('compilerOptions.skipLibCheck', true);
74
+ ```
@@ -5,7 +5,7 @@ kwargs = json.loads(
5
5
  """
6
6
  {
7
7
  "name": "projen_modules",
8
- "version": "5.2.0",
8
+ "version": "5.4.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@5.2.0.jsii.tgz"
29
+ "projen-modules@5.4.0.jsii.tgz"
30
30
  ],
31
31
  "projen_modules": [
32
32
  "py.typed"
@@ -7,6 +7,11 @@ A collection of custom projen modules, that can be used to bootstrap and maintai
7
7
 
8
8
  ## Getting Started
9
9
 
10
+ Prerequisites:
11
+
12
+ * Node.js 22
13
+ * Yarn 1 (classic)
14
+
10
15
  ```sh
11
16
  yarn install
12
17
  npx projen build
@@ -59,44 +64,7 @@ All source is located in `src` and is grouped by:
59
64
 
60
65
  ## GitHub Configuration
61
66
 
62
- All pull requests are merged by the [Mergify](https://mergify.com) merge queue, configured in `.mergify.yml`. Once a pull request is approved, or is opened by `daveshepherd`, and its 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.
63
-
64
- The repository must be configured as below so that nothing can be merged without going through the queue.
65
-
66
- ### Mergify
67
-
68
- Install the [Mergify GitHub App](https://github.com/apps/mergify) and give it access to this repository.
69
-
70
- ### Pull request settings
71
-
72
- In **Settings → General → Pull Requests**:
73
-
74
- * Allow squash merging only (untick merge commits and rebase merging), matching the queue's merge method.
75
- * Untick **Allow auto-merge**, because GitHub's own auto-merge merges outside the queue.
76
- * Tick **Automatically delete head branches**.
77
-
78
- ### Actions settings
79
-
80
- In **Settings → Actions → General**, set **Approval for running fork pull request workflows from contributors** to **Require approval for all external contributors**. A pull request from a fork runs its own copy of the workflows, so it can change how the required checks pass.
81
-
82
- ### Code scanning
83
-
84
- 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.
85
-
86
- ### Branch ruleset
87
-
88
- In **Settings → Rules → Rulesets**, create a branch ruleset with enforcement **Active** that targets the default branch, and set:
89
-
90
- * **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.
91
- * **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.
92
- * **Restrict deletions** and **Block force pushes**.
93
- * **Require a pull request before merging**, with 0 required approvals, because Mergify requires approvals itself for authors other than `daveshepherd` and is exempt from this rule. Tick **Dismiss stale pull request approvals when new commits are pushed**, so that commits pushed after an approval need approving again before the queue merges them.
94
- * **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.
95
- * **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.
96
-
97
- Do not enable GitHub's own **Require merge queue** rule, as it competes with Mergify.
98
-
99
- If the queue is unavailable and a change has to be merged, add yourself to the bypass list temporarily and remove yourself afterwards.
67
+ The one-off configuration that this repository needs on GitHub, such as the Mergify merge queue and the branch ruleset, is described in [docs/github-configuration.md](docs/github-configuration.md).
100
68
 
101
69
  ## Known Issues
102
70
 
@@ -18,7 +18,7 @@ import constructs._jsii
18
18
  import projen._jsii
19
19
 
20
20
  __jsii_assembly__ = jsii.JSIIAssembly.load(
21
- "projen-modules", "5.2.0", __name__[0:-6], "projen-modules@5.2.0.jsii.tgz"
21
+ "projen-modules", "5.4.0", __name__[0:-6], "projen-modules@5.4.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: 5.2.0
3
+ Version: 5.4.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>
@@ -34,6 +34,11 @@ A collection of custom projen modules, that can be used to bootstrap and maintai
34
34
 
35
35
  ## Getting Started
36
36
 
37
+ Prerequisites:
38
+
39
+ * Node.js 22
40
+ * Yarn 1 (classic)
41
+
37
42
  ```sh
38
43
  yarn install
39
44
  npx projen build
@@ -86,44 +91,7 @@ All source is located in `src` and is grouped by:
86
91
 
87
92
  ## GitHub Configuration
88
93
 
89
- All pull requests are merged by the [Mergify](https://mergify.com) merge queue, configured in `.mergify.yml`. Once a pull request is approved, or is opened by `daveshepherd`, and its 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.
90
-
91
- The repository must be configured as below so that nothing can be merged without going through the queue.
92
-
93
- ### Mergify
94
-
95
- Install the [Mergify GitHub App](https://github.com/apps/mergify) and give it access to this repository.
96
-
97
- ### Pull request settings
98
-
99
- In **Settings → General → Pull Requests**:
100
-
101
- * Allow squash merging only (untick merge commits and rebase merging), matching the queue's merge method.
102
- * Untick **Allow auto-merge**, because GitHub's own auto-merge merges outside the queue.
103
- * Tick **Automatically delete head branches**.
104
-
105
- ### Actions settings
106
-
107
- In **Settings → Actions → General**, set **Approval for running fork pull request workflows from contributors** to **Require approval for all external contributors**. A pull request from a fork runs its own copy of the workflows, so it can change how the required checks pass.
108
-
109
- ### Code scanning
110
-
111
- 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.
112
-
113
- ### Branch ruleset
114
-
115
- In **Settings → Rules → Rulesets**, create a branch ruleset with enforcement **Active** that targets the default branch, and set:
116
-
117
- * **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.
118
- * **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.
119
- * **Restrict deletions** and **Block force pushes**.
120
- * **Require a pull request before merging**, with 0 required approvals, because Mergify requires approvals itself for authors other than `daveshepherd` and is exempt from this rule. Tick **Dismiss stale pull request approvals when new commits are pushed**, so that commits pushed after an approval need approving again before the queue merges them.
121
- * **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.
122
- * **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.
123
-
124
- Do not enable GitHub's own **Require merge queue** rule, as it competes with Mergify.
125
-
126
- If the queue is unavailable and a change has to be merged, add yourself to the bypass list temporarily and remove yourself afterwards.
94
+ The one-off configuration that this repository needs on GitHub, such as the Mergify merge queue and the branch ruleset, is described in [docs/github-configuration.md](docs/github-configuration.md).
127
95
 
128
96
  ## Known Issues
129
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@5.2.0.jsii.tgz
14
+ src/projen_modules/_jsii/projen-modules@5.4.0.jsii.tgz
@@ -1,106 +0,0 @@
1
- <!-- ~~ Generated by projen. To modify, edit .projenrc.ts and run "npx projen". -->
2
-
3
- # projen-modules
4
-
5
- A collection of custom projen modules, that can be used to bootstrap and maintain consistent project configuration, tooling, dependencies, and builds.
6
-
7
- ## Getting Started
8
-
9
- ```sh
10
- yarn install
11
- npx projen build
12
- ```
13
-
14
- This will:
15
-
16
- * Install the dependencies
17
- * Apply any projen changes
18
- * Run tests
19
- * Package project locally
20
-
21
- Any files changed by projen should be committed to git.
22
-
23
- Running the tests like this will update any snapshot files, this should be reviewed and committed to git.
24
-
25
- ## Testing
26
-
27
- Types of testing:
28
-
29
- * 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.
30
- * Unit tests - these assert on specific functionality of the project and should be written for any new functionality added.
31
-
32
- ## Creating a New Project
33
-
34
- ```
35
- npx projen new {project} --from projen-modules
36
- ```
37
-
38
- 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.
39
-
40
- ### Project Types
41
-
42
- | Project type | Description |
43
- | ---------------------------------------------- | -------------------------- |
44
- | [cdk-typescript-app](API.md#cdktypescriptapp-) | A typescript CDK app |
45
- | [npm-package](API.md#npmpackage-) | A typescript npm package |
46
- | [python-package](API.md#pythonpackage-) | A python package |
47
- | [jsii-package](API.md#jsiiproject-) | A typescript JSII package |
48
-
49
- ## Project Structure
50
-
51
- All source is located in `src` and is grouped by:
52
-
53
- * `components` - these are common building blocks that can be used by projects to implement specific project functionality.
54
- * `projects` - these are projects that can be built from this project (see #something)
55
- * `utils` - these are helper functions that are often reused
56
-
57
- `test` contains tests, and mirrors the `src` directory structure. Within here there are `__snapshots__` which contain snapshots of project tests (see #section).
58
-
59
- ## GitHub Configuration
60
-
61
- All pull requests are merged by the [Mergify](https://mergify.com) merge queue, configured in `.mergify.yml`. Once a pull request is approved, or is opened by `daveshepherd`, and its 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.
62
-
63
- The repository must be configured as below so that nothing can be merged without going through the queue.
64
-
65
- ### Mergify
66
-
67
- Install the [Mergify GitHub App](https://github.com/apps/mergify) and give it access to this repository.
68
-
69
- ### Pull request settings
70
-
71
- In **Settings → General → Pull Requests**:
72
-
73
- * Allow squash merging only (untick merge commits and rebase merging), matching the queue's merge method.
74
- * Untick **Allow auto-merge**, because GitHub's own auto-merge merges outside the queue.
75
- * Tick **Automatically delete head branches**.
76
-
77
- ### Actions settings
78
-
79
- In **Settings → Actions → General**, set **Approval for running fork pull request workflows from contributors** to **Require approval for all external contributors**. A pull request from a fork runs its own copy of the workflows, so it can change how the required checks pass.
80
-
81
- ### Code scanning
82
-
83
- 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.
84
-
85
- ### Branch ruleset
86
-
87
- In **Settings → Rules → Rulesets**, create a branch ruleset with enforcement **Active** that targets the default branch, and set:
88
-
89
- * **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.
90
- * **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.
91
- * **Restrict deletions** and **Block force pushes**.
92
- * **Require a pull request before merging**, with 0 required approvals, because Mergify requires approvals itself for authors other than `daveshepherd` and is exempt from this rule. Tick **Dismiss stale pull request approvals when new commits are pushed**, so that commits pushed after an approval need approving again before the queue merges them.
93
- * **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.
94
- * **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.
95
-
96
- Do not enable GitHub's own **Require merge queue** rule, as it competes with Mergify.
97
-
98
- If the queue is unavailable and a change has to be merged, add yourself to the bypass list temporarily and remove yourself afterwards.
99
-
100
- ## Known Issues
101
-
102
- `cdk-typescript-app` defaults to Jest 30, which hoists `@sinonjs/fake-timers` 15 whose bundled types conflict with the `@types/sinon` used by `aws-sdk-client-mock`. Projects using `aws-sdk-client-mock` can set `compilerOptions.skipLibCheck` on the test tsconfig:
103
-
104
- ```python
105
- project.tryFindObjectFile('test/tsconfig.json')?.addOverride('compilerOptions.skipLibCheck', true);
106
- ```
File without changes
File without changes