npm - cdklabs-projen-project-types - Versions diffs - 0.1.4 → 0.1.5 - Mend

cdklabs-projen-project-types 0.1.4 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (15) hide show

package/.gitattributes CHANGED Viewed

@@ -5,6 +5,7 @@
 /.gitattributes linguist-generated
 /.github/pull_request_template.md linguist-generated
 /.github/workflows/auto-approve.yml linguist-generated
+/.github/workflows/auto-merge.yml linguist-generated
 /.github/workflows/build.yml linguist-generated
 /.github/workflows/pull-request-lint.yml linguist-generated
 /.github/workflows/release.yml linguist-generated

package/.jsii CHANGED Viewed

@@ -83,75 +83,221 @@
     }
   },
   "types": {
-    "cdklabs-projen-project-types.CdkConstructLibrary": {
+    "cdklabs-projen-project-types.AutoMerge": {
       "assembly": "cdklabs-projen-project-types",
-      "base": "projen.awscdk.AwsCdkConstructLibrary",
+      "base": "projen.Component",
       "docs": {
-        "custom": {
-          "pjid": "cdk-construct-lib"
-        },
         "stability": "stable",
-        "summary": "Create a Cdk Construct Library Project."
+        "summary": "Merge pull requests using a merge queue."
       },
-      "fqn": "cdklabs-projen-project-types.CdkConstructLibrary",
+      "fqn": "cdklabs-projen-project-types.AutoMerge",
       "initializer": {
         "docs": {
           "stability": "stable"
         },
         "locationInModule": {
-          "filename": "src/cdk.ts",
-          "line": 43
+          "filename": "src/auto-merge.ts",
+          "line": 53
         },
         "parameters": [
+          {
+            "name": "github",
+            "type": {
+              "fqn": "projen.github.GitHub"
+            }
+          },
           {
             "name": "options",
+            "optional": true,
             "type": {
-              "fqn": "cdklabs-projen-project-types.CdkConstructLibraryOptions"
+              "fqn": "cdklabs-projen-project-types.AutoMergeOptions"
             }
           }
         ]
       },
       "kind": "class",
       "locationInModule": {
-        "filename": "src/cdk.ts",
-        "line": 23
+        "filename": "src/auto-merge.ts",
+        "line": 52
       },
-      "name": "CdkConstructLibrary",
+      "name": "AutoMerge",
+      "symbolId": "src/auto-merge:AutoMerge"
+    },
+    "cdklabs-projen-project-types.AutoMergeOptions": {
+      "assembly": "cdklabs-projen-project-types",
+      "datatype": true,
+      "docs": {
+        "stability": "stable",
+        "summary": "Options for 'AutoMerge'."
+      },
+      "fqn": "cdklabs-projen-project-types.AutoMergeOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/auto-merge.ts",
+        "line": 12
+      },
+      "name": "AutoMergeOptions",
       "properties": [
         {
+          "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "- pull requests from all users are eligible for auto-merge",
+            "stability": "stable",
+            "summary": "Only pull requests authored by these Github usernames will have auto-merge enabled."
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/cdk.ts",
-            "line": 41
+            "filename": "src/auto-merge.ts",
+            "line": 17
           },
-          "name": "private",
+          "name": "allowedUsernames",
+          "optional": true,
           "type": {
-            "primitive": "boolean"
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- all pull requests are eligible for auto-merge",
+            "stability": "stable",
+            "summary": "Only pull requests with one of this labels will have auto-merge enabled."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/auto-merge.ts",
+            "line": 23
+          },
+          "name": "labels",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "MergeMethod.SQUASH",
+            "remarks": "Any branch protection rules must allow this merge method.",
+            "stability": "stable",
+            "summary": "The method used to auto-merge the PR."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/auto-merge.ts",
+            "line": 40
+          },
+          "name": "mergeMethod",
+          "optional": true,
+          "type": {
+            "fqn": "cdklabs-projen-project-types.MergeMethod"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "[\"ubuntu-latest\"]",
+            "stability": "stable",
+            "summary": "Github Runner selection labels."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/auto-merge.ts",
+            "line": 46
+          },
+          "name": "runsOn",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "\"GITHUB_TOKEN\"",
+            "remarks": "This token is used to enable auto-merge on pull requests.",
+            "stability": "stable",
+            "summary": "A GitHub secret name which contains a GitHub Access Token with write permissions for the `pull_request` scope."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/auto-merge.ts",
+            "line": 33
+          },
+          "name": "secret",
+          "optional": true,
+          "type": {
+            "primitive": "string"
           }
         }
       ],
