@macedon-technologies/batman 1.30.0 → 1.31.0

package/API.md

@@ -3281,6 +3281,563 @@ Indicates if the file should be read-only or read-write.
 ---
 
 
+### PrAutoMergeWorkflow <a name="PrAutoMergeWorkflow" id="@macedon-technologies/batman.PrAutoMergeWorkflow"></a>
+
+Generates `.github/workflows/pr-auto-merge.yml`, which arms GitHub's native squash auto-merge on every ready pull request into the default branch using a GitHub App installation token. It runs on `pull_request_target` in the `auto-merge` environment, which holds the `AUTO_MERGE_APP_CLIENT_ID` variable and the `AUTO_MERGE_APP_PRIVATE_KEY` secret, so workflows from pull request branches can't read the key. The job never checks out pull request code.
+
+#### Initializers <a name="Initializers" id="@macedon-technologies/batman.PrAutoMergeWorkflow.Initializer"></a>
+
+```typescript
+import { PrAutoMergeWorkflow } from '@macedon-technologies/batman'
+
+new PrAutoMergeWorkflow(project: Project, options?: PrAutoMergeWorkflowOptions)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | *No description.* |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.Initializer.parameter.options">options</a></code> | <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflowOptions">PrAutoMergeWorkflowOptions</a></code> | *No description.* |
+
+---
+
+##### `project`<sup>Required</sup> <a name="project" id="@macedon-technologies/batman.PrAutoMergeWorkflow.Initializer.parameter.project"></a>
+
+- *Type:* projen.Project
+
+---
+
+##### `options`<sup>Optional</sup> <a name="options" id="@macedon-technologies/batman.PrAutoMergeWorkflow.Initializer.parameter.options"></a>
+
+- *Type:* <a href="#@macedon-technologies/batman.PrAutoMergeWorkflowOptions">PrAutoMergeWorkflowOptions</a>
+
+---
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.toString">toString</a></code> | Returns a string representation of this construct. |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.with">with</a></code> | Applies one or more mixins to this construct. |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.postProjectCreation">postProjectCreation</a></code> | Called once, right after `postSynthesize()`, only when the project is created for the first time. |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.postSynthesize">postSynthesize</a></code> | Called after synthesis. |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.preSynthesize">preSynthesize</a></code> | Called before synthesis. |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.projectCreation">projectCreation</a></code> | Called once, right after `synthesize()`, only when the project is created for the first time. |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.synthesize">synthesize</a></code> | Writes the file to the project's output directory. |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.diff">diff</a></code> | Returns a unified diff of the old and new file contents with context lines and hunk headers. |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.addDeletionOverride">addDeletionOverride</a></code> | Syntactic sugar for `addOverride(path, undefined)`. |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.addOverride">addOverride</a></code> | Adds an override to the synthesized object file. |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.addToArray">addToArray</a></code> | Adds to an array in the synthesized object file. |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.patch">patch</a></code> | Applies an RFC 6902 JSON-patch to the synthesized object file. See https://datatracker.ietf.org/doc/html/rfc6902 for more information. |
+
+---
+
+##### `toString` <a name="toString" id="@macedon-technologies/batman.PrAutoMergeWorkflow.toString"></a>
+
+```typescript
+public toString(): string
+```
+
+Returns a string representation of this construct.
+
+##### `with` <a name="with" id="@macedon-technologies/batman.PrAutoMergeWorkflow.with"></a>
+
+```typescript
+public with(mixins: ...IMixin[]): IConstruct
+```
+
+Applies one or more mixins to this construct.
+
+Mixins are applied in order. The list of constructs is captured at the
+start of the call, so constructs added by a mixin will not be visited.
+Use multiple `with()` calls if subsequent mixins should apply to added
+constructs.
+
+###### `mixins`<sup>Required</sup> <a name="mixins" id="@macedon-technologies/batman.PrAutoMergeWorkflow.with.parameter.mixins"></a>
+
+- *Type:* ...constructs.IMixin[]
+
+The mixins to apply.
+
+---
+
+##### `postProjectCreation` <a name="postProjectCreation" id="@macedon-technologies/batman.PrAutoMergeWorkflow.postProjectCreation"></a>
+
+```typescript
+public postProjectCreation(initProject: InitProject): void
+```
+
+Called once, right after `postSynthesize()`, only when the project is created for the first time.
+
+It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`).
+It is also skipped when post-synthesis steps are disabled, e.g. `--no-post` or `PROJEN_DISABLE_POST`.
+Use it for one-off setup that can be turned off by the user, like running a task to give the user immediate
+feedback on their new project. Order across components is not guaranteed.
+
+###### `initProject`<sup>Required</sup> <a name="initProject" id="@macedon-technologies/batman.PrAutoMergeWorkflow.postProjectCreation.parameter.initProject"></a>
+
+- *Type:* projen.InitProject
+
+Details about how the project was created, e.g. its type and the original CLI args.
+
+---
+
+##### `postSynthesize` <a name="postSynthesize" id="@macedon-technologies/batman.PrAutoMergeWorkflow.postSynthesize"></a>
+
+```typescript
+public postSynthesize(): void
+```
+
+Called after synthesis.
+
+Order is *not* guaranteed.
+
+##### `preSynthesize` <a name="preSynthesize" id="@macedon-technologies/batman.PrAutoMergeWorkflow.preSynthesize"></a>
+
+```typescript
+public preSynthesize(): void
+```
+
+Called before synthesis.
+
+##### `projectCreation` <a name="projectCreation" id="@macedon-technologies/batman.PrAutoMergeWorkflow.projectCreation"></a>
+
+```typescript
+public projectCreation(initProject: InitProject): void
+```
+
+Called once, right after `synthesize()`, only when the project is created for the first time.
+
+It does not run on later `projen` invocations. It only fires for `projen new` (or `Projects.createProject`).
+Use it for deterministic, one-off file generation. Order across components is not guaranteed.
+
+###### `initProject`<sup>Required</sup> <a name="initProject" id="@macedon-technologies/batman.PrAutoMergeWorkflow.projectCreation.parameter.initProject"></a>
+
+- *Type:* projen.InitProject
+
+Details about how the project was created, e.g. its type and the original CLI args.
+
+---
+
+##### `synthesize` <a name="synthesize" id="@macedon-technologies/batman.PrAutoMergeWorkflow.synthesize"></a>
+
+```typescript
+public synthesize(): void
+```
+
+Writes the file to the project's output directory.
+
+##### `diff` <a name="diff" id="@macedon-technologies/batman.PrAutoMergeWorkflow.diff"></a>
+
+```typescript
+public diff(colorize?: boolean, contextLines?: number): string[]
+```
+
+Returns a unified diff of the old and new file contents with context lines and hunk headers.
+
+Only available after synthesis.
+
+This is an expensive operation and should only be used on non time-critical
+code paths, like debug output.
+
+###### `colorize`<sup>Optional</sup> <a name="colorize" id="@macedon-technologies/batman.PrAutoMergeWorkflow.diff.parameter.colorize"></a>
+
+- *Type:* boolean
+
+Whether to colorize the diff output.
+
+---
+
+###### `contextLines`<sup>Optional</sup> <a name="contextLines" id="@macedon-technologies/batman.PrAutoMergeWorkflow.diff.parameter.contextLines"></a>
+
+- *Type:* number
+
+Number of context lines around changes.
+
+---
+
+##### `addDeletionOverride` <a name="addDeletionOverride" id="@macedon-technologies/batman.PrAutoMergeWorkflow.addDeletionOverride"></a>
+
+```typescript
+public addDeletionOverride(path: string): void
+```
+
+Syntactic sugar for `addOverride(path, undefined)`.
+
+###### `path`<sup>Required</sup> <a name="path" id="@macedon-technologies/batman.PrAutoMergeWorkflow.addDeletionOverride.parameter.path"></a>
+
+- *Type:* string
+
+The path of the value to delete.
+
+---
+
+##### `addOverride` <a name="addOverride" id="@macedon-technologies/batman.PrAutoMergeWorkflow.addOverride"></a>
+
+```typescript
+public addOverride(path: string, value: any): void
+```
+
+Adds an override to the synthesized object file.
+
+If the override is nested, separate each nested level using a dot (.) in the path parameter.
+If there is an array as part of the nesting, specify the index in the path.
+
+To include a literal `.` in the property name, prefix with a `\`. In most
+programming languages you will need to write this as `"\\."` because the
+`\` itself will need to be escaped.
+
+For example,
+```typescript
+project.tsconfig.file.addOverride('compilerOptions.alwaysStrict', true);
+project.tsconfig.file.addOverride('compilerOptions.lib', ['dom', 'dom.iterable', 'esnext']);
+```
+would add the overrides
+```json
+"compilerOptions": {
+  "alwaysStrict": true,
+  "lib": [
+    "dom",
+    "dom.iterable",
+    "esnext"
+  ]
+  ...
+}
+...
+```
+
+###### `path`<sup>Required</sup> <a name="path" id="@macedon-technologies/batman.PrAutoMergeWorkflow.addOverride.parameter.path"></a>
+
+- *Type:* string
+
+The path of the property, you can use dot notation to override values in complex types.
+
+Any intermediate keys
+will be created as needed.
+
+---
+
+###### `value`<sup>Required</sup> <a name="value" id="@macedon-technologies/batman.PrAutoMergeWorkflow.addOverride.parameter.value"></a>
+
+- *Type:* any
+
+The value.
+
+Could be primitive or complex.
+
+---
+
+##### `addToArray` <a name="addToArray" id="@macedon-technologies/batman.PrAutoMergeWorkflow.addToArray"></a>
+
+```typescript
+public addToArray(path: string, values: ...any[]): void
+```
+
+Adds to an array in the synthesized object file.
+
+If the array is nested, separate each nested level using a dot (.) in the path parameter.
+If there is an array as part of the nesting, specify the index in the path.
+
+To include a literal `.` in the property name, prefix with a `\`. In most
+programming languages you will need to write this as `"\\."` because the
+`\` itself will need to be escaped.
+
+For example, with the following object file
+```json
+"compilerOptions": {
+  "exclude": ["node_modules"],
+  "lib": ["es2020"]
+  ...
+}
+...
+```
+
+```typescript
+project.tsconfig.file.addToArray('compilerOptions.exclude', 'coverage');
+project.tsconfig.file.addToArray('compilerOptions.lib', 'dom', 'dom.iterable', 'esnext');
+```
+would result in the following object file
+```json
+"compilerOptions": {
+  "exclude": ["node_modules", "coverage"],
+  "lib": ["es2020", "dom", "dom.iterable", "esnext"]
+  ...
+}
+...
+```
+
+###### `path`<sup>Required</sup> <a name="path" id="@macedon-technologies/batman.PrAutoMergeWorkflow.addToArray.parameter.path"></a>
+
+- *Type:* string
+
+The path of the property, you can use dot notation to att to arrays in complex types.
+
+Any intermediate keys
+will be created as needed.
+
+---
+
+###### `values`<sup>Required</sup> <a name="values" id="@macedon-technologies/batman.PrAutoMergeWorkflow.addToArray.parameter.values"></a>
+
+- *Type:* ...any[]
+
+The values to add.
+
+Could be primitive or complex.
+
+---
+
+##### `patch` <a name="patch" id="@macedon-technologies/batman.PrAutoMergeWorkflow.patch"></a>
+
+```typescript
+public patch(patches: ...JsonPatch[]): void
+```
+
+Applies an RFC 6902 JSON-patch to the synthesized object file. See https://datatracker.ietf.org/doc/html/rfc6902 for more information.
+
+For example, with the following object file
+```json
+"compilerOptions": {
+  "exclude": ["node_modules"],
+  "lib": ["es2020"]
+  ...
+}
+...
+```
+
+```typescript
+project.tsconfig.file.patch(JsonPatch.add("/compilerOptions/exclude/-", "coverage"));
+project.tsconfig.file.patch(JsonPatch.replace("/compilerOptions/lib", ["dom", "dom.iterable", "esnext"]));
+```
+would result in the following object file
+```json
+"compilerOptions": {
+  "exclude": ["node_modules", "coverage"],
+  "lib": ["dom", "dom.iterable", "esnext"]
+  ...
+}
+...
+```
+
+###### `patches`<sup>Required</sup> <a name="patches" id="@macedon-technologies/batman.PrAutoMergeWorkflow.patch.parameter.patches"></a>
+
+- *Type:* ...projen.JsonPatch[]
+
+The patch operations to apply.
+
+---
+
+#### Static Functions <a name="Static Functions" id="Static Functions"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.isComponent">isComponent</a></code> | Test whether the given construct is a component. |
+
+---
+
+##### `isConstruct` <a name="isConstruct" id="@macedon-technologies/batman.PrAutoMergeWorkflow.isConstruct"></a>
+
+```typescript
+import { PrAutoMergeWorkflow } from '@macedon-technologies/batman'
+
+PrAutoMergeWorkflow.isConstruct(x: any)
+```
+
+Checks if `x` is a construct.
+
+Use this method instead of `instanceof` to properly detect `Construct`
+instances, even when the construct library is symlinked.
+
+Explanation: in JavaScript, multiple copies of the `constructs` library on
+disk are seen as independent, completely different libraries. As a
+consequence, the class `Construct` in each copy of the `constructs` library
+is seen as a different class, and an instance of one class will not test as
+`instanceof` the other class. `npm install` will not create installations
+like this, but users may manually symlink construct libraries together or
+use a monorepo tool: in those cases, multiple copies of the `constructs`
+library can be accidentally installed, and `instanceof` will behave
+unpredictably. It is safest to avoid using `instanceof`, and using
+this type-testing method instead.
+
+###### `x`<sup>Required</sup> <a name="x" id="@macedon-technologies/batman.PrAutoMergeWorkflow.isConstruct.parameter.x"></a>
+
+- *Type:* any
+
+Any object.
+
+---
+
+##### `isComponent` <a name="isComponent" id="@macedon-technologies/batman.PrAutoMergeWorkflow.isComponent"></a>
+
+```typescript
+import { PrAutoMergeWorkflow } from '@macedon-technologies/batman'
+
+PrAutoMergeWorkflow.isComponent(x: any)
+```
+
+Test whether the given construct is a component.
+
+###### `x`<sup>Required</sup> <a name="x" id="@macedon-technologies/batman.PrAutoMergeWorkflow.isComponent.parameter.x"></a>
+
+- *Type:* any
+
+---
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.property.project">project</a></code> | <code>projen.Project</code> | *No description.* |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.property.absolutePath">absolutePath</a></code> | <code>string</code> | The absolute path of this file. |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.property.committed">committed</a></code> | <code>boolean</code> | Indicates if the file will be committed. |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.property.path">path</a></code> | <code>string</code> | The file path, relative to the project's outdir. |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.property.changed">changed</a></code> | <code>boolean</code> | Indicates if the file has been changed during synthesis. |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.property.marker">marker</a></code> | <code>string</code> | The projen marker, used to identify files as projen-generated. |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.property.executable">executable</a></code> | <code>boolean</code> | Indicates if the file should be marked as executable. |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.property.readonly">readonly</a></code> | <code>boolean</code> | Indicates if the file should be read-only or read-write. |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.property.omitEmpty">omitEmpty</a></code> | <code>boolean</code> | Indicates if empty objects and arrays are omitted from the output object. |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflow.property.lineWidth">lineWidth</a></code> | <code>number</code> | Maximum line width (set to 0 to disable folding). |
+
+---
+
+##### `node`<sup>Required</sup> <a name="node" id="@macedon-technologies/batman.PrAutoMergeWorkflow.property.node"></a>
+
+```typescript
+public readonly node: Node;
+```
+
+- *Type:* constructs.Node
+
+The tree node.
+
+---
+
+##### `project`<sup>Required</sup> <a name="project" id="@macedon-technologies/batman.PrAutoMergeWorkflow.property.project"></a>
+
+```typescript
+public readonly project: Project;
+```
+
+- *Type:* projen.Project
+
+---
+
+##### `absolutePath`<sup>Required</sup> <a name="absolutePath" id="@macedon-technologies/batman.PrAutoMergeWorkflow.property.absolutePath"></a>
+
+```typescript
+public readonly absolutePath: string;
+```
+
+- *Type:* string
+
+The absolute path of this file.
+
+---
+
+##### `committed`<sup>Required</sup> <a name="committed" id="@macedon-technologies/batman.PrAutoMergeWorkflow.property.committed"></a>
+
+```typescript
+public readonly committed: boolean;
+```
+
+- *Type:* boolean
+
+Indicates if the file will be committed.
+
+---
+
+##### `path`<sup>Required</sup> <a name="path" id="@macedon-technologies/batman.PrAutoMergeWorkflow.property.path"></a>
+
+```typescript
+public readonly path: string;
+```
+
+- *Type:* string
+
+The file path, relative to the project's outdir.
+
+---
+
+##### `changed`<sup>Optional</sup> <a name="changed" id="@macedon-technologies/batman.PrAutoMergeWorkflow.property.changed"></a>
+
+```typescript
+public readonly changed: boolean;
+```
+
+- *Type:* boolean
+
+Indicates if the file has been changed during synthesis.
+
+This property is
+only available in `postSynthesize()` hooks. If this is `undefined`, the
+file has not been synthesized yet.
+
+---
+
+##### `marker`<sup>Optional</sup> <a name="marker" id="@macedon-technologies/batman.PrAutoMergeWorkflow.property.marker"></a>
+
+```typescript
+public readonly marker: string;
+```
+
+- *Type:* string
+
+The projen marker, used to identify files as projen-generated.
+
+Value is undefined if the project is being ejected.
+
+---
+
+##### `executable`<sup>Required</sup> <a name="executable" id="@macedon-technologies/batman.PrAutoMergeWorkflow.property.executable"></a>
+
+```typescript
+public readonly executable: boolean;
+```
+
+- *Type:* boolean
+
+Indicates if the file should be marked as executable.
+
+---
+
+##### `readonly`<sup>Required</sup> <a name="readonly" id="@macedon-technologies/batman.PrAutoMergeWorkflow.property.readonly"></a>
+
+```typescript
+public readonly readonly: boolean;
+```
+
+- *Type:* boolean
+
+Indicates if the file should be read-only or read-write.
+
+---
+
+##### `omitEmpty`<sup>Required</sup> <a name="omitEmpty" id="@macedon-technologies/batman.PrAutoMergeWorkflow.property.omitEmpty"></a>
+
+```typescript
+public readonly omitEmpty: boolean;
+```
+
+- *Type:* boolean
+
+Indicates if empty objects and arrays are omitted from the output object.
+
+---
+
+##### `lineWidth`<sup>Required</sup> <a name="lineWidth" id="@macedon-technologies/batman.PrAutoMergeWorkflow.property.lineWidth"></a>
+
+```typescript
+public readonly lineWidth: number;
+```
+
+- *Type:* number
+
+Maximum line width (set to 0 to disable folding).
+
+---
+
+
 ### ProductionDeployWorkflow <a name="ProductionDeployWorkflow" id="@macedon-technologies/batman.ProductionDeployWorkflow"></a>
 
 #### Initializers <a name="Initializers" id="@macedon-technologies/batman.ProductionDeployWorkflow.Initializer"></a>
@@ -4703,6 +5260,7 @@ const batmanProjectOptions: BatmanProjectOptions = { ... }
 | <code><a href="#@macedon-technologies/batman.BatmanProjectOptions.property.attestationFiles">attestationFiles</a></code> | <code>string[]</code> | Extra files that the PR attestation manifest also hashes, such as the project's own verification checks. |
 | <code><a href="#@macedon-technologies/batman.BatmanProjectOptions.property.authorizerObjectVersion">authorizerObjectVersion</a></code> | <code>string</code> | Overrides the pinned S3 object version of the clerk-authorizer Lambda deployment package. |
 | <code><a href="#@macedon-technologies/batman.BatmanProjectOptions.property.e2eTesting">e2eTesting</a></code> | <code>boolean</code> | Whether the generated `web` app and its `PrDeployWorkflow` CI step include Playwright e2e testing support. |
+| <code><a href="#@macedon-technologies/batman.BatmanProjectOptions.property.prAutoMerge">prAutoMerge</a></code> | <code>boolean</code> | Generates the pr-auto-merge workflow, which arms squash auto-merge on ready pull requests into the default branch with a GitHub App token. |
 | <code><a href="#@macedon-technologies/batman.BatmanProjectOptions.property.websiteDeps">websiteDeps</a></code> | <code>string[]</code> | Website dependencies. |
 
 ---
@@ -7324,6 +7882,24 @@ Whether the generated `web` app and its `PrDeployWorkflow` CI step include Playw
 
 ---
 
+##### `prAutoMerge`<sup>Optional</sup> <a name="prAutoMerge" id="@macedon-technologies/batman.BatmanProjectOptions.property.prAutoMerge"></a>
+
+```typescript
+public readonly prAutoMerge: boolean;
+```
+
+- *Type:* boolean
+- *Default:* false
+
+Generates the pr-auto-merge workflow, which arms squash auto-merge on ready pull requests into the default branch with a GitHub App token.
+
+Requires the
+`AUTO_MERGE_APP_CLIENT_ID` variable and the
+`AUTO_MERGE_APP_PRIVATE_KEY` secret in an `auto-merge` environment; see the README section
+"Auto-merging pull requests with a GitHub App".
+
+---
+
 ##### `websiteDeps`<sup>Optional</sup> <a name="websiteDeps" id="@macedon-technologies/batman.BatmanProjectOptions.property.websiteDeps"></a>
 
 ```typescript
