projen 0.34.18 → 0.34.22

package/.jsii

@@ -19541,7 +19541,7 @@
         },
         "locationInModule": {
           "filename": "src/github/github.ts",
-          "line": 61
+          "line": 59
         },
         "parameters": [
           {
@@ -19571,7 +19571,7 @@
           },
           "locationInModule": {
             "filename": "src/github/github.ts",
-            "line": 101
+            "line": 95
           },
           "name": "addDependabot",
           "parameters": [
@@ -19595,7 +19595,7 @@
           },
           "locationInModule": {
             "filename": "src/github/github.ts",
-            "line": 97
+            "line": 91
           },
           "name": "addPullRequestTemplate",
           "parameters": [
@@ -19622,7 +19622,7 @@
           },
           "locationInModule": {
             "filename": "src/github/github.ts",
-            "line": 88
+            "line": 86
           },
           "name": "addWorkflow",
           "parameters": [
@@ -19650,7 +19650,7 @@
           },
           "locationInModule": {
             "filename": "src/github/github.ts",
-            "line": 109
+            "line": 103
           },
           "name": "tryFindWorkflow",
           "parameters": [
@@ -19683,7 +19683,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/github/github.ts",
-            "line": 79
+            "line": 76
           },
           "name": "workflows",
           "type": {
@@ -19906,7 +19906,7 @@
         },
         "locationInModule": {
           "filename": "src/github/workflows.ts",
-          "line": 56
+          "line": 57
         },
         "parameters": [
           {
@@ -19943,7 +19943,7 @@
           },
           "locationInModule": {
             "filename": "src/github/workflows.ts",
-            "line": 88
+            "line": 89
           },
           "name": "addJobs",
           "parameters": [
@@ -19963,6 +19963,29 @@
             }
           ]
         },
+        {
+          "docs": {
+            "remarks": "Useful if a component creates jobs that\nmay not be all available until project synthesis time.",
+            "stability": "experimental",
+            "summary": "Add jobs from a dynamic source."
+          },
+          "locationInModule": {
+            "filename": "src/github/workflows.ts",
+            "line": 110
+          },
+          "name": "addJobsLater",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "Source of jobs."
+              },
+              "name": "provider",
+              "type": {
+                "fqn": "projen.github.IJobProvider"
+              }
+            }
+          ]
+        },
         {
           "docs": {
             "stability": "experimental",
@@ -19970,7 +19993,7 @@
           },
           "locationInModule": {
             "filename": "src/github/workflows.ts",
-            "line": 76
+            "line": 77
           },
           "name": "on",
           "parameters": [
@@ -20023,6 +20046,7 @@
         },
         {
           "docs": {
+            "remarks": "May not exist if `workflowsEnabled` is false on `GitHub`.",
             "stability": "experimental",
             "summary": "The workflow YAML file."
           },
@@ -20097,6 +20121,45 @@
       ],
       "symbolId": "src/github/workflows:GithubWorkflowOptions"
     },
+    "projen.github.IJobProvider": {
+      "assembly": "projen",
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "projen.github.IJobProvider",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/github/workflows.ts",
+        "line": 234
+      },
+      "methods": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Generates a collection of named GitHub workflow jobs."
+          },
+          "locationInModule": {
+            "filename": "src/github/workflows.ts",
+            "line": 238
+          },
+          "name": "renderJobs",
+          "returns": {
+            "type": {
+              "collection": {
+                "elementtype": {
+                  "fqn": "projen.github.workflows.Job"
+                },
+                "kind": "map"
+              }
+            }
+          }
+        }
+      ],
+      "name": "IJobProvider",
+      "namespace": "github",
+      "symbolId": "src/github/workflows:IJobProvider"
+    },
     "projen.github.Mergify": {
       "assembly": "projen",
       "base": "projen.Component",
@@ -29037,7 +29100,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/release/release.ts",
-        "line": 469
+        "line": 472
       },
       "name": "BranchOptions",
       "namespace": "release",
@@ -29051,7 +29114,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 479
+            "line": 482
           },
           "name": "majorVersion",
           "type": {
@@ -29068,7 +29131,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 486
+            "line": 489
           },
           "name": "prerelease",
           "optional": true,
@@ -29087,7 +29150,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 500
+            "line": 503
           },
           "name": "tagPrefix",
           "optional": true,
@@ -29105,7 +29168,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 474
+            "line": 477
           },
           "name": "workflowName",
           "optional": true,
@@ -29965,6 +30028,9 @@
           }
         ]
       },
+      "interfaces": [
+        "projen.github.IJobProvider"
+      ],
       "kind": "class",
       "locationInModule": {
         "filename": "src/release/publisher.ts",
@@ -30146,7 +30212,8 @@
             "filename": "src/release/publisher.ts",
             "line": 98
           },