-      "symbolId": "src/cdk:CdkConstructLibrary"
+      "symbolId": "src/auto-merge:AutoMergeOptions"
     },
-    "cdklabs-projen-project-types.CdkConstructLibraryOptions": {
+    "cdklabs-projen-project-types.CdkCommonOptions": {
       "assembly": "cdklabs-projen-project-types",
       "datatype": true,
       "docs": {
         "stability": "stable"
       },
-      "fqn": "cdklabs-projen-project-types.CdkConstructLibraryOptions",
-      "interfaces": [
-        "projen.awscdk.AwsCdkConstructLibraryOptions"
-      ],
+      "fqn": "cdklabs-projen-project-types.CdkCommonOptions",
       "kind": "interface",
       "locationInModule": {
         "filename": "src/cdk.ts",
-        "line": 7
+        "line": 9
       },
-      "name": "CdkConstructLibraryOptions",
+      "name": "CdkCommonOptions",
       "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- true for private projects, false otherwise",
+            "stability": "stable",
+            "summary": "Whether to enable the auto merge workflow for PRs This will enable the auto merge workflow as well as the merge queue."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/cdk.ts",
+            "line": 26
+          },
+          "name": "enablePRAutoMerge",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "default options",
+            "stability": "stable",
+            "summary": "Options for the GitHub auto merge workflow (the workflow that turns on auto merge on all PRs)."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/cdk.ts",
+            "line": 34
+          },
+          "name": "ghAutoMergeOptions",
+          "optional": true,
+          "type": {
+            "fqn": "cdklabs-projen-project-types.AutoMergeOptions"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -163,7 +309,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/cdk.ts",
-            "line": 15
+            "line": 17
           },
           "name": "private",
           "optional": true,
@@ -172,32 +318,32 @@
           }
         }
       ],
-      "symbolId": "src/cdk:CdkConstructLibraryOptions"
+      "symbolId": "src/cdk:CdkCommonOptions"
     },