@@ -7530,6 +8106,7 @@ const bootcampProjectOptions: BootcampProjectOptions = { ... }
 | <code><a href="#@macedon-technologies/batman.BootcampProjectOptions.property.attestationFiles">attestationFiles</a></code> | <code>string[]</code> | Extra files that the PR attestation manifest also hashes, such as the project's own verification checks. |
 | <code><a href="#@macedon-technologies/batman.BootcampProjectOptions.property.authorizerObjectVersion">authorizerObjectVersion</a></code> | <code>string</code> | Overrides the pinned S3 object version of the clerk-authorizer Lambda deployment package. |
 | <code><a href="#@macedon-technologies/batman.BootcampProjectOptions.property.e2eTesting">e2eTesting</a></code> | <code>boolean</code> | Whether the generated `web` app and its `PrDeployWorkflow` CI step include Playwright e2e testing support. |
+| <code><a href="#@macedon-technologies/batman.BootcampProjectOptions.property.prAutoMerge">prAutoMerge</a></code> | <code>boolean</code> | Generates the pr-auto-merge workflow, which arms squash auto-merge on ready pull requests into the default branch with a GitHub App token. |
 | <code><a href="#@macedon-technologies/batman.BootcampProjectOptions.property.websiteDeps">websiteDeps</a></code> | <code>string[]</code> | Website dependencies. |
 
 ---