-          "name": "render",
+          "name": "renderJobs",
+          "overrides": "projen.github.IJobProvider",
           "returns": {
             "type": {
               "collection": {
@@ -30468,7 +30535,7 @@
           },
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 300
+            "line": 306
           },
           "name": "addBranch",
           "parameters": [
@@ -30499,7 +30566,7 @@
           },
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 321
+            "line": 335
           },
           "name": "addJobs",
           "parameters": [
@@ -30518,18 +30585,6 @@
               }
             }
           ]
-        },
-        {
-          "docs": {
-            "stability": "experimental",
-            "summary": "Called before synthesis."
-          },
-          "locationInModule": {
-            "filename": "src/release/release.ts",
-            "line": 328
-          },
-          "name": "preSynthesize",
-          "overrides": "projen.Component"
         }
       ],
       "name": "Release",
@@ -30543,7 +30598,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 341
+            "line": 344
           },
           "name": "branches",
           "type": {
@@ -34356,6 +34411,6 @@
       "symbolId": "src/web/tailwind:TailwindConfigOptions"
     }
   },
-  "version": "0.34.18",
-  "fingerprint": "yEMYfjtAWXDW7tNR9PhoV8dw6/vjeMc0vQdeWyW0I5c="
+  "version": "0.34.22",
+  "fingerprint": "x/1mXr1IMBj652BwWBgcQq7pcqSSdgbMCIndy9wg0Ds="
 }

package/API.md