-    "cdklabs-projen-project-types.CdkTypeScriptProject": {
+    "cdklabs-projen-project-types.CdkConstructLibrary": {
       "assembly": "cdklabs-projen-project-types",
-      "base": "projen.typescript.TypeScriptProject",
+      "base": "projen.awscdk.AwsCdkConstructLibrary",
       "docs": {
         "custom": {
-          "pjid": "cdk-ts-proj"
+          "pjid": "cdk-construct-lib"
         },
         "stability": "stable",
-        "summary": "Create a Cdk TypeScript Project."
+        "summary": "Create a Cdk Construct Library Project."
       },
-      "fqn": "cdklabs-projen-project-types.CdkTypeScriptProject",
+      "fqn": "cdklabs-projen-project-types.CdkConstructLibrary",
       "initializer": {
         "docs": {
           "stability": "stable"
         },
         "locationInModule": {
           "filename": "src/cdk.ts",
-          "line": 86
+          "line": 64
         },
         "parameters": [
           {
             "name": "options",
             "type": {
-              "fqn": "cdklabs-projen-project-types.CdkTypeScriptProjectOptions"
+              "fqn": "cdklabs-projen-project-types.CdkConstructLibraryOptions"
             }
           }
         ]
@@ -205,9 +351,9 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/cdk.ts",
-        "line": 83
+        "line": 44
       },
-      "name": "CdkTypeScriptProject",
+      "name": "CdkConstructLibrary",
       "properties": [
         {
           "docs": {
@@ -216,7 +362,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/cdk.ts",
-            "line": 84
+            "line": 62
           },
           "name": "private",
           "type": {
@@ -224,45 +370,96 @@
           }
         }
       ],
-      "symbolId": "src/cdk:CdkTypeScriptProject"
+      "symbolId": "src/cdk:CdkConstructLibrary"
     },
-    "cdklabs-projen-project-types.CdkTypeScriptProjectOptions": {
+    "cdklabs-projen-project-types.CdkConstructLibraryOptions": {
       "assembly": "cdklabs-projen-project-types",
       "datatype": true,
       "docs": {
         "stability": "stable"
       },
-      "fqn": "cdklabs-projen-project-types.CdkTypeScriptProjectOptions",
+      "fqn": "cdklabs-projen-project-types.CdkConstructLibraryOptions",
       "interfaces": [
-        "projen.typescript.TypeScriptProjectOptions"
+        "projen.awscdk.AwsCdkConstructLibraryOptions",
+        "cdklabs-projen-project-types.CdkCommonOptions"
       ],
       "kind": "interface",
       "locationInModule": {
         "filename": "src/cdk.ts",
-        "line": 67
+        "line": 37
       },
-      "name": "CdkTypeScriptProjectOptions",
+      "name": "CdkConstructLibraryOptions",
+      "symbolId": "src/cdk:CdkConstructLibraryOptions"
+    },
+    "cdklabs-projen-project-types.CdkTypeScriptProject": {
+      "assembly": "cdklabs-projen-project-types",
+      "base": "projen.typescript.TypeScriptProject",
+      "docs": {
+        "custom": {
+          "pjid": "cdk-ts-proj"
+        },
+        "stability": "stable",
+        "summary": "Create a Cdk TypeScript Project."
+      },
+      "fqn": "cdklabs-projen-project-types.CdkTypeScriptProject",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/cdk.ts",
+          "line": 107
+        },
+        "parameters": [
+          {
+            "name": "options",
+            "type": {
+              "fqn": "cdklabs-projen-project-types.CdkTypeScriptProjectOptions"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/cdk.ts",
+        "line": 104
+      },
+      "name": "CdkTypeScriptProject",
       "properties": [
         {
-          "abstract": true,
           "docs": {
-            "default": "true",
-            "remarks": "Setting this variable\nto true means that your project is created with sane defaults\nfor private repositories.",
-            "stability": "stable",
-            "summary": "Whether or not this module is private."
+            "stability": "stable"
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/cdk.ts",
-            "line": 75
+            "line": 105
           },
           "name": "private",
-          "optional": true,
           "type": {
             "primitive": "boolean"
           }
         }
       ],
+      "symbolId": "src/cdk:CdkTypeScriptProject"
+    },
+    "cdklabs-projen-project-types.CdkTypeScriptProjectOptions": {
+      "assembly": "cdklabs-projen-project-types",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "cdklabs-projen-project-types.CdkTypeScriptProjectOptions",
+      "interfaces": [
+        "projen.typescript.TypeScriptProjectOptions",
+        "cdklabs-projen-project-types.CdkCommonOptions"
+      ],
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/cdk.ts",
+        "line": 97
+      },
+      "name": "CdkTypeScriptProjectOptions",
       "symbolId": "src/cdk:CdkTypeScriptProjectOptions"
     },
     "cdklabs-projen-project-types.CdklabsConstructLibrary": {
@@ -457,8 +654,154 @@
       ],
       "name": "JsiiLanguage",
       "symbolId": "src/cdklabs:JsiiLanguage"
+    },
+    "cdklabs-projen-project-types.MergeMethod": {
+      "assembly": "cdklabs-projen-project-types",
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "cdklabs-projen-project-types.MergeMethod",
+      "kind": "enum",
+      "locationInModule": {
+        "filename": "src/auto-merge.ts",
+        "line": 3
+      },
+      "members": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "name": "SQUASH"
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "name": "MERGE"
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "name": "REBASE"
+        }
+      ],
+      "name": "MergeMethod",
+      "symbolId": "src/auto-merge:MergeMethod"
+    },
+    "cdklabs-projen-project-types.MergeQueue": {
+      "assembly": "cdklabs-projen-project-types",
+      "base": "projen.Component",
+      "docs": {
+        "stability": "stable",
+        "summary": "Merge pull requests using a merge queue."
+      },
+      "fqn": "cdklabs-projen-project-types.MergeQueue",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/merge-queue.ts",
+          "line": 32
+        },
+        "parameters": [
+          {
+            "name": "project",
+            "type": {
+              "fqn": "projen.javascript.NodeProject"
+            }
+          },
+          {
+            "name": "options",
+            "optional": true,
+            "type": {
+              "fqn": "cdklabs-projen-project-types.MergeQueueOptions"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/merge-queue.ts",
+        "line": 31
+      },
+      "name": "MergeQueue",
+      "symbolId": "src/merge-queue:MergeQueue"
+    },
+    "cdklabs-projen-project-types.MergeQueueOptions": {
+      "assembly": "cdklabs-projen-project-types",
+      "datatype": true,
+      "docs": {
+        "stability": "stable",
+        "summary": "Options for 'MergeQueue'."
+      },
+      "fqn": "cdklabs-projen-project-types.MergeQueueOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/merge-queue.ts",
+        "line": 7
+      },
+      "name": "MergeQueueOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "true",
+            "stability": "stable",
+            "summary": "Should pull requests be merged automatically once they pass required checks."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/merge-queue.ts",
+            "line": 12
+          },
+          "name": "autoMerge",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- see AutoMergeOptions",
+            "stability": "stable",
+            "summary": "Configure auto merge pull requests."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/merge-queue.ts",
+            "line": 18
+          },
+          "name": "autoMergeOptions",
+          "optional": true,
+          "type": {
+            "fqn": "cdklabs-projen-project-types.AutoMergeOptions"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "main",
+            "stability": "stable",
+            "summary": "The branch to merge to."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/merge-queue.ts",
+            "line": 25
+          },
+          "name": "mergeBranch",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/merge-queue:MergeQueueOptions"
     }
   },
