@jjrawlins/cdk-diff-pr-github-action 0.0.1-beta → 0.0.1

package/.jsii

@@ -3525,7 +3525,7 @@
   },
   "description": "A GitHub Action that creates a CDK diff for a pull request.",
   "docs": {
-    "stability": "stable"
+    "stability": "experimental"
   },
   "homepage": "https://jjrawlins@github.com/JaysonRawlins/cdk-diff-pr-github-action.git",
   "jsiiVersion": "5.8.22 (build 160a3ef)",
@@ -3548,7 +3548,7 @@
   },
   "name": "@jjrawlins/cdk-diff-pr-github-action",
   "readme": {
-    "markdown": "# cdk-diff-pr-github-action\n\nA small Projen-based helper library that wires a GitHub workflow to create a CloudFormation Change Set for a CDK stack on every pull request, then comments the formatted diff back on the PR. It also provides a ready‑to‑deploy IAM template you can use to grant the minimal permissions required for the workflow to create and inspect change sets.\n\nThis package exposes two constructs:\n\n- `CdkDiffStackWorkflow` — Generates one GitHub Actions workflow per stack that:\n  - Assumes your GitHub OIDC role\n  - Optionally chains into a separate CDK deploy role\n  - Runs `cdk deploy --no-execute` to create a change set\n  - Runs a generated script to render the change set as an HTML table and posts it to the PR and to the GitHub Step Summary\n  - Cleans up the change set\n\n- `CdkDiffIamTemplate` — Emits a CloudFormation template file (`cdk-diff-workflow-iam-template.yaml`) containing an example IAM role policy with the minimal permissions to create, describe, and delete CloudFormation change sets and read common CDK bootstrap resources. You can launch this in your account and then reference the created role.\n\n## Quick start\n\n1) Add the constructs to your Projen project (in `.projenrc.ts`).\n2) Synthesize with `npx projen`.\n3) Commit the generated files.\n4) Open a pull request — the workflow will create a change set and comment the diff.\n\n## Usage: CdkDiffStackWorkflow\n\n`CdkDiffStackWorkflow` renders a workflow per stack named `diff-<StackName>.yml` under `.github/workflows/`. It also generates a helper script at `.github/workflows/scripts/describe-cfn-changeset.ts` that formats the change set output and takes care of posting the PR comment and Step Summary.\n\nExample `.projenrc.ts`:\n\n```ts\nimport { awscdk } from 'projen';\nimport { CdkDiffStackWorkflow } from '@jjrawlins/cdk-diff-pr-github-action';\n\nconst project = new awscdk.AwsCdkConstructLibrary({\n  // ... your usual settings ...\n  name: 'my-lib',\n  defaultReleaseBranch: 'main',\n  cdkVersion: '2.85.0',\n  github: true,\n});\n\nnew CdkDiffStackWorkflow({\n  project,\n  // Stacks to diff on PRs\n  stacks: [\n    {\n      stackName: 'MyAppStack',\n      cdkDiffRoleToAssumeArn: 'arn:aws:iam::123456789012:role/cdk-diff-role',\n      cdkDiffRoleToAssumeRegion: 'us-east-1',\n      // Optional per‑stack OIDC override (if not using the defaults below)\n      // oidcRoleArn: 'arn:aws:iam::123456789012:role/github-oidc-role',\n      // oidcRegion: 'us-east-1',\n    },\n  ],\n  // Default OIDC role/region used by all stacks unless overridden per‑stack\n  oidcRoleArn: 'arn:aws:iam::123456789012:role/github-oidc-role',\n  oidcRegion: 'us-east-1',\n  // Optional: Node version used in the workflow (default: '24.x')\n  // nodeVersion: '20.x',\n  // Optional: Yarn command to run CDK (default: 'cdk')\n  // cdkYarnCommand: 'cdk',\n  // Optional: Where to place the helper script\n  // scriptOutputPath: '.github/workflows/scripts/describe-cfn-changeset.ts',\n});\n\nproject.synth();\n```\n\n### Required properties\n- `project` (AwsCdkTypeScriptApp) — Your Projen project instance.\n- `stacks` (array) — One entry per CDK stack you want a diff for.\n- OIDC configuration: either\n  - Provide `oidcRoleArn` and `oidcRegion` at the top level, or\n  - Provide `oidcRoleArn` and `oidcRegion` on every stack item.\n\nIf neither the defaults nor all per‑stack values are supplied, the construct throws with a helpful error.\n\n### Stack item fields\n- `stackName` — The CDK stack name to create the change set for.\n- `cdkDiffRoleToAssumeArn` — The ARN of the role used to create the change set (role chaining after OIDC).\n- `cdkDiffRoleToAssumeRegion` — The region for that role.\n- `oidcRoleArn` (optional) — Per‑stack override for the OIDC role.\n- `oidcRegion` (optional) — Per‑stack override for the OIDC region.\n\n### What gets generated\n- `.github/workflows/diff-<StackName>.yml` — One workflow per stack, triggered on PR open/sync/reopen.\n- `.github/workflows/scripts/describe-cfn-changeset.ts` — A helper script that:\n  - Polls `DescribeChangeSet` until terminal\n  - Filters out ignorable logical IDs or resource types using environment variables `IGNORE_LOGICAL_IDS` and `IGNORE_RESOURCE_TYPES`\n  - Renders an HTML table with actions, logical IDs, types, replacements, and changed properties\n  - Prints the HTML, appends to the GitHub Step Summary, and (if `GITHUB_TOKEN` and `GITHUB_COMMENT_URL` are present) posts a PR comment\n\n### Environment variables used by the script\n- `STACK_NAME` (required) — Stack name to describe.\n- `CHANGE_SET_NAME` (default: same as `STACK_NAME`).\n- `AWS_REGION` — Region for CloudFormation API calls. The workflow sets this via the credentials action.\n- `GITHUB_TOKEN` (optional) — If set with `GITHUB_COMMENT_URL`, posts a PR comment.\n- `GITHUB_COMMENT_URL` (optional) — PR comments URL.\n- `GITHUB_STEP_SUMMARY` (optional) — When present, appends the HTML to the step summary file.\n- `IGNORE_LOGICAL_IDS` (optional) — Comma‑separated logical IDs to ignore (default includes `CDKMetadata`).\n- `IGNORE_RESOURCE_TYPES` (optional) — Comma‑separated resource types to ignore (e.g., `AWS::CDK::Metadata`).\n\n## Usage: CdkDiffIamTemplate\n\nAdd `CdkDiffIamTemplate` to your Projen project to emit an example IAM template you can deploy in your account:\n\n```ts\nimport { awscdk } from 'projen';\nimport { CdkDiffIamTemplate } from '@jjrawlins/cdk-diff-pr-github-action';\n\nconst project = new awscdk.AwsCdkConstructLibrary({\n  // ...\n});\n\nnew CdkDiffIamTemplate({ project });\n\nproject.synth();\n```\n\nThis will write `cdk-diff-workflow-iam-template.yaml` at the project root. The template defines:\n- A parameter `GitHubOIDCRoleArn` — pass the ARN of your existing GitHub OIDC role that will assume the change set role.\n- An IAM role `CdkChangesetRole` with minimal permissions for:\n  - CloudFormation Change Set operations\n  - Access to common CDK bootstrap S3 buckets and SSM parameters\n  - `iam:PassRole` to `cloudformation.amazonaws.com`\n- Outputs exporting the role name and ARN.\n\nYou can deploy the file via CloudFormation/StackSets and then use the created role ARN as the `cdkDiffRoleToAssumeArn` in your workflow configuration.\n\n## Testing\n\nThis repository includes Jest tests that snapshot the synthesized outputs from Projen and assert that:\n- Workflows are created per stack and contain all expected steps.\n- Only one script file is generated.\n- Per‑stack OIDC overrides are respected.\n- Helpful validation errors are thrown for missing OIDC settings.\n- The IAM template file contains the expected resources and outputs.\n\nRun tests with:\n\n```bash\nyarn test\n```\n\n## Notes\n- This package assumes your repository is configured with GitHub Actions and that you have a GitHub OIDC role configured in AWS.\n- The generated script uses the AWS SDK v3 for CloudFormation and posts comments using the GitHub REST API.\n"
+    "markdown": "# cdk-diff-pr-github-action\n\nA small Projen-based helper library that wires GitHub workflows for:\n- Creating CloudFormation Change Sets for your CDK stacks on pull requests and commenting a formatted diff back on the PR.\n- Detecting CloudFormation drift on a schedule or manual trigger and producing a consolidated summary (optionally creating an issue).\n\nIt also provides ready‑to‑deploy IAM templates with the minimal permissions required for each workflow.\n\nThis package exposes four constructs:\n\n- `CdkDiffStackWorkflow` — Generates one GitHub Actions workflow per stack to create a change set and render the diff back to the PR and Step Summary.\n- `CdkDiffIamTemplate` — Emits a CloudFormation template file with minimal permissions for the Change Set workflow.\n- `CdkDriftDetectionWorkflow` — Generates a GitHub Actions workflow to detect CloudFormation drift per stack, upload machine‑readable results, and aggregate a summary.\n- `CdkDriftIamTemplate` — Emits a CloudFormation template file with minimal permissions for the Drift Detection workflow.\n\n## Quick start\n\n1) Add the constructs to your Projen project (in `.projenrc.ts`).\n2) Synthesize with `npx projen`.\n3) Commit the generated files.\n4) Open a pull request or run the drift detection workflow.\n\n## Usage: CdkDiffStackWorkflow\n\n`CdkDiffStackWorkflow` renders a workflow per stack named `diff-<StackName>.yml` under `.github/workflows/`. It also generates a helper script at `.github/workflows/scripts/describe-cfn-changeset.ts` that formats the change set output and takes care of posting the PR comment and Step Summary.\n\nExample `.projenrc.ts`:\n\n```ts\nimport { awscdk } from 'projen';\nimport { CdkDiffStackWorkflow } from '@jjrawlins/cdk-diff-pr-github-action';\n\nconst project = new awscdk.AwsCdkConstructLibrary({\n  // ... your usual settings ...\n  workflowName: 'my-lib',\n  defaultReleaseBranch: 'main',\n  cdkVersion: '2.85.0',\n  github: true,\n});\n\nnew CdkDiffStackWorkflow({\n  project,\n  stacks: [\n    {\n      stackName: 'MyAppStack',\n      changesetRoleToAssumeArn: 'arn:aws:iam::123456789012:role/cdk-diff-role',\n      changesetRoleToAssumeRegion: 'us-east-1',\n      // Optional per‑stack OIDC override (if not using the defaults below)\n      // oidcRoleArn: 'arn:aws:iam::123456789012:role/github-oidc-role',\n      // oidcRegion: 'us-east-1',\n    },\n  ],\n  // Default OIDC role/region used by all stacks unless overridden per‑stack\n  oidcRoleArn: 'arn:aws:iam::123456789012:role/github-oidc-role',\n  oidcRegion: 'us-east-1',\n  // Optional: Node version used in the workflow (default: '24.x')\n  // nodeVersion: '24.x',\n  // Optional: Yarn command to run CDK (default: 'cdk')\n  // cdkYarnCommand: 'cdk',\n  // Optional: Where to place the helper script (default: '.github/workflows/scripts/describe-cfn-changeset.ts')\n  // scriptOutputPath: '.github/workflows/scripts/describe-cfn-changeset.ts',\n});\n\nproject.synth();\n```\n\n### CdkDiffStackWorkflow props\n- `project` (required) — Your Projen project instance.\n- `stacks` (required) — Array of stack entries.\n- `oidcRoleArn` (required unless provided per‑stack) — Default OIDC role ARN.\n- `oidcRegion` (required unless provided per‑stack) — Default OIDC region.\n- `nodeVersion` (optional, default `'24.x'`) — Node.js version for the workflow runner.\n- `cdkYarnCommand` (optional, default `'cdk'`) — Yarn script/command to invoke CDK.\n- `scriptOutputPath` (optional, default `'.github/workflows/scripts/describe-cfn-changeset.ts'`) — Where to write the helper script.\n\nIf neither top‑level OIDC defaults nor all per‑stack values are supplied, the construct throws a helpful error.\n\n### Stack item fields\n- `stackName` (required) — The CDK stack name to create the change set for.\n- `changesetRoleToAssumeArn` (required) — The ARN of the role used to create the change set (role chaining after OIDC).\n- `changesetRoleToAssumeRegion` (required) — The region for that role.\n- `oidcRoleArn` (optional) — Per‑stack override for the OIDC role.\n- `oidcRegion` (optional) — Per‑stack override for the OIDC region.\n\n### What gets generated\n- `.github/workflows/diff-<StackName>.yml` — One workflow per stack, triggered on PR open/sync/reopen.\n- `.github/workflows/scripts/describe-cfn-changeset.ts` — A helper script that:\n  - Polls `DescribeChangeSet` until terminal\n  - Filters out ignorable logical IDs or resource types using environment variables `IGNORE_LOGICAL_IDS` and `IGNORE_RESOURCE_TYPES`\n  - Renders an HTML table with actions, logical IDs, types, replacements, and changed properties\n  - Prints the HTML, appends to the GitHub Step Summary, and (if `GITHUB_TOKEN` and `GITHUB_COMMENT_URL` are present) posts a PR comment\n\n### Environment variables used by the change set script\n- `STACK_NAME` (required) — Stack name to describe.\n- `CHANGE_SET_NAME` (default: same as `STACK_NAME`).\n- `AWS_REGION` — Region for CloudFormation API calls. The workflow sets this via the credentials action(s).\n- `GITHUB_TOKEN` (optional) — If set with `GITHUB_COMMENT_URL`, posts a PR comment.\n- `GITHUB_COMMENT_URL` (optional) — PR comments URL.\n- `GITHUB_STEP_SUMMARY` (optional) — When present, appends the HTML to the step summary file.\n- `IGNORE_LOGICAL_IDS` (optional) — Comma‑separated logical IDs to ignore (default includes `CDKMetadata`).\n- `IGNORE_RESOURCE_TYPES` (optional) — Comma‑separated resource types to ignore (e.g., `AWS::CDK::Metadata`).\n\n## Usage: CdkDiffIamTemplate\n\nEmit an example IAM template you can deploy in your account for the Change Set workflow:\n\n```ts\nimport { awscdk } from 'projen';\nimport { CdkDiffIamTemplate } from '@jjrawlins/cdk-diff-pr-github-action';\n\nconst project = new awscdk.AwsCdkConstructLibrary({\n  // ...\n});\n\nnew CdkDiffIamTemplate({\n  project,\n  roleName: 'cdk-diff-role',\n  oidcRoleArn: 'arn:aws:iam::123456789012:role/github-oidc-role',\n  oidcRegion: 'us-east-1',\n  // Optional: custom output path (default: 'cdk-diff-workflow-iam-template.yaml')\n  // outputPath: 'infra/cdk-diff-iam.yaml',\n});\n\nproject.synth();\n```\n\nThis writes `cdk-diff-workflow-iam-template.yaml` at the project root (or your chosen `outputPath`). The template defines:\n- Parameter `GitHubOIDCRoleArn` with a default from `oidcRoleArn` — the ARN of your existing GitHub OIDC role allowed to assume the change set role.\n- IAM role `CdkChangesetRole` with minimal permissions for:\n  - CloudFormation Change Set operations\n  - Access to common CDK bootstrap S3 buckets and SSM parameters\n  - `iam:PassRole` to `cloudformation.amazonaws.com`\n- Outputs exporting the role name and ARN.\n\nA Projen task is also added:\n\n```bash\nnpx projen deploy-cdkdiff-iam-template -- --parameter-overrides GitHubOIDCRoleArn=... # plus any extra AWS CLI args\n```\n\nUse the created role ARN as `changesetRoleToAssumeArn` in `CdkDiffStackWorkflow`.\n\n---\n\n## Usage: CdkDriftDetectionWorkflow\n\n`CdkDriftDetectionWorkflow` creates a single workflow file (default `drift-detection.yml`) that can run on a schedule and via manual dispatch. It generates a helper script at `.github/workflows/scripts/detect-drift.ts` (by default) that uses AWS SDK v3 to run drift detection, write optional machine‑readable JSON, and print an HTML report for the Step Summary.\n\nExample `.projenrc.ts`:\n\n```ts\nimport { awscdk } from 'projen';\nimport { CdkDriftDetectionWorkflow } from '@jjrawlins/cdk-diff-pr-github-action';\n\nconst project = new awscdk.AwsCdkConstructLibrary({ github: true, /* ... */ });\n\nnew CdkDriftDetectionWorkflow({\n  project,\n  workflowName: 'Drift Detection',            // optional; file name derived as 'drift-detection.yml'\n  schedule: '0 1 * * *',                      // optional cron\n  createIssues: true,                         // default true; create/update issue when drift detected on schedule\n  oidcRoleArn: 'arn:aws:iam::123456789012:role/github-oidc-role',\n  oidcRegion: 'us-east-1',\n  // Optional: Node version (default '24.x')\n  // nodeVersion: '24.x',\n  // Optional: Where to place the helper script (default '.github/workflows/scripts/detect-drift.ts')\n  // scriptOutputPath: '.github/workflows/scripts/detect-drift.ts',\n  stacks: [\n    {\n      stackName: 'MyAppStack-Prod',\n      driftDetectionRoleToAssumeArn: 'arn:aws:iam::123456789012:role/cdk-drift-role',\n      driftDetectionRoleToAssumeRegion: 'us-east-1',\n      // failOnDrift: true, // optional (default true)\n    },\n  ],\n});\n\nproject.synth();\n```\n\n### CdkDriftDetectionWorkflow props\n- `project` (required) — Your Projen project instance.\n- `stacks` (required) — Array of stacks to check.\n- `oidcRoleArn` (required) — Default OIDC role ARN used before chaining into per‑stack drift roles.\n- `oidcRegion` (required) — Default OIDC region.\n- `workflowName` (optional, default `'drift-detection'`) — Human‑friendly workflow name; the file name is derived in kebab‑case.\n- `schedule` (optional) — Cron expression for automatic runs.\n- `createIssues` (optional, default `true`) — When true, scheduled runs will create/update a GitHub issue if drift is detected.\n- `nodeVersion` (optional, default `'24.x'`) — Node.js version for the runner.\n- `scriptOutputPath` (optional, default `'.github/workflows/scripts/detect-drift.ts'`) — Where to write the helper script.\n\n### Per‑stack fields\n- `stackName` (required) — The full CloudFormation stack name.\n- `driftDetectionRoleToAssumeArn` (required) — Role to assume (after OIDC) for making drift API calls.\n- `driftDetectionRoleToAssumeRegion` (required) — Region for that role and API calls.\n- `failOnDrift` (optional, default `true`) — Intended to fail the detection step on drift. The provided script exits with non‑zero when drift is found; the job continues to allow artifact upload and issue creation.\n\n### What gets generated\n- `.github/workflows/<kebab(workflowName)>.yml` — A workflow with one job per stack plus a final summary job.\n- `.github/workflows/scripts/detect-drift.ts` — Helper script that:\n  - Starts drift detection and polls until completion\n  - Lists non‑`IN_SYNC` resources and builds an HTML report\n  - Writes optional JSON to `DRIFT_DETECTION_OUTPUT` when set\n  - Prints to stdout and appends to the GitHub Step Summary when available\n\n### Artifacts and summary\n- Each stack job uploads `drift-results-<stack>.json` (if produced).\n- A final `Drift Detection Summary` job downloads all artifacts and prints a consolidated summary.\n\n### Manual dispatch\n- The workflow exposes an input named `stack` with choices including each configured stack and an `all` option.\n- Choose a specific stack to run drift detection for that stack only, or select `all` (or leave the input empty) to run all stacks.\n\nNote: The default workflow does not post PR comments for drift. It can create/update an Issue on scheduled runs when `createIssues` is `true`.\n\n### Post-notification steps (e.g., Slack)\n\nYou can add your own GitHub Action steps to run after the drift detection step for each stack using `postGitHubSteps`.\nProvide your own Slack payload/markdown (this library no longer generates a payload step for you).\n\nOption A: slackapi/slack-github-action (Incoming Webhook, official syntax)\n\n```ts\nnew CdkDriftDetectionWorkflow({\n  project,\n  oidcRoleArn: 'arn:aws:iam::123456789012:role/github-oidc-role',\n  oidcRegion: 'us-east-1',\n  stacks: [/* ... */],\n  postGitHubSteps: ({ stack }) => {\n    // Build a descriptive name per stack\n    const name = `Notify Slack (${stack} post-drift)`;\n    const step = {\n      name,\n      uses: 'slackapi/slack-github-action@v2.1.1',\n      // by default, post steps run only when drift is detected; you can override `if`\n      if: \"always() && steps.drift.outcome == 'failure'\",\n      // Use official inputs: webhook + webhook-type, and a YAML payload with blocks\n      with: {\n        webhook: '${{ secrets.CDK_NOTIFICATIONS_SLACK_WEBHOOK }}',\n        'webhook-type': 'incoming-webhook',\n        payload: [\n          'text: \"** ${{ env.STACK_NAME }} ** has drifted!\"',\n          'blocks:',\n          '  - type: \"section\"',\n          '    text:',\n          '      type: \"mrkdwn\"',\n          '      text: \"*Stack:* ${{ env.STACK_NAME }} (region ${{ env.AWS_REGION }}) has drifted:exclamation:\"',\n          '  - type: \"section\"',\n          '    fields:',\n          '      - type: \"mrkdwn\"',\n          '        text: \"*Stack ARN*\\\\n${{ steps.drift.outputs.stack-arn }}\"',\n          '      - type: \"mrkdwn\"',\n          '        text: \"*Issue*\\\\n<${{ github.server_url }}/${{ github.repository }}/issues/${{ steps.issue.outputs.result }}|#${{ steps.issue.outputs.result }}>\"',\n        ].join('\\n'),\n      },\n    };\n    return [step];\n  },\n});\n```\n\nNote: The Issue link requires `createIssues: true` (default) so that the `Create Issue on Drift` step runs before this Slack step and exposes `steps.issue.outputs.result`. This library orders the steps accordingly.\n\nDetails:\n- `postGitHubSteps` can be:\n  - an array of step objects, or\n  - a factory function `({ stack }) => step | step[]`.\n- Each step you provide is inserted after the results are uploaded.\n- Default condition: if you do not set `if` on your step, it will default to `always() && steps.drift.outcome == 'failure'`.\n- Available context/env you can use:\n  - `${{ env.STACK_NAME }}`, `${{ env.DRIFT_DETECTION_OUTPUT }}`\n  - `${{ steps.drift.outcome }}` — success/failure of the detect step\n  - `${{ steps.drift.outputs.stack-arn }}` — Stack ARN resolved at runtime\n  - `${{ steps.issue.outputs.result }}` — Issue number if the workflow created/found one (empty when not applicable)\n```\n\n## Usage: CdkDriftIamTemplate\n\nEmit an example IAM template you can deploy in your account for the Drift Detection workflow:\n\n```ts\nimport { awscdk } from 'projen';\nimport { CdkDriftIamTemplate } from '@jjrawlins/cdk-diff-pr-github-action';\n\nconst project = new awscdk.AwsCdkConstructLibrary({\n  // ...\n});\n\nnew CdkDriftIamTemplate({\n  project,\n  roleName: 'cdk-drift-role',\n  oidcRoleArn: 'arn:aws:iam::123456789012:role/github-oidc-role',\n  oidcRegion: 'us-east-1',\n  // Optional: custom output path (default: 'cdk-drift-workflow-iam-template.yaml')\n  // outputPath: 'infra/cdk-drift-iam.yaml',\n});\n\nproject.synth();\n```\n\nThis writes `cdk-drift-workflow-iam-template.yaml` at the project root (or your chosen `outputPath`). The template defines:\n- Parameter `GitHubOIDCRoleArn` with a default from `oidcRoleArn` — the ARN of your existing GitHub OIDC role allowed to assume this drift role.\n- IAM role `CdkDriftRole` with minimal permissions for CloudFormation drift detection operations.\n- Outputs exporting the role name and ARN.\n\nA Projen task is also added:\n\n```bash\nnpx projen deploy-cdkdrift-iam-template -- --parameter-overrides GitHubOIDCRoleArn=... # plus any extra AWS CLI args\n```\n\n## Testing\n\nThis repository includes Jest tests that snapshot the synthesized outputs from Projen and assert that:\n- Diff workflows are created per stack and contain all expected steps.\n- Drift detection workflow produces one job per stack and a summary job.\n- Only one helper script file is generated per workflow type.\n- Per‑stack OIDC overrides (where supported) are respected.\n- Helpful validation errors are thrown for missing OIDC settings.\n- The IAM template files contain the expected resources and outputs.\n\nRun tests with:\n\n```bash\nyarn test\n```\n\n## Notes\n- This package assumes your repository is configured with GitHub Actions and that you have a GitHub OIDC role configured in AWS.\n- The generated scripts use the AWS SDK v3 for CloudFormation and, where applicable, the GitHub REST API.\n"
   },
   "repository": {
     "type": "git",
@@ -3564,16 +3564,16 @@
     "@jjrawlins/cdk-diff-pr-github-action.CdkDiffIamTemplate": {
       "assembly": "@jjrawlins/cdk-diff-pr-github-action",
       "docs": {
-        "stability": "stable"
+        "stability": "experimental"
       },
       "fqn": "@jjrawlins/cdk-diff-pr-github-action.CdkDiffIamTemplate",
       "initializer": {
         "docs": {
-          "stability": "stable"
+          "stability": "experimental"
         },
         "locationInModule": {
           "filename": "src/CdkDiffIamTemplate.ts",
-          "line": 10
+          "line": 12
         },
         "parameters": [
           {
@@ -3587,7 +3587,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/CdkDiffIamTemplate.ts",
-        "line": 9
+        "line": 11
       },
       "name": "CdkDiffIamTemplate",
       "symbolId": "src/CdkDiffIamTemplate:CdkDiffIamTemplate"
@@ -3596,7 +3596,7 @@
       "assembly": "@jjrawlins/cdk-diff-pr-github-action",
       "datatype": true,
       "docs": {
-        "stability": "stable"
+        "stability": "experimental"
       },
       "fqn": "@jjrawlins/cdk-diff-pr-github-action.CdkDiffIamTemplateProps",
       "kind": "interface",
@@ -3609,7 +3609,37 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/CdkDiffIamTemplate.ts",
+            "line": 8
+          },
+          "name": "oidcRegion",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/CdkDiffIamTemplate.ts",
+            "line": 7
+          },
+          "name": "oidcRoleArn",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
           },
           "immutable": true,
           "locationInModule": {
@@ -3624,15 +3654,14 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "stability": "experimental"
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/CdkDiffIamTemplate.ts",
             "line": 5
           },
-          "name": "outputPath",
-          "optional": true,
+          "name": "roleName",
           "type": {
             "primitive": "string"
           }
@@ -3640,14 +3669,14 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "stability": "experimental"
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/CdkDiffIamTemplate.ts",
             "line": 6
           },
