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

{projen_modules-3.0.2/src/projen_modules.egg-info → projen_modules-3.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: projen_modules
-Version: 3.0.2
+Version: 3.1.0
 Summary: A collection of projen modules
 Home-page: https://github.com/daveshepherd/projen-modules.git
 Author: Dave Shepherd<dave.shepherd@endor.me.uk>
@@ -55,6 +55,38 @@ Types of testing:
 * 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.
 * Unit tests - these assert on specific functionality of the project and should be written for any new functionality added.
 
+## GitHub Configuration
+
+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.
+
+The repository must be configured as below so that nothing can be merged without going through the queue.
+
+### Mergify
+
+Install the [Mergify GitHub App](https://github.com/apps/mergify) and give it access to this repository.
+
+### Pull request settings
+
+In **Settings → General → Pull Requests**:
+
+* Allow squash merging only (untick merge commits and rebase merging), matching the queue's merge method.
+* Untick **Allow auto-merge**, because GitHub's own auto-merge merges outside the queue.
+* Tick **Automatically delete head branches**.
+
+### Branch ruleset
+
+In **Settings → Rules → Rulesets**, create a branch ruleset with enforcement **Active** that targets the default branch, and set:
+
+* **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.
+* **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.
+* **Restrict deletions** and **Block force pushes**.
+* **Require a pull request before merging**, with 0 required approvals.
+* **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.
+
+Do not enable GitHub's own **Require merge queue** rule, as it competes with Mergify.
+
+If the queue is unavailable and a change has to be merged, add yourself to the bypass list temporarily and remove yourself afterwards.
+
 ## Creating a New Project
 
 ```

{projen_modules-3.0.2 → projen_modules-3.1.0}/README.md

@@ -27,6 +27,38 @@ Types of testing:
 * 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.
 * Unit tests - these assert on specific functionality of the project and should be written for any new functionality added.
 
+## GitHub Configuration
+
+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.
+
+The repository must be configured as below so that nothing can be merged without going through the queue.
+
+### Mergify
+
+Install the [Mergify GitHub App](https://github.com/apps/mergify) and give it access to this repository.
+
+### Pull request settings
+
+In **Settings → General → Pull Requests**:
+
+* Allow squash merging only (untick merge commits and rebase merging), matching the queue's merge method.
+* Untick **Allow auto-merge**, because GitHub's own auto-merge merges outside the queue.
+* Tick **Automatically delete head branches**.
+
+### Branch ruleset
+
+In **Settings → Rules → Rulesets**, create a branch ruleset with enforcement **Active** that targets the default branch, and set:
+
+* **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.
+* **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.
+* **Restrict deletions** and **Block force pushes**.
+* **Require a pull request before merging**, with 0 required approvals.
+* **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.
+
+Do not enable GitHub's own **Require merge queue** rule, as it competes with Mergify.
+
+If the queue is unavailable and a change has to be merged, add yourself to the bypass list temporarily and remove yourself afterwards.
+
 ## Creating a New Project
 
 ```

{projen_modules-3.0.2 → projen_modules-3.1.0}/setup.py

@@ -5,7 +5,7 @@ kwargs = json.loads(
     """
 {
     "name": "projen_modules",
-    "version": "3.0.2",
+    "version": "3.1.0",
     "description": "A collection of projen modules",
     "license": "Apache-2.0",
     "url": "https://github.com/daveshepherd/projen-modules.git",
@@ -26,7 +26,7 @@ kwargs = json.loads(
     ],
     "package_data": {
         "projen_modules._jsii": [
-            "projen-modules@3.0.2.jsii.tgz"
+            "projen-modules@3.1.0.jsii.tgz"
         ],
         "projen_modules": [
             "py.typed"

{projen_modules-3.0.2 → projen_modules-3.1.0}/src/projen_modules/__init__.py

@@ -28,6 +28,38 @@ Types of testing:
 * 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.
 * Unit tests - these assert on specific functionality of the project and should be written for any new functionality added.
 
+## GitHub Configuration
+
+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.
+
+The repository must be configured as below so that nothing can be merged without going through the queue.
+
+### Mergify
+
+Install the [Mergify GitHub App](https://github.com/apps/mergify) and give it access to this repository.
+
+### Pull request settings
+
+In **Settings → General → Pull Requests**:
+
+* Allow squash merging only (untick merge commits and rebase merging), matching the queue's merge method.
+* Untick **Allow auto-merge**, because GitHub's own auto-merge merges outside the queue.
+* Tick **Automatically delete head branches**.
+
+### Branch ruleset
+
+In **Settings → Rules → Rulesets**, create a branch ruleset with enforcement **Active** that targets the default branch, and set:
+
+* **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.
+* **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.
+* **Restrict deletions** and **Block force pushes**.
+* **Require a pull request before merging**, with 0 required approvals.
+* **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.
+
+Do not enable GitHub's own **Require merge queue** rule, as it competes with Mergify.
+
+If the queue is unavailable and a change has to be merged, add yourself to the bypass list temporarily and remove yourself afterwards.
+
 ## Creating a New Project
 
 ```
@@ -11703,6 +11735,11 @@ class PythonPackage(
 
         jsii.create(self.__class__, self, [options])
 
+    @builtins.property
+    @jsii.member(jsii_name="autoMerge")
+    def auto_merge(self) -> typing.Optional["_projen_github_04054675.AutoMerge"]:
+        return typing.cast(typing.Optional["_projen_github_04054675.AutoMerge"], jsii.get(self, "autoMerge"))
+
     @builtins.property
     @jsii.member(jsii_name="readme")
     def readme(self) -> "Readme":

{projen_modules-3.0.2 → projen_modules-3.1.0}/src/projen_modules/_jsii/__init__.py

@@ -18,7 +18,7 @@ import constructs._jsii
 import projen._jsii
 
 __jsii_assembly__ = jsii.JSIIAssembly.load(
-    "projen-modules", "3.0.2", __name__[0:-6], "projen-modules@3.0.2.jsii.tgz"
+    "projen-modules", "3.1.0", __name__[0:-6], "projen-modules@3.1.0.jsii.tgz"
 )
 
 __all__ = [

{projen_modules-3.0.2 → projen_modules-3.1.0/src/projen_modules.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: projen_modules
-Version: 3.0.2
+Version: 3.1.0
 Summary: A collection of projen modules
 Home-page: https://github.com/daveshepherd/projen-modules.git
 Author: Dave Shepherd<dave.shepherd@endor.me.uk>
@@ -55,6 +55,38 @@ Types of testing:
 * 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.
 * Unit tests - these assert on specific functionality of the project and should be written for any new functionality added.
 
+## GitHub Configuration
+
+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.
+
+The repository must be configured as below so that nothing can be merged without going through the queue.
+
+### Mergify
+
+Install the [Mergify GitHub App](https://github.com/apps/mergify) and give it access to this repository.
+
+### Pull request settings
+
+In **Settings → General → Pull Requests**:
+
+* Allow squash merging only (untick merge commits and rebase merging), matching the queue's merge method.
+* Untick **Allow auto-merge**, because GitHub's own auto-merge merges outside the queue.
+* Tick **Automatically delete head branches**.
+
+### Branch ruleset
+
+In **Settings → Rules → Rulesets**, create a branch ruleset with enforcement **Active** that targets the default branch, and set:
+
+* **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.
+* **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.
+* **Restrict deletions** and **Block force pushes**.
+* **Require a pull request before merging**, with 0 required approvals.
+* **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.
+
+Do not enable GitHub's own **Require merge queue** rule, as it competes with Mergify.
+
+If the queue is unavailable and a change has to be merged, add yourself to the bypass list temporarily and remove yourself afterwards.
+
 ## Creating a New Project
 
 ```

{projen_modules-3.0.2 → projen_modules-3.1.0}/src/projen_modules.egg-info/SOURCES.txt

@@ -11,4 +11,4 @@ src/projen_modules.egg-info/dependency_links.txt
 src/projen_modules.egg-info/requires.txt
 src/projen_modules.egg-info/top_level.txt
 src/projen_modules/_jsii/__init__.py
-src/projen_modules/_jsii/projen-modules@3.0.2.jsii.tgz
+src/projen_modules/_jsii/projen-modules@3.1.0.jsii.tgz