-  "version": "0.1.4",
-  "fingerprint": "1rvDKUd15s9HREprNwa9sCmIrS9QRY2SGr4j6iphFWk="
+  "version": "0.1.5",
+  "fingerprint": "whHkRRsQGRv1ZhtOZtDTTnX/7c8GfFoXEIZig/RwuOM="
 }

package/.projenrc.ts ADDED Viewed

@@ -0,0 +1,23 @@
+import { cdk } from 'projen';
+import { MergeQueue } from './src';
+const project = new cdk.JsiiProject({
+  projenrcTs: true,
+  author: 'AWS',
+  authorAddress: 'aws-cdk-dev@amazon.com',
+  defaultReleaseBranch: 'main',
+  name: 'cdklabs-projen-project-types',
+  repositoryUrl: 'https://github.com/cdklabs/cdklabs-projen-project-types.git',
+  deps: ['projen'],
+  bundledDeps: ['yaml'],
+  peerDeps: ['projen'],
+  autoApproveUpgrades: true,
+  autoApproveOptions: { allowedUsernames: ['cdklabs-automation'], secret: 'GITHUB_TOKEN' },
+});
+new MergeQueue(project, {
+  autoMergeOptions: {
+    secret: 'PROJEN_GITHUB_TOKEN',
+  },
+});
+project.synth();