-          "name": "stackName",
+          "name": "outputPath",
           "optional": true,
           "type": {
             "primitive": "string"
@@ -3660,7 +3689,7 @@
       "assembly": "@jjrawlins/cdk-diff-pr-github-action",
       "datatype": true,
       "docs": {
-        "stability": "stable"
+        "stability": "experimental"
       },
       "fqn": "@jjrawlins/cdk-diff-pr-github-action.CdkDiffStack",
       "kind": "interface",
@@ -3673,14 +3702,14 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "stability": "experimental"
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/CdkDiffStackWorkflow.ts",
             "line": 11
           },
-          "name": "cdkDiffRoleToAssumeArn",
+          "name": "changesetRoleToAssumeArn",
           "type": {
             "primitive": "string"
           }
@@ -3688,14 +3717,14 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "stability": "experimental"
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/CdkDiffStackWorkflow.ts",
             "line": 12
           },
-          "name": "cdkDiffRoleToAssumeRegion",
+          "name": "changesetRoleToAssumeRegion",
           "type": {
             "primitive": "string"
           }
@@ -3703,7 +3732,7 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "stability": "experimental"
           },
           "immutable": true,
           "locationInModule": {
@@ -3718,7 +3747,7 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "stability": "experimental"
           },
           "immutable": true,
           "locationInModule": {
@@ -3734,7 +3763,7 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "stability": "experimental"
           },
           "immutable": true,
           "locationInModule": {
@@ -3753,12 +3782,12 @@
     "@jjrawlins/cdk-diff-pr-github-action.CdkDiffStackWorkflow": {
       "assembly": "@jjrawlins/cdk-diff-pr-github-action",
       "docs": {
-        "stability": "stable"
+        "stability": "experimental"
       },
       "fqn": "@jjrawlins/cdk-diff-pr-github-action.CdkDiffStackWorkflow",
       "initializer": {
         "docs": {
-          "stability": "stable"
+          "stability": "experimental"
         },
         "locationInModule": {
           "filename": "src/CdkDiffStackWorkflow.ts",
@@ -3785,7 +3814,7 @@
       "assembly": "@jjrawlins/cdk-diff-pr-github-action",
       "datatype": true,
       "docs": {
-        "stability": "stable"
+        "stability": "experimental"
       },
       "fqn": "@jjrawlins/cdk-diff-pr-github-action.CdkDiffStackWorkflowProps",
       "kind": "interface",
@@ -3798,7 +3827,7 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "stability": "experimental"
           },
           "immutable": true,
           "locationInModule": {
@@ -3813,7 +3842,7 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "stability": "experimental"
           },
           "immutable": true,
           "locationInModule": {
@@ -3828,7 +3857,7 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "stability": "experimental"
           },
           "immutable": true,
           "locationInModule": {
@@ -3843,7 +3872,7 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "stability": "experimental"
           },
           "immutable": true,
           "locationInModule": {
@@ -3863,7 +3892,7 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "stability": "experimental"
           },
           "immutable": true,
           "locationInModule": {
@@ -3879,7 +3908,7 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "stability": "experimental"
           },
           "immutable": true,
           "locationInModule": {
@@ -3895,7 +3924,7 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "stability": "experimental"
           },
           "immutable": true,
           "locationInModule": {
@@ -3910,8 +3939,421 @@
         }
       ],
       "symbolId": "src/CdkDiffStackWorkflow:CdkDiffStackWorkflowProps"
+    },
+    "@jjrawlins/cdk-diff-pr-github-action.CdkDriftDetectionWorkflow": {
+      "assembly": "@jjrawlins/cdk-diff-pr-github-action",
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@jjrawlins/cdk-diff-pr-github-action.CdkDriftDetectionWorkflow",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/CdkDriftDetectionWorkflow.ts",
+          "line": 61
+        },
+        "parameters": [
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@jjrawlins/cdk-diff-pr-github-action.CdkDriftDetectionWorkflowProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/CdkDriftDetectionWorkflow.ts",
+        "line": 58
+      },
+      "name": "CdkDriftDetectionWorkflow",
+      "symbolId": "src/CdkDriftDetectionWorkflow:CdkDriftDetectionWorkflow"
+    },
+    "@jjrawlins/cdk-diff-pr-github-action.CdkDriftDetectionWorkflowProps": {
+      "assembly": "@jjrawlins/cdk-diff-pr-github-action",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@jjrawlins/cdk-diff-pr-github-action.CdkDriftDetectionWorkflowProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/CdkDriftDetectionWorkflow.ts",
+        "line": 19
+      },
+      "name": "CdkDriftDetectionWorkflowProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/CdkDriftDetectionWorkflow.ts",
+            "line": 26
+          },
+          "name": "oidcRegion",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/CdkDriftDetectionWorkflow.ts",
+            "line": 25
+          },
+          "name": "oidcRoleArn",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/CdkDriftDetectionWorkflow.ts",
+            "line": 21
+          },
+          "name": "project",
+          "type": {
+            "primitive": "any"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/CdkDriftDetectionWorkflow.ts",
+            "line": 27
+          },
+          "name": "stacks",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "@jjrawlins/cdk-diff-pr-github-action.Stack"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/CdkDriftDetectionWorkflow.ts",
+            "line": 24
+          },
+          "name": "createIssues",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/CdkDriftDetectionWorkflow.ts",
+            "line": 28
+          },
+          "name": "nodeVersion",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "These steps run after results are uploaded for each stack. You can include\nany notifications you like (e.g., Slack). Provide explicit inputs (e.g., payload/markdown)\ndirectly in your step without relying on a pre-generated payload.",
+            "stability": "experimental",
+            "summary": "Optional additional GitHub Action steps to run after drift detection for each stack."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/CdkDriftDetectionWorkflow.ts",
+            "line": 43
+          },
+          "name": "postGitHubSteps",
+          "optional": true,
+          "type": {
+            "primitive": "any"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/CdkDriftDetectionWorkflow.ts",
+            "line": 23
+          },
+          "name": "schedule",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/CdkDriftDetectionWorkflow.ts",
+            "line": 20
+          },
+          "name": "scriptOutputPath",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/CdkDriftDetectionWorkflow.ts",
+            "line": 22
+          },
+          "name": "workflowName",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/CdkDriftDetectionWorkflow:CdkDriftDetectionWorkflowProps"
+    },
+    "@jjrawlins/cdk-diff-pr-github-action.CdkDriftIamTemplate": {
+      "assembly": "@jjrawlins/cdk-diff-pr-github-action",
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@jjrawlins/cdk-diff-pr-github-action.CdkDriftIamTemplate",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/CdkDriftIamTemplate.ts",
+          "line": 12
+        },
+        "parameters": [
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@jjrawlins/cdk-diff-pr-github-action.CdkDriftIamTemplateProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/CdkDriftIamTemplate.ts",
+        "line": 11
+      },
+      "name": "CdkDriftIamTemplate",
+      "symbolId": "src/CdkDriftIamTemplate:CdkDriftIamTemplate"
+    },
+    "@jjrawlins/cdk-diff-pr-github-action.CdkDriftIamTemplateProps": {
+      "assembly": "@jjrawlins/cdk-diff-pr-github-action",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@jjrawlins/cdk-diff-pr-github-action.CdkDriftIamTemplateProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/CdkDriftIamTemplate.ts",
+        "line": 3
+      },
+      "name": "CdkDriftIamTemplateProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/CdkDriftIamTemplate.ts",
+            "line": 8
+          },
+          "name": "oidcRegion",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/CdkDriftIamTemplate.ts",
+            "line": 7
+          },
+          "name": "oidcRoleArn",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/CdkDriftIamTemplate.ts",
+            "line": 4
+          },
+          "name": "project",
+          "type": {
+            "primitive": "any"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/CdkDriftIamTemplate.ts",
+            "line": 5
+          },
+          "name": "roleName",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/CdkDriftIamTemplate.ts",
+            "line": 6
+          },
+          "name": "outputPath",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/CdkDriftIamTemplate:CdkDriftIamTemplateProps"
+    },
+    "@jjrawlins/cdk-diff-pr-github-action.Stack": {
+      "assembly": "@jjrawlins/cdk-diff-pr-github-action",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@jjrawlins/cdk-diff-pr-github-action.Stack",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/CdkDriftDetectionWorkflow.ts",
+        "line": 12
+      },
+      "name": "Stack",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/CdkDriftDetectionWorkflow.ts",
+            "line": 15
+          },
+          "name": "driftDetectionRoleToAssumeArn",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/CdkDriftDetectionWorkflow.ts",
+            "line": 14
+          },
+          "name": "driftDetectionRoleToAssumeRegion",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/CdkDriftDetectionWorkflow.ts",
+            "line": 13
+          },
+          "name": "stackName",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/CdkDriftDetectionWorkflow.ts",
+            "line": 16
+          },
+          "name": "failOnDrift",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        }
+      ],
+      "symbolId": "src/CdkDriftDetectionWorkflow:Stack"
     }
   },
-  "version": "0.0.0",
-  "fingerprint": "tHH4O3w5aknRRboRsohbwELbBny5Nck+ehKsoWl+2Rw="
+  "version": "0.0.1",
+  "fingerprint": "62FlJyv5w3wGfslAmiFuV2BoO5X85O4YBegVN0J0GD0="
 }