@@ -10151,6 +10728,24 @@ Whether the generated `web` app and its `PrDeployWorkflow` CI step include Playw
 
 ---
 
+##### `prAutoMerge`<sup>Optional</sup> <a name="prAutoMerge" id="@macedon-technologies/batman.BootcampProjectOptions.property.prAutoMerge"></a>
+
+```typescript
+public readonly prAutoMerge: boolean;
+```
+
+- *Type:* boolean
+- *Default:* false
+
+Generates the pr-auto-merge workflow, which arms squash auto-merge on ready pull requests into the default branch with a GitHub App token.
+
+Requires the
+`AUTO_MERGE_APP_CLIENT_ID` variable and the
+`AUTO_MERGE_APP_PRIVATE_KEY` secret in an `auto-merge` environment; see the README section
+"Auto-merging pull requests with a GitHub App".
+
+---
+
 ##### `websiteDeps`<sup>Optional</sup> <a name="websiteDeps" id="@macedon-technologies/batman.BootcampProjectOptions.property.websiteDeps"></a>
 
 ```typescript
@@ -10296,6 +10891,36 @@ public readonly additionalStackProps: {[ key: string ]: any};
 
 ---
 
+### PrAutoMergeWorkflowOptions <a name="PrAutoMergeWorkflowOptions" id="@macedon-technologies/batman.PrAutoMergeWorkflowOptions"></a>
+
+#### Initializer <a name="Initializer" id="@macedon-technologies/batman.PrAutoMergeWorkflowOptions.Initializer"></a>
+
+```typescript
+import { PrAutoMergeWorkflowOptions } from '@macedon-technologies/batman'
+
+const prAutoMergeWorkflowOptions: PrAutoMergeWorkflowOptions = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@macedon-technologies/batman.PrAutoMergeWorkflowOptions.property.actionVersions">actionVersions</a></code> | <code><a href="#@macedon-technologies/batman.WorkflowActionVersions">WorkflowActionVersions</a></code> | Overrides for the pinned action versions used by this workflow. |
+
+---
+
+##### `actionVersions`<sup>Optional</sup> <a name="actionVersions" id="@macedon-technologies/batman.PrAutoMergeWorkflowOptions.property.actionVersions"></a>
+
+```typescript
+public readonly actionVersions: WorkflowActionVersions;
+```
+
+- *Type:* <a href="#@macedon-technologies/batman.WorkflowActionVersions">WorkflowActionVersions</a>
+
+Overrides for the pinned action versions used by this workflow.
+
+---
+
 ### ProductionDeployWorkflowOptions <a name="ProductionDeployWorkflowOptions" id="@macedon-technologies/batman.ProductionDeployWorkflowOptions"></a>
 
 #### Initializer <a name="Initializer" id="@macedon-technologies/batman.ProductionDeployWorkflowOptions.Initializer"></a>