@@ -284,6 +284,7 @@ Name|Description
 [IDockerComposeVolumeConfig](#projen-idockercomposevolumeconfig)|Storage for volume configuration.
 [IResolvable](#projen-iresolvable)|*No description*
 [IResolver](#projen-iresolver)|API for resolving tokens when synthesizing file content.
+[github.IJobProvider](#projen-github-ijobprovider)|*No description*
 [python.IPackageProvider](#projen-python-ipackageprovider)|*No description*
 [python.IPythonDeps](#projen-python-ipythondeps)|*No description*
 [python.IPythonEnv](#projen-python-ipythonenv)|*No description*
@@ -5834,6 +5835,22 @@ addJobs(jobs: Map<string, Job>): void
 
 
 
+#### addJobsLater(provider)🔹 <a id="projen-github-githubworkflow-addjobslater"></a>
+
+Add jobs from a dynamic source.
+
+Useful if a component creates jobs that
+may not be all available until project synthesis time.
+
+```ts
+addJobsLater(provider: IJobProvider): void
+```
+
+* **provider** (<code>[github.IJobProvider](#projen-github-ijobprovider)</code>)  Source of jobs.
+
+
+
+
 #### on(events)🔹 <a id="projen-github-githubworkflow-on"></a>
 
 Add events to triggers the workflow.
@@ -7211,6 +7228,7 @@ Implements GitHub jobs for publishing modules to package managers.
 
 Under the hood, it uses https://github.com/aws/jsii-release
 
+__Implements__: [github.IJobProvider](#projen-github-ijobprovider)
 __Submodule__: release
 
 __Extends__: [Component](#projen-component)
@@ -7371,12 +7389,12 @@ publishToPyPi(options?: PyPiPublishOptions): void
 
 
 
-#### render()🔹 <a id="projen-release-publisher-render"></a>
+#### renderJobs()🔹 <a id="projen-release-publisher-renderjobs"></a>
 
 Renders a set of workflow jobs for all the publishers.
 
 ```ts
-render(): Map<string, Job>
+renderJobs(): Map<string, Job>
 ```
 
 
@@ -7476,18 +7494,6 @@ addJobs(jobs: Map<string, Job>): void
 
 
 
-#### preSynthesize()🔹 <a id="projen-release-release-presynthesize"></a>
-
-Called before synthesis.
-
-```ts
-preSynthesize(): void
-```
-
-
-
-
-
 
 
 ## class ReleaseTrigger 🔹 <a id="projen-release-releasetrigger"></a>
@@ -11993,6 +11999,28 @@ Name | Type | Description
 
 
 
+## interface IJobProvider 🔹 <a id="projen-github-ijobprovider"></a>
+
+__Implemented by__: [release.Publisher](#projen-release-publisher)
+
+
+### Methods
+
+
+#### renderJobs()🔹 <a id="projen-github-ijobprovider-renderjobs"></a>
+
+Generates a collection of named GitHub workflow jobs.
+
+```ts
+renderJobs(): Map<string, Job>
+```
+
+
+__Returns__:
+* <code>Map<string, [github.workflows.Job](#projen-github-workflows-job)></code>
+
+
+
 ## struct MergifyConditionalOperator 🔹 <a id="projen-github-mergifyconditionaloperator"></a>
 
 

package/docs/awscdk-apps.md

@@ -0,0 +1,15 @@
+# AWS CDK Applications
+
+Project types: `awscdk-app-java`, `awscdk-app-ts`.
+
+## Deployment (NOT IMPLEMENTED YET)
+
+CDK application projects produce complete cloud applications. When a commit is
+merged into the default branch, the app is rolled out by the release workflow to
+AWS environments.
+
+## Dev Stage (NOT IMPLEMENTED YET)
+
+Every app includes an instance of the application stage which can be deployed to
+a development AWS account. This allows each developer to use their AWS account
+as part of their development environment.

package/docs/awscdk-construct.md

@@ -1,26 +1,22 @@
 # AWS CDK Construct Library
 
-This projen type is used for building AWS CDK constructs using the jsii. The [jsii](https://github.com/aws/jsii) allows 
-you to write code once in Typescript and it will generate the Python, .net, and Java equivalents. Use this if you'd 
-like to build and distribute CDK constructs for others to use.
+AWS CDK library projects produce artifacts with reusable constructs which can be
+consumed by other AWS CDK libraries or apps. Library artifacts are published to
+private or public package managers under a semantic version.
 
-Class heirarchy: `AwsCdkConstructLibrary` -> `ConstructLibrary` -> `JsiiProject` -> `TypeScriptProject` -> `NodeProject` -> `Project`
+By default, for every commit to the default branch, a new version is released
+(trunk-based development). This includes the following steps:
 
-# Table of Contents
+1. Compile, lint and test the code.
+1. Use [JSII](https://github.com/aws/jsii) to produce library artifacts for all
+   target languages.
+1. Determine the next minor/patch version based on [conventional
+   commits](https://www.conventionalcommits.org). Major versions must be
+   explicitly bumped to protect consumers against breaking changes.
+1. A changelog entry is generated based on commit history.
+1. Packages are published to all target package managers.
 
-* [Getting Started](#getting-started)
-  * [Standard Node Module Fields](#standard-node-module-fields)
-  * [Dependencies](#dependencies)
-  * [jsii Publishing](#jsii-publishing)
-* [Workflows](#workflows)
-* [Scripts](#scripts)
-* [Construct Catalog](#construct-catalog)
-* [API Documentation](#api-documentation)
-* [Project structure](#project-structure)
-* [Migrating existing projects](#migrating-existing-projects)
-* [Feedback](#feedback)
-
-# Getting Started
+## Getting Started
 
 Start like all projen projects:
 
@@ -46,7 +42,7 @@ keywords: ['cloudwatch', 'monitoring']
 ```
 
 All are pretty standard setup and nothing CDK-specific at this point. The `keywords` automatically gets 'cdk' so you don't
-need to specify it. 
+need to specify it.
 
 ## Dependencies
 
@@ -60,11 +56,11 @@ cdkDependencies: ['@aws-cdk/aws-ec2'],
 cdkTestDependencies: ['@aws-cdk/assert'],
 ```
 
-`cdkDependencies` will add both dependencies and peerDependencies to your package.json file with a caret semver 
-requirement (e.g. `^1.67.0`). CDK dependencies must be both direct and peer dependencies, 
-see [this issue](https://github.com/aws/aws-cdk/issues/5064). You can set `cdkVersionPinning` to `true` to use a fixed 
-version, but this means that any consumer of your library will have to use this exact CDK version. 
-Likewise, `cdkTestDependencies` will add dependencies to the `devDependencies`. 
+`cdkDependencies` will add both dependencies and peerDependencies to your package.json file with a caret semver
+requirement (e.g. `^1.67.0`). CDK dependencies must be both direct and peer dependencies,
+see [this issue](https://github.com/aws/aws-cdk/issues/5064). You can set `cdkVersionPinning` to `true` to use a fixed
+version, but this means that any consumer of your library will have to use this exact CDK version.
+Likewise, `cdkTestDependencies` will add dependencies to the `devDependencies`.
 
 Additionally, you can add CDK dependencies using the methods:
 
@@ -77,9 +73,9 @@ project.addCdkTestDependencies('aws-cdk/something-else');
 
 ### Depending on other modules
 
-If your library consumes other jsii modules, you should declare them thorugh the `deps` or `peerDeps` options. `deps` should be used if 
-types from the consumed module is _not_ part of the public API of the library (the module is used as an implementation detail), 
-while `peerDeps` _must_ be used if types from the consumed module are exported as part of your library's API. You can read more 
+If your library consumes other jsii modules, you should declare them thorugh the `deps` or `peerDeps` options. `deps` should be used if
+types from the consumed module is _not_ part of the public API of the library (the module is used as an implementation detail),
+while `peerDeps` _must_ be used if types from the consumed module are exported as part of your library's API. You can read more
 [here](https://github.com/aws/jsii/blob/master/docs/configuration.md#dependency-considerations).
 
 ```ts
@@ -88,10 +84,10 @@ deps: [ 'cdk-time-bomb' ]
 
 A [dependabot](https://dependabot.com/) file will be added unless `dependabot` is set to 'false'.
 
-## jsii Publishing
+## Publishing
 
-As this is a [jsii project](./jsii.md), it will cross-compile to other languages.  You can set up 
-any number of jsii target languages. 
+As this is a [jsii project](./jsii.md), it will cross-compile to other languages.  You can set up
+any number of jsii target languages.
 
 ```typescript
   dotnet: {
@@ -122,19 +118,19 @@ For help in getting these secrets for your project, read the [jsii-release](http
   
 If you don't want to publish a particular package, do not include the `dotnet`, `java`, or `python` field.
 
-# Workflows
+## Workflows
 
 Two workflows will be created as Github Actions:
 
 * The Build workflow - controlled by the `buildWorkflow` field. On a 'pull_request' or 'workflow_dispatch' the library
 will be built and checked for anti-tamper (ensure no manual changes to generated files).
 * The Release workflow - controlled by the `releaseWorkflow` field. On a push to `main` (overridden at
- `props.defaultReleaseBranch`) the library is built, anti-tampered, version bumped with a commit, pushed back to git, 
+ `props.defaultReleaseBranch`) the library is built, anti-tampered, version bumped with a commit, pushed back to git,
  and then published to the configured artifact repositories (e.g. npm, pypi).
 
-# Scripts
+## Tasks
 
-There are a number of package scripts that are created for you. Any of them can be overwritten using the `addScript*` 
+There are a number of package scripts that are created for you. Any of them can be overwritten using the `addScript*`
 methods.
 
 script|description
@@ -157,38 +153,24 @@ docgen|generate documentation
 
 As you develop your library you'll likely be using the `test:watch` command the most.
 
-# Construct Catalog
-
-Finally, a field for setting up publishing to the [construct catalog](https://awscdk.io):
-
-```typescript
-  catalog: {
-    announce: true,
-    twitter: '@yourhandle'
-  }
-```
-
-These values are optional but allow the construct catalog's Twitter account to mention your handle on the tweet. Setting `announce`
-to 'false' will stop all tweets about the library. However, the library will still be indexed.
-
-# API Documentation
+## API Documentation
 
 Docs will be generated from [Typescript comments](https://typedoc.org/guides/doccomments/) and saved in the `API.md` file.
-Please review this file regularly and document your constructs liberally. 
+Please review this file regularly and document your constructs liberally.
 
-# Project structure
+## Project structure
 
 ```
 .
-|--lib/ (generated)
+|--lib/ (build output)
 |--src/
    |--main.ts
 |--test/
    |--main.test.ts
 ```
 
-Source .ts files should reside in the `src` directory. Constructs should be exported from the main.ts file. 
-Compiled files will be put in the `lib` directory. Tests are in the `test` directory. If you need additional 
+Source .ts files should reside in the `src` directory. Constructs should be exported from the main.ts file.
+Compiled files will be put in the `lib` directory. Tests are in the `test` directory. If you need additional
 resources that are packaged with your library, add those to a `resources` directory that is besides the `src` directory
 and modify your references accordingly:
 
@@ -196,24 +178,18 @@ and modify your references accordingly:
 const thing = require('../resources/some-resource.json')
 ```
 
-# Migrating existing projects
+## Migrating existing projects
 
 Your existing CDK constructs likely have a different file structure than what this projen project expects. Projen projects
 are highly opinionated. There are a few expectations of this project you should modify your existing library to conform to:
 
-* All .ts files are expected to be in the `src/` directory. Existing constructs should all be moved there. However, 
+* All .ts files are expected to be in the `src/` directory. Existing constructs should all be moved there. However,
 you can override this directory by setting `srcdir`.
 * Compiled .js and .d.ts files will go into the `lib/` directory. This directory will be removed and rebuilt each build.
 Do not store source .ts files in your `lib/` or 'libdir'.
-* The entrypoint file for all constructs should be `src/main.ts`. If your existing library is not in the main.ts file, 
+* The entrypoint file for all constructs should be `src/main.ts`. If your existing library is not in the main.ts file,
 you can add the following to export it:
 
 ```typescript
 export * from './our-s3-bucket'
 ```
-
-# Feedback
-
-If you find there is anything we missed, please submit Issues or (better yet) Pull Requests on Github.
-
-