@taimos/projen 0.1.78 → 0.1.80

package/.jsii

@@ -117,6 +117,502 @@
     }
   },
   "types": {
+    "@taimos/projen.AmplifyDeployApp": {
+      "assembly": "@taimos/projen",
+      "datatype": true,
+      "docs": {
+        "remarks": "Mirrors a `MonorepoAmplifyApp` entry in the generated `amplify.yml`; the\n`appRoot` should match so a build is triggered by exactly the directory it is\nbuilt from.",
+        "stability": "stable",
+        "summary": "One Amplify Hosting application whose builds CI drives."
+      },
+      "fqn": "@taimos/projen.AmplifyDeployApp",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/components/amplify-deploy.ts",
+        "line": 34
+      },
+      "name": "AmplifyDeployApp",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The package path that is the Amplify app root, e.g. `packages/frontend`. `<appRoot>/**` becomes a push trigger path."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/amplify-deploy.ts",
+            "line": 47
+          },
+          "name": "appRoot",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Must match the key the CDK side registers the app under.",
+            "stability": "stable",
+            "summary": "Short key identifying the app. Used in the app-id SSM parameter path and, by default, in the workflow name."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/amplify-deploy.ts",
+            "line": 41
+          },
+          "name": "key",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "[]",
+            "remarks": "Set this for workspace packages the app consumes via `workspace:*` and that\nthe build spec pre-builds — a shared API package, say. Without them a change\nto shared types would not rebuild the app and it would ship stale.",
+            "stability": "stable",
+            "summary": "Extra path globs that affect this app's build output."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/amplify-deploy.ts",
+            "line": 58
+          },
+          "name": "dependencyPaths",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- the `key`",
+            "stability": "stable",
+            "summary": "Human-readable name used in step names and log lines."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/amplify-deploy.ts",
+            "line": 65
+          },
+          "name": "label",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- `<key>-deploy`",
+            "stability": "stable",
+            "summary": "The generated workflow name, which is also its `.yml` file name."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/amplify-deploy.ts",
+            "line": 72
+          },
+          "name": "workflowName",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/components/amplify-deploy:AmplifyDeployApp"
+    },
+    "@taimos/projen.AmplifyDeployStage": {
+      "assembly": "@taimos/projen",
+      "datatype": true,
+      "docs": {
+        "remarks": "Both shapes seen in practice are expressible: separate accounts per stage\n(each entry has its own `account`), or a single account serving several\nbranches (every entry repeats the same `account`, and the branch alone\nselects which Amplify branch is built).",
+        "stability": "stable",
+        "summary": "One deploy stage: a git branch, the logical stage it serves, and the AWS account its Amplify apps live in."
+      },
+      "fqn": "@taimos/projen.AmplifyDeployStage",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/components/amplify-deploy.ts",
+        "line": 13
+      },
+      "name": "AmplifyDeployStage",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The AWS account hosting this stage's Amplify apps."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/amplify-deploy.ts",
+            "line": 24
+          },
+          "name": "account",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The git branch the Amplify apps build from, e.g. `main` or `production`."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/amplify-deploy.ts",
+            "line": 15
+          },
+          "name": "branch",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The logical stage this branch serves, e.g. `dev` or `prod`. Used as the GitHub environment so protection rules apply per stage."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/amplify-deploy.ts",
+            "line": 21
+          },
+          "name": "stageName",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/components/amplify-deploy:AmplifyDeployStage"
+    },
+    "@taimos/projen.GitHubAmplifyDeploy": {
+      "assembly": "@taimos/projen",
+      "base": "projen.Component",
+      "docs": {
+        "remarks": "Amplify's own auto-build fires on every push to a tracked branch. In a\nmonorepo that means every frontend rebuilds whenever anything changes — the\nmarketing site rebuilding for a backend-only commit and vice versa, once per\ntracked branch. Amplify bills build minutes, so most of those are waste.\n\nAmplify's native answer, `AMPLIFY_DIFF_DEPLOY`, diffs exactly one directory\n(`AMPLIFY_MONOREPO_APP_ROOT`, overridable via `AMPLIFY_DIFF_DEPLOY_ROOT` —\nstill a single path). That is enough for a self-contained app but not for one\nthat also depends on a shared workspace package: a one-directory diff would\nship a stale frontend whenever the shared types changed. GitHub's `paths:`\nfilters accept multiple globs, so builds move to CI.\n\nEach generated workflow resolves the pushed branch to its stage and account,\nchains OIDC -> deployment role -> build-trigger role, reads the app id from\nSSM, starts a `RELEASE` job and polls until it reaches a terminal state — so\na failed Amplify build fails the workflow instead of passing silently.\n\nThis component generates the CI half only. The infrastructure half belongs in\nthe project's own CDK app, which must:\n\n  1. set `autoBuild: false` on every branch these workflows build,\n  2. publish each app's id to `<parameterPrefix>/<key>/app-id`, and\n  3. create a role named `buildTriggerRoleName` in each stage account,\n     trusted by `deploymentRoleArn` and granting `amplify:StartJob` +\n     `amplify:GetJob` on the tracked branch ARNs only.\n\nUse `buildTriggerRoleName` and `appIdParameterName()` from the projenrc to\nkeep those names in step; a mismatch fails the workflow loudly at the\nassume-role or parameter-read step rather than skipping a deploy.",
+        "stability": "stable",
+        "summary": "Adds one path-scoped deploy workflow per Amplify Hosting app."
+      },
+      "fqn": "@taimos/projen.GitHubAmplifyDeploy",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/components/amplify-deploy.ts",
+          "line": 194
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "projen.github.GitHubProject"
+            }
+          },
+          {
+            "name": "options",
+            "type": {
+              "fqn": "@taimos/projen.GitHubAmplifyDeployOptions"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/components/amplify-deploy.ts",
+        "line": 182
+      },
+      "methods": [
+        {
+          "docs": {
+            "remarks": "The CDK side must\npublish the id under exactly this name.",
+            "stability": "stable",
+            "summary": "The SSM parameter path holding an app's Amplify app id."
+          },
+          "locationInModule": {
+            "filename": "src/components/amplify-deploy.ts",
+            "line": 317
+          },
+          "name": "appIdParameterName",
+          "parameters": [
+            {
+              "name": "key",
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
+        }
+      ],
+      "name": "GitHubAmplifyDeploy",
+      "properties": [
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Name of the IAM role CI chains into, in every stage account."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/amplify-deploy.ts",
+            "line": 187
+          },
+          "name": "buildTriggerRoleName",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Prefix of the SSM parameter path holding each app's Amplify app id."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/amplify-deploy.ts",
+            "line": 190
+          },
+          "name": "parameterPrefix",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "The generated deploy workflows, one per app."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/amplify-deploy.ts",
+            "line": 184
+          },
+          "name": "workflows",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "projen.github.GithubWorkflow"
+              },
+              "kind": "array"
+            }
+          }
+        }
+      ],
+      "symbolId": "src/components/amplify-deploy:GitHubAmplifyDeploy"
+    },
+    "@taimos/projen.GitHubAmplifyDeployOptions": {
+      "assembly": "@taimos/projen",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "@taimos/projen.GitHubAmplifyDeployOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/components/amplify-deploy.ts",
+        "line": 75
+      },
+      "name": "GitHubAmplifyDeployOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "At least one.",
+            "stability": "stable",
+            "summary": "The Amplify apps to generate deploy workflows for."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/amplify-deploy.ts",
+            "line": 77
+          },
+          "name": "apps",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "@taimos/projen.AmplifyDeployApp"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "The per-stage build-trigger role is reached from it\nby role chaining, so it must be allowed to `sts:AssumeRole` on that role —\nan IAM grant that lives outside the generated code.",
+            "stability": "stable",
+            "summary": "The GitHub OIDC deployment role every workflow assumes first, typically in a management account."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/amplify-deploy.ts",
+            "line": 88
+          },
+          "name": "deploymentRoleArn",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "At least one.",
+            "stability": "stable",
+            "summary": "The branches that deploy, and the account each one deploys into."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/amplify-deploy.ts",
+            "line": 80
+          },
+          "name": "stages",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "@taimos/projen.AmplifyDeployStage"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- `<project name>-amplify-build-trigger`",
+            "remarks": "The same name is expected in every stage account, so the workflow can build\nthe ARN from the account id alone. The CDK side must create a role with\nexactly this name.",
+            "stability": "stable",
+            "summary": "Name of the per-account IAM role CI chains into to start builds."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/amplify-deploy.ts",
+            "line": 99
+          },
+          "name": "buildTriggerRoleName",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- `/<project name>/amplify`",
+            "remarks": "Reading the app id at run time means CI never hardcodes an id that changes\nwhenever an app is replaced.",
+            "stability": "stable",
+            "summary": "Prefix of the SSM parameter path holding each app's Amplify app id. The full path is `<prefix>/<app key>/app-id`."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/amplify-deploy.ts",
+            "line": 110
+          },
+          "name": "parameterPrefix",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "'eu-central-1'",
+            "stability": "stable",
+            "summary": "The AWS region the Amplify apps live in."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/amplify-deploy.ts",
+            "line": 117
+          },
+          "name": "region",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "['ubuntu-latest']",
+            "stability": "stable",
+            "summary": "The runner tags used to select the runner."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/amplify-deploy.ts",
+            "line": 132
+          },
+          "name": "runnerTags",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- the Amplify build spec, the lockfile and the workspace file",
+            "stability": "stable",
+            "summary": "Paths that change what *every* Amplify build produces, added to each app's own paths."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/amplify-deploy.ts",
+            "line": 125
+          },
+          "name": "sharedBuildPaths",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "45",
+            "stability": "stable",
+            "summary": "Timeout for a deploy job, bounding a hung Amplify build."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/amplify-deploy.ts",
+            "line": 139
+          },
+          "name": "timeoutMinutes",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        }
+      ],
+      "symbolId": "src/components/amplify-deploy:GitHubAmplifyDeployOptions"
+    },
     "@taimos/projen.GitHubProductionRelease": {
       "assembly": "@taimos/projen",
       "base": "projen.Component",
@@ -550,7 +1046,7 @@
         },
         "locationInModule": {
           "filename": "src/projects/monorepo.ts",
-          "line": 275
+          "line": 291
         },
         "parameters": [
           {
@@ -564,7 +1060,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/projects/monorepo.ts",
-        "line": 255
+        "line": 268
       },
       "name": "MonorepoProject",
       "properties": [
@@ -576,7 +1072,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/projects/monorepo.ts",
-            "line": 273
+            "line": 289
           },
           "name": "defaultReleaseBranch",
           "type": {
@@ -591,7 +1087,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/projects/monorepo.ts",
-            "line": 261
+            "line": 274
           },
           "name": "prBuildWorkflow",
           "type": {
@@ -606,13 +1102,29 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/projects/monorepo.ts",
-            "line": 258
+            "line": 271
           },
           "name": "workspaceFile",
           "type": {
             "fqn": "projen.YamlFile"
           }
         },
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "The Amplify deploy workflows, when `amplifyDeployOptions` is set."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/projects/monorepo.ts",
+            "line": 286
+          },
+          "name": "amplifyDeploy",
+          "optional": true,
+          "type": {
+            "fqn": "@taimos/projen.GitHubAmplifyDeploy"
+          }
+        },
         {
           "docs": {
             "stability": "stable",
@@ -621,7 +1133,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/projects/monorepo.ts",
-            "line": 264
+            "line": 277
           },
           "name": "amplifyFile",
           "optional": true,
@@ -637,7 +1149,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/projects/monorepo.ts",
-            "line": 267
+            "line": 280
           },
           "name": "assignApprover",
           "optional": true,