@@ -10558,6 +11183,7 @@ const workflowActionVersions: WorkflowActionVersions = { ... }
 | --- | --- | --- |
 | <code><a href="#@macedon-technologies/batman.WorkflowActionVersions.property.checkout">checkout</a></code> | <code>string</code> | The `actions/checkout` action reference. |
 | <code><a href="#@macedon-technologies/batman.WorkflowActionVersions.property.configureAwsCredentials">configureAwsCredentials</a></code> | <code>string</code> | The `aws-actions/configure-aws-credentials` action reference. |
+| <code><a href="#@macedon-technologies/batman.WorkflowActionVersions.property.createGithubAppToken">createGithubAppToken</a></code> | <code>string</code> | The `actions/create-github-app-token` action reference, used by the opt-in pr-auto-merge workflow to mint a GitHub App installation token. |
 | <code><a href="#@macedon-technologies/batman.WorkflowActionVersions.property.createPullRequest">createPullRequest</a></code> | <code>string</code> | The `peter-evans/create-pull-request` action reference, used by projen's built-in dependency-upgrade workflow to open the upgrade PR. |
 | <code><a href="#@macedon-technologies/batman.WorkflowActionVersions.property.downloadArtifact">downloadArtifact</a></code> | <code>string</code> | The `actions/download-artifact` action reference, used by projen's built-in dependency-upgrade workflow to pass the upgrade patch between jobs. |
 | <code><a href="#@macedon-technologies/batman.WorkflowActionVersions.property.githubScript">githubScript</a></code> | <code>string</code> | The `actions/github-script` action reference. |
@@ -10594,6 +11220,19 @@ The `aws-actions/configure-aws-credentials` action reference.
 
 ---
 
+##### `createGithubAppToken`<sup>Optional</sup> <a name="createGithubAppToken" id="@macedon-technologies/batman.WorkflowActionVersions.property.createGithubAppToken"></a>
+
+```typescript
+public readonly createGithubAppToken: string;
+```
+
+- *Type:* string
+- *Default:* 'actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1' // v3.2.0
+
+The `actions/create-github-app-token` action reference, used by the opt-in pr-auto-merge workflow to mint a GitHub App installation token.
+
+---
+
 ##### `createPullRequest`<sup>Optional</sup> <a name="createPullRequest" id="@macedon-technologies/batman.WorkflowActionVersions.property.createPullRequest"></a>
 
 ```typescript