cdklabs-projen-project-types 0.1.162 → 0.1.164

package/.gitattributes

@@ -12,7 +12,6 @@
 /.github/workflows/upgrade-main.yml linguist-generated
 /.gitignore linguist-generated
 /.npmignore linguist-generated
-/.npmrc linguist-generated
 /.projen/** linguist-generated
 /.projen/deps.json linguist-generated
 /.projen/files.json linguist-generated

package/.jsii

@@ -8,12 +8,37 @@
     ]
   },
   "bundled": {
-    "yaml": "^2.3.1"
+    "yaml": "^2.3.3"
   },
   "dependencies": {
-    "projen": "^0.72.6"
+    "projen": "^0.76.11"
   },
   "dependencyClosure": {
+    "constructs": {
+      "targets": {
+        "dotnet": {
+          "namespace": "Constructs",
+          "packageId": "Constructs"
+        },
+        "go": {
+          "moduleName": "github.com/aws/constructs-go"
+        },
+        "java": {
+          "maven": {
+            "artifactId": "constructs",
+            "groupId": "software.constructs"
+          },
+          "package": "software.constructs"
+        },
+        "js": {
+          "npm": "constructs"
+        },
+        "python": {
+          "distName": "constructs",
+          "module": "constructs"
+        }
+      }
+    },
     "projen": {
       "submodules": {
         "projen.awscdk": {},
@@ -71,7 +96,7 @@
   },
   "name": "cdklabs-projen-project-types",
   "readme": {
-    "markdown": "# Cdklabs Projen Project Types\n\nThis repository stores custom project types extended from `projen` with cdklabs defaults\nbaked in. This is meant to serve as a hook for continuous management of all repos we own.\nWith cdklabs projen types, we can add new configuration as they come up and have it\npropogate to all repositories using the type.\n\n## CdklabsConstructLibrary\n\nThis type extends projen's `awscdk.AwsConstructLibrary` project type and should be used in place\nof that type.\n\n### Usage\n\nFrom the command line:\n\n```bash\nnpx projen new --from cdklabs-projen-project-types cdklabs-construct-lib\n```\n\nFrom inside `cdk-ops`:\n\n```ts\nthis.cdklabs.addPreApprovedRepo({\n  repo: 'cdk-new-lib',\n  owner: 'conroyka@amazon.com',\n  createWith: {\n    projectType: ProjectType.CDKLABS_MANAGED_CONSTRUCT_LIB,\n  },\n});\n```\n\n### Features\n\n- `cdklabsPublishingDefaults`\n\nBy default, this is turned on. `cdklabsPublishingDefaults` provides publishing defaults based off\nof the project's name. Specifically, the defaults look like this:\n\n```ts\nreturn {\n  publishToPypi: {\n    distName: npmPackageName,\n    module: changeDelimiter(npmPackageName, '_'),\n  },\n  publishToMaven: {\n    javaPackage: `io.github.cdklabs.${changeDelimiter(npmPackageName, '.')}`,\n    mavenGroupId: 'io.github.cdklabs',\n    mavenArtifactId: npmPackageName,\n    mavenEndpoint: 'https://s01.oss.sonatype.org',\n  },\n  publishToNuget: {\n    dotNetNamespace: `Cdklabs${upperCaseName(npmPackageName)}`,\n    packageId: `Cdklabs${upperCaseName(npmPackageName)}`,\n  },\n  publishToGo: {\n    moduleName: `${npmPackageName}-go`,\n  },\n};\n```\n\nAdditionally, we also require that we publish to all jsii language targets (including go) when\nwe specify a library as `stable`.\n\n- `private`\n\nBy default, a project is created as `private`. Turning this off simply means setting `private: false`.\nA project being `private` means it gets certain properties set as default that are true for private\nprojects. Today, that means setting `private: true` in `package.json`, removing `.mergify.yml` from\nthe project, and removing `.npmignore`.\n\n- `releasableCommits`\n\nBy default this project type releases `ReleasableCommits.featuresAndFixes`, to not release a new\nversion every day on a package that only sees devDependency updates. You may want to override this\nif you need something more specific.\n\n## CdklabsTypeScriptProject\n\nThis type extends projen's `typescript.TypeScriptProject` project type and should be used in place\nof that type.\n\n### Usage\n\n```bash\nnpx projen new --from cdklabs-projen-project-types cdklabs-ts-proj\n```\n\nFrom inside `cdk-ops`:\n\n```ts\nthis.cdklabs.addPreApprovedRepo({\n  repo: 'cdk-new-lib',\n  owner: 'conroyka@amazon.com',\n  createWith: {\n    projectType: ProjectType.CDKLABS_MANAGED_TS_PROJECT,\n  },\n});\n```\n\n### Features\n\n- `private`\n\nBy default, a project is created as `private`. Turning this off simply means setting `private: false`.\nA project being `private` means it gets certain properties set as default that are true for private\nprojects. Today, that means setting `private: true` in `package.json`, removing `.mergify.yml` from\nthe project, and removing `.npmignore`.\n\n## CdklabsMonorepo\n\nA TypeScript monorepo using Yarn Workspaces.\nIndividual workspaces can be added with `yarn.TypeScriptWorkspace` which extends projen's `typescript.TypeScriptProject`.\n\n### Usage\n\n```bash\nnpx projen new --from cdklabs-projen-project-types cdklabs-yarn-monorepo\n```\n\n### Features\n\n```ts\nconst project = new yarn.CdkLabsMonorepo({\n  defaultReleaseBranch: \"main\",\n  devDeps: [\"cdklabs-projen-project-types\"],\n  name: \"monorepo\",\n});\n```\n\n- Workspace commands: `projen build|compile|package|test|upgrade`\\\nWill run the specific command in all workspaces and the root if applicable.\n\n- Workspace run: `projen run <command>`\\\nExecutes the given command in all workspaces\n\n- Automatic dependency installation\\\nThe monorepo will know if a dependency has been added for a workspace and run `yarn install` as part of `projen`\n\n- `projen` at any level\\\nThe default `projen` command can be run in any workspace and will execute the monorepo synth command.\n\n- Release\\\nThis feature is not supported at this time.\nAny release functionality must be implemented.\n\n- `vscodeWorkspace: boolean`\\\nYou can specifify if a VSCode Workspace file should be created for the monorepo.\n\n#### Workspaces\n\n```ts\nnew yarn.TypeScriptWorkspace({\n  parent: project,\n  name: 'workspace'\n})\n```\n\n- `parent: yarn.Monorepo`\\\nWorkspaces (aka subprojects) must be added using the `parent` option.\n\n- `workspaceScope: string`\\\nThe location the workspace is placed at. Defaults to `./packages`\n\n- `excludeDepsFromUpgrade: Array<string>`\\\nList any dependencies that should not be updated in the workspace.\n"
+    "markdown": "# Cdklabs Projen Project Types\n\nThis repository stores custom project types extended from `projen` with cdklabs defaults\nbaked in. This is meant to serve as a hook for continuous management of all repos we own.\nWith cdklabs projen types, we can add new configuration as they come up and have it\npropagate to all repositories using the type.\n\n## CdklabsConstructLibrary\n\nThis type extends projen's `awscdk.AwsConstructLibrary` project type and should be used in place\nof that type.\n\n### Usage\n\nFrom the command line:\n\n```bash\nnpx projen new --from cdklabs-projen-project-types cdklabs-construct-lib\n```\n\nFrom inside `cdk-ops`:\n\n```ts\nthis.cdklabs.addPreApprovedRepo({\n  repo: 'cdk-new-lib',\n  owner: 'conroyka@amazon.com',\n  createWith: {\n    projectType: ProjectType.CDKLABS_MANAGED_CONSTRUCT_LIB,\n  },\n});\n```\n\n### Features\n\n- `cdklabsPublishingDefaults`\n\nBy default, this is turned on. `cdklabsPublishingDefaults` provides publishing defaults based off\nof the project's name. Specifically, the defaults look like this:\n\n```ts\nreturn {\n  publishToPypi: {\n    distName: npmPackageName,\n    module: changeDelimiter(npmPackageName, '_'),\n  },\n  publishToMaven: {\n    javaPackage: `io.github.cdklabs.${changeDelimiter(npmPackageName, '.')}`,\n    mavenGroupId: 'io.github.cdklabs',\n    mavenArtifactId: npmPackageName,\n    mavenEndpoint: 'https://s01.oss.sonatype.org',\n  },\n  publishToNuget: {\n    dotNetNamespace: `Cdklabs${upperCaseName(npmPackageName)}`,\n    packageId: `Cdklabs${upperCaseName(npmPackageName)}`,\n  },\n  publishToGo: {\n    moduleName: `${npmPackageName}-go`,\n  },\n};\n```\n\nAdditionally, we also require that we publish to all jsii language targets (including go) when\nwe specify a library as `stable`.\n\n- `private`\n\nBy default, a project is created as `private`. Turning this off simply means setting `private: false`.\nA project being `private` means it gets certain properties set as default that are true for private\nprojects. Today, that means setting `private: true` in `package.json`, removing `.mergify.yml` from\nthe project, and removing `.npmignore`.\n\n- `releasableCommits`\n\nBy default this project type releases `ReleasableCommits.featuresAndFixes`, to not release a new\nversion every day on a package that only sees devDependency updates. You may want to override this\nif you need something more specific.\n\n## CdklabsTypeScriptProject\n\nThis type extends projen's `typescript.TypeScriptProject` project type and should be used in place\nof that type.\n\n### Usage\n\n```bash\nnpx projen new --from cdklabs-projen-project-types cdklabs-ts-proj\n```\n\nFrom inside `cdk-ops`:\n\n```ts\nthis.cdklabs.addPreApprovedRepo({\n  repo: 'cdk-new-lib',\n  owner: 'conroyka@amazon.com',\n  createWith: {\n    projectType: ProjectType.CDKLABS_MANAGED_TS_PROJECT,\n  },\n});\n```\n\n### Features\n\n- `private`\n\nBy default, a project is created as `private`. Turning this off simply means setting `private: false`.\nA project being `private` means it gets certain properties set as default that are true for private\nprojects. Today, that means setting `private: true` in `package.json`, removing `.mergify.yml` from\nthe project, and removing `.npmignore`.\n\n## CdklabsMonorepo\n\nA TypeScript monorepo using Yarn Workspaces.\nIndividual workspaces can be added with `yarn.TypeScriptWorkspace` which extends projen's `typescript.TypeScriptProject`.\n\n### Usage\n\n```bash\nnpx projen new --from cdklabs-projen-project-types cdklabs-yarn-monorepo\n```\n\n### Features\n\n```ts\nconst project = new yarn.CdkLabsMonorepo({\n  defaultReleaseBranch: \"main\",\n  devDeps: [\"cdklabs-projen-project-types\"],\n  name: \"monorepo\",\n});\n```\n\n- Workspace commands: `projen build|compile|package|test|upgrade`\\\nWill run the specific command in all workspaces and the root if applicable.\n\n- Workspace run: `projen run <command>`\\\nExecutes the given command in all workspaces\n\n- Automatic dependency installation\\\nThe monorepo will know if a dependency has been added for a workspace and run `yarn install` as part of `projen`\n\n- `projen` at any level\\\nThe default `projen` command can be run in any workspace and will execute the monorepo synth command.\n\n- Release\\\nThis feature is not supported at this time.\nAny release functionality must be implemented.\n\n- `vscodeWorkspace: boolean`\\\nYou can specify if a VSCode Workspace file should be created for the monorepo.\n\n#### Workspaces\n\n```ts\nnew yarn.TypeScriptWorkspace({\n  parent: project,\n  name: 'workspace'\n})\n```\n\n- `parent: yarn.Monorepo`\\\nWorkspaces (aka subprojects) must be added using the `parent` option.\n\n- `workspaceScope: string`\\\nThe location the workspace is placed at. Defaults to `./packages`\n\n- `excludeDepsFromUpgrade: Array<string>`\\\nList any dependencies that should not be updated in the workspace.\n"
   },
   "repository": {
     "type": "git",
@@ -1321,7 +1346,7 @@
         },
         {
           "docs": {
-            "remarks": "1. Call \"this.preSynthesize()\"\n2. Delete all generated files\n3. Synthesize all sub-projects\n4. Synthesize all components of this project\n5. Call \"postSynthesize()\" for all components of this project\n6. Call \"this.postSynthesize()\"",
+            "remarks": "1. Call \"this.preSynthesize()\"\n2. Delete all generated files\n3. Synthesize all subprojects\n4. Synthesize all components of this project\n5. Call \"postSynthesize()\" for all components of this project\n6. Call \"this.postSynthesize()\"",
             "stability": "stable",
             "summary": "Synthesize all project files into `outdir`."
           },
@@ -1912,7 +1937,7 @@
             "default": "true",
             "remarks": "Cannot be used in conjunction with `dependabot`.",
             "stability": "stable",
-            "summary": "Use github workflows to handle dependency upgrades."
+            "summary": "Use tasks and github workflows to handle dependency upgrades."
           },
           "immutable": true,
           "locationInModule": {
@@ -2656,7 +2681,7 @@
           "abstract": true,
           "docs": {
             "default": "\".\"",
-            "remarks": "If this project has a parent, this directory is relative to the parent\ndirectory and it cannot be the same as the parent or any of it's other\nsub-projects.",
+            "remarks": "If this project has a parent, this directory is relative to the parent\ndirectory and it cannot be the same as the parent or any of it's other\nsubprojects.",
             "stability": "stable",
             "summary": "The root directory of the project. Relative to this directory, all files are synthesized."
           },
@@ -3868,6 +3893,23 @@
               "kind": "array"
             }
           }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "Github Runner Group selection options."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/yarn/monorepo-options.ts",
+            "line": 777
+          },
+          "name": "workflowRunsOnGroup",
+          "optional": true,
+          "type": {
+            "fqn": "projen.GroupRunnerOptions"
+          }
         }
       ],
       "symbolId": "src/yarn/monorepo-options:MonorepoOptions"
@@ -4514,7 +4556,7 @@
             "default": "true",
             "remarks": "Cannot be used in conjunction with `dependabot`.",
             "stability": "stable",
-            "summary": "Use github workflows to handle dependency upgrades."
+            "summary": "Use tasks and github workflows to handle dependency upgrades."
           },
           "immutable": true,
           "locationInModule": {
@@ -5343,7 +5385,7 @@
         {
           "abstract": true,
           "docs": {
-            "default": "NodePackageManager.YARN",
+            "default": "NodePackageManager.YARN_CLASSIC",
             "stability": "stable",
             "summary": "The Node Package Manager used to execute scripts."
           },
@@ -6531,6 +6573,23 @@
             }
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "Github Runner Group selection options."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/yarn/typescript-workspace-options.ts",
+            "line": 779
+          },
+          "name": "workflowRunsOnGroup",
+          "optional": true,
+          "type": {
+            "fqn": "projen.GroupRunnerOptions"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -6541,7 +6600,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/yarn/typescript-workspace-options.ts",
-            "line": 780
+            "line": 784
           },
           "name": "workspaceScope",
           "optional": true,
@@ -6553,6 +6612,6 @@
       "symbolId": "src/yarn/typescript-workspace-options:TypeScriptWorkspaceOptions"
     }
   },
-  "version": "0.1.162",
-  "fingerprint": "kTVv35OKNKe7+LuN2jVwZaCA515NmWXbCuYnEipn5TE="
+  "version": "0.1.164",
+  "fingerprint": "RS7tD+0ysJBa+lQd9orP2m7UmwrTEv2yqQ41phct3Ww="
 }