@@ -653,7 +1165,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/projects/monorepo.ts",
-            "line": 270
+            "line": 283
           },
           "name": "productionRelease",
           "optional": true,
@@ -705,6 +1217,25 @@
             }
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- Amplify's own auto-build is left in place",
+            "remarks": "Setting this generates one deploy workflow per listed app. The project's\nCDK app must disable `autoBuild` on the tracked branches and provide the\napp-id parameters and build-trigger role the workflows expect.",
+            "stability": "stable",
+            "summary": "Drive Amplify Hosting builds from GitHub Actions instead of Amplify's own auto-build, so an app only rebuilds when the packages it is built from actually changed (see `GitHubAmplifyDeploy`)."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/projects/monorepo.ts",
+            "line": 252
+          },
+          "name": "amplifyDeployOptions",
+          "optional": true,
+          "type": {
+            "fqn": "@taimos/projen.GitHubAmplifyDeployOptions"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -1621,6 +2152,6 @@
       "symbolId": "src/projects/ts-lib:TaimosTypescriptLibraryOptions"
     }
   },
-  "version": "0.1.78",
-  "fingerprint": "Ca2fTzvSOqEcmRhSZs0p23CDGzBnlyvak2NWAr1j4hQ="
+  "version": "0.1.80",
+  "fingerprint": "1eBWvW/AaeTw+BsepheKQ2d7cuNppk86/ck5HeLYLJY="
 }