@macedon-technologies/batman 1.30.0 → 1.32.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +155 -15
- package/API.md +639 -0
- package/README.md +82 -1
- package/attestation/manifest.ts +1 -0
- package/build-tools/scan-generated-workflows.ts +2 -0
- package/factory/work-item-sources.md +52 -0
- package/lib/ApiConstructFile.js +4 -1
- package/lib/Application.d.ts +9 -0
- package/lib/Application.js +7 -1
- package/lib/BaseApplicationStackFile.js +4 -4
- package/lib/BatmanProject.d.ts +9 -0
- package/lib/BatmanProject.js +4 -3
- package/lib/BootcampApplication.d.ts +9 -0
- package/lib/BootcampApplication.js +7 -1
- package/lib/BootcampBaseApplicationStackFile.js +4 -4
- package/lib/BootcampProject.js +4 -3
- package/lib/CodeOwnersFile.js +1 -1
- package/lib/PrAutoMergeWorkflow.d.ts +19 -0
- package/lib/PrAutoMergeWorkflow.js +84 -0
- package/lib/ProductionDeployWorkflow.js +1 -1
- package/lib/SoftwareFactoryAttestation.js +3 -1
- package/lib/SoftwareFactoryFiles.js +4 -2
- package/lib/SoftwareFactoryModels.js +28 -17
- package/lib/SoftwareFactoryWorkItemSources.d.ts +15 -0
- package/lib/SoftwareFactoryWorkItemSources.js +89 -0
- package/lib/StagingDeployWorkflow.js +3 -2
- package/lib/WorkflowActionVersions.d.ts +7 -0
- package/lib/WorkflowActionVersions.js +2 -1
- package/lib/index.d.ts +1 -0
- package/lib/index.js +2 -1
- package/lib/utils.d.ts +1 -1
- package/lib/utils.js +13 -7
- package/models/@swamp/software-factory/platform-common-factory.yaml +24 -15
- package/package.json +1 -1
package/.jsii
CHANGED
|
@@ -97,7 +97,7 @@
|
|
|
97
97
|
},
|
|
98
98
|
"name": "@macedon-technologies/batman",
|
|
99
99
|
"readme": {
|
|
100
|
-
"markdown": "# Platform Common Projen\n\nA baseline architecture template for new projects using Projen. This project provides a standardized foundation that includes both frontend and backend components with authentication.\n\n## Project Intention\n\nThis template serves as a starting point for new projects, providing:\n- Consistent project structure and configuration\n- Pre-configured development tooling\n- Integrated authentication system\n- Full-stack application foundation\n\n## Components Created\n\nThe BatmanProject generates:\n\n### Frontend\n- **React Application** - Modern React app with TypeScript\n- **Clerk Authentication** - Integrated user authentication and management\n- **Playwright e2e Testing** - `@playwright/test` + `@clerk/testing` devDeps, a `test:e2e` task, and a scaffolded `playwright.config.ts` + `e2e/` starter suite (see the generated `web/e2e/README.md`); disable with `e2eTesting: false`. The generated `pr-deploy.yml` workflow also runs this suite against each PR's deployed URL unless `e2eTesting: false` is set.\n\n### Backend/Infrastructure\n- **AWS Infrastructure** - CDK-based cloud resources\n- **API Gateway** - RESTful API endpoints\n- **Lambda Functions** - Serverless compute\n- **Database** - Persistent data storage\n\n## Usage Examples\n\n### Basic Project Creation\n\nCreate a `.projenrc.ts` file in your project root:\n\n```typescript\nimport { BatmanProject } from '@macedon-technologies/batman';\n\nconst project = new BatmanProject({\n name: 'my-new-app',\n defaultReleaseBranch: 'main',\n});\n\nproject.synth();\n```\n\nThen run:\n```bash\nnpx projen\n```\n\n### With Custom Configuration\n\nCreate a `.projenrc.ts` file with additional options:\n\n```typescript\nimport { BatmanProject } from '@macedon-technologies/batman';\n\nconst project = new BatmanProject({\n name: 'my-enterprise-app',\n defaultReleaseBranch: 'main',\n description: 'Enterprise application with authentication',\n authorName: 'Your Name',\n authorEmail: 'your.email@company.com',\n});\n\nproject.synth();\n```\n\nThen run:\n```bash\nnpx projen\n```\n\n### Development Workflow\n\n```bash\n# Install dependencies\nyarn install\n\n# Start development server\nyarn dev\n\n# Deploy infrastructure\nyarn deploy\n\n# Run tests\nyarn test\n```\n\n## Upgrading\n\n### The base stack no longer creates a VPC\n\n`BaseApplicationStack` used to create a VPC with a NAT gateway and attach the API Lambda to it.\nIt now creates neither unless the stack props set `enableVpc: true`. A stack that upgrades\nwithout it deletes its VPC and NAT gateway on the next deploy.\n\nAdd `enableVpc: true` to every `ApplicationStack` in `src/main.ts` and `src/LocalDevApp.ts` (new projects: `additionalStackProps: { enableVpc: true }` on each environment) if any of these apply:\n\n- your `ApplicationStack` uses `this.vpc` or overrides `createVpc()`; the override is not called otherwise;\n- the Lambda reaches anything private, such as RDS or a VPC endpoint;\n- another stack imports this stack's VPC outputs; CloudFormation refuses to delete them.\n\n`this.vpc` is now typed `IVpc | undefined`, even with `enableVpc: true`, so code that passes it where an `IVpc` is required (such as `new SecurityGroup(this, 'Sg', { vpc: this.vpc })`) stops compiling. With `enableVpc: true` the VPC is created before your `ApplicationStack` constructor runs, so use `this.vpc!` there, or check it and throw if it's missing.\n\nOtherwise, make `vpc` optional in `src/constructs/Api.ts` (`readonly vpc?: IVpc;`) so the project compiles. Deleting the VPC can take a while as Lambda releases its network interfaces.\n\nWith `enableVpc: true`, the Lambda is attached only if your `Api.ts` still accepts a `vpc` prop and your stack doesn't override `createApi()` without passing it.\n\n### n8n support is removed\n\n`BatmanProject` and `BootcampProject` no longer generate any n8n wiring. The base stacks have no `n8nEndpoint` prop, `src/constructs/WorkflowProvider.ts` and a construct per `src/workflows/*.json` are no longer generated, and new projects get an `Api.ts`, `main.ts` and `LocalDevApp.ts` without n8n. The `n8nWorkflows` option, the `n8nEndpoint` environment config field and the exported `WorkflowAutoDiscover` class are gone, so every project removes `n8nWorkflows` and `n8nEndpoint` from its `.projenrc.ts`.\n\nA project that doesn't use n8n stops compiling until it also removes:\n\n- `n8nEndpoint` from every `ApplicationStack` in `src/main.ts` and `src/LocalDevApp.ts`;\n- the `n8nEndpoint` prop, the n8n JWT key secret and its `grantRead` from `src/constructs/Api.ts`;\n- any `n8nEndpoint: this.props.n8nEndpoint` in a `createApi()` override;\n- any generated `src/constructs/*Workflow.ts` files and `src/workflows/`, which import the now-deleted `WorkflowProvider`.\n\nA project that uses n8n takes ownership of it:\n\n1. Upgrading makes projen delete `src/constructs/WorkflowProvider.ts`. Restore it from the last commit that had it, which works whether or not the deletion is already committed:\n\n ```bash\n git checkout \"$(git log -n1 --format=%H --diff-filter=AM -- src/constructs/WorkflowProvider.ts)\" -- src/constructs/WorkflowProvider.ts\n ```\n\n Then delete the `~~ Generated by projen` header line from it and from your per-workflow constructs (such as `AlfredWorkflow.ts`). They're yours from now on, and a new workflow needs its construct written by hand.\n2. Move `n8nEndpoint` from `Api` to your `ApplicationStack`. Remove the `n8nEndpoint` prop and its `N8N_ENDPOINT` environment entry from `src/constructs/Api.ts`, add `readonly n8nEndpoint: string;` to `ApplicationStackProps` (your `main.ts` and `LocalDevApp.ts` already pass it), and set the variable after `super()`:\n\n ```typescript\n this.api.lambdaFunction.addEnvironment('N8N_ENDPOINT', props.n8nEndpoint);\n ```\n\n## SoftwareFactoryFiles (standalone, non-Batman projects)\n\n`SoftwareFactoryFiles` is independently exported and can be attached to any\n`projen` `NodeProject` — it does not require `BatmanProject` or\n`BootcampProject`. It generates the `@swamp/software-factory` state machine,\nthe architecture rule registry, the pre-PR attestation gate, the OpenSpec\ntask-completion gate, and the swamp workflows that wire them together.\n\n```typescript\nimport { javascript } from 'projen';\nimport { SoftwareFactoryFiles } from '@macedon-technologies/batman';\n\nconst project = new javascript.NodeProject({\n name: 'my-other-project',\n defaultReleaseBranch: 'main',\n});\n\nnew SoftwareFactoryFiles(project, {\n repoName: 'my-other-project',\n githubOwner: 'my-github-org', // defaults to 'macedon-technologies' if omitted\n baseBranch: 'main', // defaults to 'main'\n});\n\nproject.synth();\n```\n\nAfter running `npx projen`, follow the printed `swamp:bootstrap` task to pull\nthe required swamp extensions and create the project's secrets vault."
|
|
100
|
+
"markdown": "# Platform Common Projen\n\nA baseline architecture template for new projects using Projen. This project provides a standardized foundation that includes both frontend and backend components with authentication.\n\n## Project Intention\n\nThis template serves as a starting point for new projects, providing:\n- Consistent project structure and configuration\n- Pre-configured development tooling\n- Integrated authentication system\n- Full-stack application foundation\n\n## Components Created\n\nThe BatmanProject generates:\n\n### Frontend\n- **React Application** - Modern React app with TypeScript\n- **Clerk Authentication** - Integrated user authentication and management\n- **Playwright e2e Testing** - `@playwright/test` + `@clerk/testing` devDeps, a `test:e2e` task, and a scaffolded `playwright.config.ts` + `e2e/` starter suite (see the generated `web/e2e/README.md`); disable with `e2eTesting: false`. The generated `pr-deploy.yml` workflow also runs this suite against each PR's deployed URL unless `e2eTesting: false` is set.\n\n### Backend/Infrastructure\n- **AWS Infrastructure** - CDK-based cloud resources\n- **API Gateway** - RESTful API endpoints\n- **Lambda Functions** - Serverless compute\n- **Database** - Persistent data storage\n\n## Usage Examples\n\n### Basic Project Creation\n\nCreate a `.projenrc.ts` file in your project root:\n\n```typescript\nimport { BatmanProject } from '@macedon-technologies/batman';\n\nconst project = new BatmanProject({\n name: 'my-new-app',\n defaultReleaseBranch: 'main',\n});\n\nproject.synth();\n```\n\nThen run:\n```bash\nnpx projen\n```\n\n### With Custom Configuration\n\nCreate a `.projenrc.ts` file with additional options:\n\n```typescript\nimport { BatmanProject } from '@macedon-technologies/batman';\n\nconst project = new BatmanProject({\n name: 'my-enterprise-app',\n defaultReleaseBranch: 'main',\n description: 'Enterprise application with authentication',\n authorName: 'Your Name',\n authorEmail: 'your.email@company.com',\n});\n\nproject.synth();\n```\n\nThen run:\n```bash\nnpx projen\n```\n\n### Development Workflow\n\n```bash\n# Install dependencies\nyarn install\n\n# Start development server\nyarn dev\n\n# Deploy infrastructure\nyarn deploy\n\n# Run tests\nyarn test\n```\n\n## Deploying staging on demand\n\nThe generated `Staging Deploy` workflow runs on every push to `main` and can also be run manually from the Actions tab (\"Run workflow\"). Use that to redeploy `main` when a merge raised no push event or a deploy needs re-running. Pick `main` as the branch: the workflow deploys whichever branch you select.\n\n## Auto-merging pull requests with a GitHub App\n\nSetting `prAutoMerge: true` generates `.github/workflows/pr-auto-merge.yml`. It turns on GitHub's squash auto-merge for every pull request into the default branch when the pull request is opened, reopened or marked ready for review. Drafts and pull requests into other branches are left alone. The pull request then merges by itself once your branch ruleset is satisfied.\n\nThe workflow arms the merge with a GitHub App token, not `GITHUB_TOKEN`. GitHub attributes an auto-merge to whoever armed it and raises no events for anything `GITHUB_TOKEN` does, so a merge armed with it would never trigger `Staging Deploy` or `PR Cleanup`.\n\nThe App's private key can mint tokens for every repository the App is installed on, so it lives in an `auto-merge` environment that only `main` can use, not in the repository's secrets. Anyone with write access can read repository secrets from a workflow on their own branch. The workflow runs on `pull_request_target`, which uses the workflow file from the default branch and so passes the environment's branch rule; it never checks out pull request code. Use one App per repository so a leaked key reaches only that repository.\n\nSet it up in this order. Until the App and credentials exist, every pull request's `pr-auto-merge` run fails.\n\n1. **Create a GitHub App** in the organization (Settings → Developer settings → GitHub Apps → New GitHub App). It needs no webhook. Under Repository permissions give it **Read and write** on Contents, Pull requests, Workflows and Issues. Workflows is needed because Batman upgrades change files under `.github/workflows/`. Issues lets the merge close linked issues.\n2. **Generate a private key** on the App's page, and note its **Client ID**.\n3. **Install the App** on the repository (the App's page → Install App → Only select repositories).\n4. **Create an `auto-merge` environment** (Settings → Environments → New environment). Under Deployment branches and tags choose **Selected branches and tags** and add `main`. Then add to the environment:\n - an environment **variable** `AUTO_MERGE_APP_CLIENT_ID` set to the Client ID;\n - an environment **secret** `AUTO_MERGE_APP_PRIVATE_KEY` set to the full contents of the `.pem` file.\n\n Don't add them as repository variables or secrets.\n5. **Turn on \"Allow auto-merge\"** in the repository's Settings → General → Pull Requests.\n6. **Protect the default branch** with a ruleset that requires an approving review and your required status checks. `prAutoMerge` doesn't create one. Without it, an armed pull request merges as soon as it can, unreviewed.\n7. Set `prAutoMerge: true` in `.projenrc.ts` and run projen.\n\nIf the variable or the secret is missing from the environment, the run fails with an error naming both. If the App's installation lacks one of the four permissions, minting the token fails. Pull requests from forks are armed like any other, since the workflow runs from the default branch, and still wait for the ruleset's review. Dependabot pull requests don't receive the environment's secret, so their runs fail the credential check. Merge those by hand. Each run also records a deployment to the `auto-merge` environment.\n\n## Upgrading\n\n### Datadog tracing defaults changed\n\n`BaseApplicationStack` now defaults `datadog.nodeLayerVersion` to 143 (dd-trace 6.x) instead of 132, and passes `enableMergeXrayTraces: false` to `DatadogLambda`. These reach every project on its next `npx projen`. With merging off, the `aws.apigateway` span Datadog infers starts the API trace; API Gateway stage X-Ray tracing stays on. A stack that set its own `nodeLayerVersion` keeps it. To merge X-Ray traces again, override `createDatadogExtension()` in your `ApplicationStack`:\n\n```ts\nprotected override createDatadogExtension() {\n super.createDatadogExtension();\n Object.assign(this.datadog.props, { enableMergeXrayTraces: true });\n}\n```\n\nNew projects' `src/constructs/Api.ts` installs `express` and `pg` into the Lambda artifact instead of bundling them, so dd-trace can trace router and `pg.query` calls. `Api.ts` is yours once generated, so existing projects add `express` and `pg` to `bundling.nodeModules` on the `NodejsFunction` in `createLambdaFunction()`, creating the block if it has none:\n\n```ts\nbundling: {\n nodeModules: ['express', 'pg'],\n},\n```\n\nCDK installs each package at the version spec in your root `package.json`, so `express` and `pg` must have plain version ranges there. A `catalog:` spec fails synth.\n\n### The base stack no longer creates a VPC\n\n`BaseApplicationStack` used to create a VPC with a NAT gateway and attach the API Lambda to it.\nIt now creates neither unless the stack props set `enableVpc: true`. A stack that upgrades\nwithout it deletes its VPC and NAT gateway on the next deploy.\n\nAdd `enableVpc: true` to every `ApplicationStack` in `src/main.ts` and `src/LocalDevApp.ts` (new projects: `additionalStackProps: { enableVpc: true }` on each environment) if any of these apply:\n\n- your `ApplicationStack` uses `this.vpc` or overrides `createVpc()`; the override is not called otherwise;\n- the Lambda reaches anything private, such as RDS or a VPC endpoint;\n- another stack imports this stack's VPC outputs; CloudFormation refuses to delete them.\n\n`this.vpc` is now typed `IVpc | undefined`, even with `enableVpc: true`, so code that passes it where an `IVpc` is required (such as `new SecurityGroup(this, 'Sg', { vpc: this.vpc })`) stops compiling. With `enableVpc: true` the VPC is created before your `ApplicationStack` constructor runs, so use `this.vpc!` there, or check it and throw if it's missing.\n\nOtherwise, make `vpc` optional in `src/constructs/Api.ts` (`readonly vpc?: IVpc;`) so the project compiles. Deleting the VPC can take a while as Lambda releases its network interfaces.\n\nWith `enableVpc: true`, the Lambda is attached only if your `Api.ts` still accepts a `vpc` prop and your stack doesn't override `createApi()` without passing it.\n\n### n8n support is removed\n\n`BatmanProject` and `BootcampProject` no longer generate any n8n wiring. The base stacks have no `n8nEndpoint` prop, `src/constructs/WorkflowProvider.ts` and a construct per `src/workflows/*.json` are no longer generated, and new projects get an `Api.ts`, `main.ts` and `LocalDevApp.ts` without n8n. The `n8nWorkflows` option, the `n8nEndpoint` environment config field and the exported `WorkflowAutoDiscover` class are gone, so every project removes `n8nWorkflows` and `n8nEndpoint` from its `.projenrc.ts`.\n\nA project that doesn't use n8n stops compiling until it also removes:\n\n- `n8nEndpoint` from every `ApplicationStack` in `src/main.ts` and `src/LocalDevApp.ts`;\n- the `n8nEndpoint` prop, the n8n JWT key secret and its `grantRead` from `src/constructs/Api.ts`;\n- any `n8nEndpoint: this.props.n8nEndpoint` in a `createApi()` override;\n- any generated `src/constructs/*Workflow.ts` files and `src/workflows/`, which import the now-deleted `WorkflowProvider`.\n\nA project that uses n8n takes ownership of it:\n\n1. Upgrading makes projen delete `src/constructs/WorkflowProvider.ts`. Restore it from the last commit that had it, which works whether or not the deletion is already committed:\n\n ```bash\n git checkout \"$(git log -n1 --format=%H --diff-filter=AM -- src/constructs/WorkflowProvider.ts)\" -- src/constructs/WorkflowProvider.ts\n ```\n\n Then delete the `~~ Generated by projen` header line from it and from your per-workflow constructs (such as `AlfredWorkflow.ts`). They're yours from now on, and a new workflow needs its construct written by hand.\n2. Move `n8nEndpoint` from `Api` to your `ApplicationStack`. Remove the `n8nEndpoint` prop and its `N8N_ENDPOINT` environment entry from `src/constructs/Api.ts`, add `readonly n8nEndpoint: string;` to `ApplicationStackProps` (your `main.ts` and `LocalDevApp.ts` already pass it), and set the variable after `super()`:\n\n ```typescript\n this.api.lambdaFunction.addEnvironment('N8N_ENDPOINT', props.n8nEndpoint);\n ```\n\n## SoftwareFactoryFiles (standalone, non-Batman projects)\n\n`SoftwareFactoryFiles` is independently exported and can be attached to any\n`projen` `NodeProject` — it does not require `BatmanProject` or\n`BootcampProject`. It generates the `@swamp/software-factory` state machine,\nthe architecture rule registry, the pre-PR attestation gate, the OpenSpec\ntask-completion gate, and the swamp workflows that wire them together.\n\n```typescript\nimport { javascript } from 'projen';\nimport { SoftwareFactoryFiles } from '@macedon-technologies/batman';\n\nconst project = new javascript.NodeProject({\n name: 'my-other-project',\n defaultReleaseBranch: 'main',\n});\n\nnew SoftwareFactoryFiles(project, {\n repoName: 'my-other-project',\n githubOwner: 'my-github-org', // defaults to 'macedon-technologies' if omitted\n baseBranch: 'main', // defaults to 'main'\n});\n\nproject.synth();\n```\n\nAfter running `npx projen`, follow the printed `swamp:bootstrap` task to pull\nthe required swamp extensions and create the project's secrets vault.\n\n### Work items and `factory/work-item-sources.md`\n\nA factory run's `workItem` is the ticket's bare key in its own tracker, such as\n`108` for a GitHub issue or `AI-123`, with nothing naming the tracker. The run's\nrecords and scratch paths are named after it, so a run is always started with\nthe bare key, even when the request names the tracker.\n\nThe factory's intake stage resolves the work item by following the managed\n`factory/work-item-sources.md`: which sources' key formats fit it, which model\nand method fetch it, how its fields map into the `issue-context` artifact, and\nwhich link line `open-pr` writes in the PR body (`Closes #<key>` for GitHub).\nWhen more than one source finds the key, intake stops and asks which was meant. Batman regenerates this file on every\nsynth, so supporting another tracker never needs a factory definition edit. The\nfile is part of the PR attestation manifest. The first synth that adds it changes\n`attestation/manifest.ts`, so any factory PR that's already open needs\nre-attesting.\n\n#### Updating an already-scaffolded factory\n\nThe factory definition (`models/@swamp/software-factory/<repo>-factory.yaml`)\nis written once, so a repo scaffolded before the routing file existed\nregenerates it:\n\n1. Note the file's `id:` line and any changes the repo has made to it since it\n was scaffolded (`git log -p -- <file>`).\n2. Delete the file and run `npx projen`, which writes the current template.\n3. Put the old `id:` line back, so swamp still treats it as the same model, and\n re-apply the repo's changes.\n\nRuns that recorded the old `issue-context` (`number` instead of `source`/`key`)\nkeep working: the routing file tells later stages to treat them as GitHub issues."
|
|
101
101
|
},
|
|
102
102
|
"repository": {
|
|
103
103
|
"type": "git",
|
|
@@ -123,7 +123,7 @@
|
|
|
123
123
|
"kind": "interface",
|
|
124
124
|
"locationInModule": {
|
|
125
125
|
"filename": "src/Application.ts",
|
|
126
|
-
"line":
|
|
126
|
+
"line": 23
|
|
127
127
|
},
|
|
128
128
|
"name": "ApplicationEnvironmentConfig",
|
|
129
129
|
"properties": [
|
|
@@ -135,7 +135,7 @@
|
|
|
135
135
|
"immutable": true,
|
|
136
136
|
"locationInModule": {
|
|
137
137
|
"filename": "src/Application.ts",
|
|
138
|
-
"line":
|
|
138
|
+
"line": 24
|
|
139
139
|
},
|
|
140
140
|
"name": "githubActionRoleArn",
|
|
141
141
|
"type": {
|
|
@@ -158,7 +158,7 @@
|
|
|
158
158
|
},
|
|
159
159
|
"locationInModule": {
|
|
160
160
|
"filename": "src/BatmanProject.ts",
|
|
161
|
-
"line":
|
|
161
|
+
"line": 87
|
|
162
162
|
},
|
|
163
163
|
"parameters": [
|
|
164
164
|
{
|
|
@@ -172,7 +172,7 @@
|
|
|
172
172
|
"kind": "class",
|
|
173
173
|
"locationInModule": {
|
|
174
174
|
"filename": "src/BatmanProject.ts",
|
|
175
|
-
"line":
|
|
175
|
+
"line": 86
|
|
176
176
|
},
|
|
177
177
|
"name": "BatmanProject",
|
|
178
178
|
"symbolId": "src/BatmanProject:BatmanProject"
|
|
@@ -363,6 +363,25 @@
|
|
|
363
363
|
"primitive": "boolean"
|
|
364
364
|
}
|
|
365
365
|
},
|
|
366
|
+
{
|
|
367
|
+
"abstract": true,
|
|
368
|
+
"docs": {
|
|
369
|
+
"default": "false",
|
|
370
|
+
"remarks": "Requires the\n`AUTO_MERGE_APP_CLIENT_ID` variable and the\n`AUTO_MERGE_APP_PRIVATE_KEY` secret in an `auto-merge` environment; see the README section\n\"Auto-merging pull requests with a GitHub App\".",
|
|
371
|
+
"stability": "stable",
|
|
372
|
+
"summary": "Generates the pr-auto-merge workflow, which arms squash auto-merge on ready pull requests into the default branch with a GitHub App token."
|
|
373
|
+
},
|
|
374
|
+
"immutable": true,
|
|
375
|
+
"locationInModule": {
|
|
376
|
+
"filename": "src/BatmanProject.ts",
|
|
377
|
+
"line": 82
|
|
378
|
+
},
|
|
379
|
+
"name": "prAutoMerge",
|
|
380
|
+
"optional": true,
|
|
381
|
+
"type": {
|
|
382
|
+
"primitive": "boolean"
|
|
383
|
+
}
|
|
384
|
+
},
|
|
366
385
|
{
|
|
367
386
|
"abstract": true,
|
|
368
387
|
"docs": {
|
|
@@ -658,6 +677,109 @@
|
|
|
658
677
|
],
|
|
659
678
|
"symbolId": "src/MainFile:EnvironmentConfig"
|
|
660
679
|
},
|
|
680
|
+
"@macedon-technologies/batman.PrAutoMergeWorkflow": {
|
|
681
|
+
"assembly": "@macedon-technologies/batman",
|
|
682
|
+
"base": "projen.YamlFile",
|
|
683
|
+
"docs": {
|
|
684
|
+
"stability": "stable",
|
|
685
|
+
"summary": "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."
|
|
686
|
+
},
|
|
687
|
+
"fqn": "@macedon-technologies/batman.PrAutoMergeWorkflow",
|
|
688
|
+
"initializer": {
|
|
689
|
+
"docs": {
|
|
690
|
+
"stability": "stable"
|
|
691
|
+
},
|
|
692
|
+
"locationInModule": {
|
|
693
|
+
"filename": "src/PrAutoMergeWorkflow.ts",
|
|
694
|
+
"line": 22
|
|
695
|
+
},
|
|
696
|
+
"parameters": [
|
|
697
|
+
{
|
|
698
|
+
"name": "project",
|
|
699
|
+
"type": {
|
|
700
|
+
"fqn": "projen.Project"
|
|
701
|
+
}
|
|
702
|
+
},
|
|
703
|
+
{
|
|
704
|
+
"name": "options",
|
|
705
|
+
"optional": true,
|
|
706
|
+
"type": {
|
|
707
|
+
"fqn": "@macedon-technologies/batman.PrAutoMergeWorkflowOptions"
|
|
708
|
+
}
|
|
709
|
+
}
|
|
710
|
+
]
|
|
711
|
+
},
|
|
712
|
+
"kind": "class",
|
|
713
|
+
"locationInModule": {
|
|
714
|
+
"filename": "src/PrAutoMergeWorkflow.ts",
|
|
715
|
+
"line": 21
|
|
716
|
+
},
|
|
717
|
+
"methods": [
|
|
718
|
+
{
|
|
719
|
+
"docs": {
|
|
720
|
+
"stability": "stable",
|
|
721
|
+
"summary": "Implemented by derived classes and returns the contents of the file to emit."
|
|
722
|
+
},
|
|
723
|
+
"locationInModule": {
|
|
724
|
+
"filename": "src/PrAutoMergeWorkflow.ts",
|
|
725
|
+
"line": 84
|
|
726
|
+
},
|
|
727
|
+
"name": "synthesizeContent",
|
|
728
|
+
"overrides": "projen.YamlFile",
|
|
729
|
+
"parameters": [
|
|
730
|
+
{
|
|
731
|
+
"name": "resolver",
|
|
732
|
+
"type": {
|
|
733
|
+
"fqn": "projen.IResolver"
|
|
734
|
+
}
|
|
735
|
+
}
|
|
736
|
+
],
|
|
737
|
+
"protected": true,
|
|
738
|
+
"returns": {
|
|
739
|
+
"optional": true,
|
|
740
|
+
"type": {
|
|
741
|
+
"primitive": "string"
|
|
742
|
+
}
|
|
743
|
+
}
|
|
744
|
+
}
|
|
745
|
+
],
|
|
746
|
+
"name": "PrAutoMergeWorkflow",
|
|
747
|
+
"symbolId": "src/PrAutoMergeWorkflow:PrAutoMergeWorkflow"
|
|
748
|
+
},
|
|
749
|
+
"@macedon-technologies/batman.PrAutoMergeWorkflowOptions": {
|
|
750
|
+
"assembly": "@macedon-technologies/batman",
|
|
751
|
+
"datatype": true,
|
|
752
|
+
"docs": {
|
|
753
|
+
"stability": "stable"
|
|
754
|
+
},
|
|
755
|
+
"fqn": "@macedon-technologies/batman.PrAutoMergeWorkflowOptions",
|
|
756
|
+
"kind": "interface",
|
|
757
|
+
"locationInModule": {
|
|
758
|
+
"filename": "src/PrAutoMergeWorkflow.ts",
|
|
759
|
+
"line": 7
|
|
760
|
+
},
|
|
761
|
+
"name": "PrAutoMergeWorkflowOptions",
|
|
762
|
+
"properties": [
|
|
763
|
+
{
|
|
764
|
+
"abstract": true,
|
|
765
|
+
"docs": {
|
|
766
|
+
"stability": "stable",
|
|
767
|
+
"summary": "Overrides for the pinned action versions used by this workflow."
|
|
768
|
+
},
|
|
769
|
+
"immutable": true,
|
|
770
|
+
"locationInModule": {
|
|
771
|
+
"filename": "src/PrAutoMergeWorkflow.ts",
|
|
772
|
+
"line": 11
|
|
773
|
+
},
|
|
774
|
+
"name": "actionVersions",
|
|
775
|
+
"optional": true,
|
|
776
|
+
"type": {
|
|
777
|
+
"fqn": "@macedon-technologies/batman.WorkflowActionVersions"
|
|
778
|
+
}
|
|
779
|
+
}
|
|
780
|
+
],
|
|
781
|
+
"symbolId": "src/PrAutoMergeWorkflow:PrAutoMergeWorkflowOptions"
|
|
782
|
+
},
|
|
661
783
|
"@macedon-technologies/batman.ProductionDeployWorkflow": {
|
|
662
784
|
"assembly": "@macedon-technologies/batman",
|
|
663
785
|
"base": "projen.YamlFile",
|
|
@@ -804,7 +926,7 @@
|
|
|
804
926
|
},
|
|
805
927
|
"locationInModule": {
|
|
806
928
|
"filename": "src/SoftwareFactoryFiles.ts",
|
|
807
|
-
"line":
|
|
929
|
+
"line": 77
|
|
808
930
|
},
|
|
809
931
|
"parameters": [
|
|
810
932
|
{
|
|
@@ -824,7 +946,7 @@
|
|
|
824
946
|
"kind": "class",
|
|
825
947
|
"locationInModule": {
|
|
826
948
|
"filename": "src/SoftwareFactoryFiles.ts",
|
|
827
|
-
"line":
|
|
949
|
+
"line": 76
|
|
828
950
|
},
|
|
829
951
|
"name": "SoftwareFactoryFiles",
|
|
830
952
|
"symbolId": "src/SoftwareFactoryFiles:SoftwareFactoryFiles"
|
|
@@ -839,7 +961,7 @@
|
|
|
839
961
|
"kind": "interface",
|
|
840
962
|
"locationInModule": {
|
|
841
963
|
"filename": "src/SoftwareFactoryFiles.ts",
|
|
842
|
-
"line":
|
|
964
|
+
"line": 13
|
|
843
965
|
},
|
|
844
966
|
"name": "SoftwareFactoryFilesOptions",
|
|
845
967
|
"properties": [
|
|
@@ -852,7 +974,7 @@
|
|
|
852
974
|
"immutable": true,
|
|
853
975
|
"locationInModule": {
|
|
854
976
|
"filename": "src/SoftwareFactoryFiles.ts",
|
|
855
|
-
"line":
|
|
977
|
+
"line": 19
|
|
856
978
|
},
|
|
857
979
|
"name": "repoName",
|
|
858
980
|
"type": {
|
|
@@ -868,7 +990,7 @@
|
|
|
868
990
|
"immutable": true,
|
|
869
991
|
"locationInModule": {
|
|
870
992
|
"filename": "src/SoftwareFactoryFiles.ts",
|
|
871
|
-
"line":
|
|
993
|
+
"line": 38
|
|
872
994
|
},
|
|
873
995
|
"name": "actionVersions",
|
|
874
996
|
"optional": true,
|
|
@@ -887,7 +1009,7 @@
|
|
|
887
1009
|
"immutable": true,
|
|
888
1010
|
"locationInModule": {
|
|
889
1011
|
"filename": "src/SoftwareFactoryFiles.ts",
|
|
890
|
-
"line":
|
|
1012
|
+
"line": 49
|
|
891
1013
|
},
|
|
892
1014
|
"name": "attestationFiles",
|
|
893
1015
|
"optional": true,
|
|
@@ -910,7 +1032,7 @@
|
|
|
910
1032
|
"immutable": true,
|
|
911
1033
|
"locationInModule": {
|
|
912
1034
|
"filename": "src/SoftwareFactoryFiles.ts",
|
|
913
|
-
"line":
|
|
1035
|
+
"line": 33
|
|
914
1036
|
},
|
|
915
1037
|
"name": "baseBranch",
|
|
916
1038
|
"optional": true,
|
|
@@ -928,7 +1050,7 @@
|
|
|
928
1050
|
"immutable": true,
|
|
929
1051
|
"locationInModule": {
|
|
930
1052
|
"filename": "src/SoftwareFactoryFiles.ts",
|
|
931
|
-
"line":
|
|
1053
|
+
"line": 26
|
|
932
1054
|
},
|
|
933
1055
|
"name": "githubOwner",
|
|
934
1056
|
"optional": true,
|
|
@@ -1123,6 +1245,24 @@
|
|
|
1123
1245
|
"primitive": "string"
|
|
1124
1246
|
}
|
|
1125
1247
|
},
|
|
1248
|
+
{
|
|
1249
|
+
"abstract": true,
|
|
1250
|
+
"docs": {
|
|
1251
|
+
"default": "'actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1' // v3.2.0",
|
|
1252
|
+
"stability": "stable",
|
|
1253
|
+
"summary": "The `actions/create-github-app-token` action reference, used by the opt-in pr-auto-merge workflow to mint a GitHub App installation token."
|
|
1254
|
+
},
|
|
1255
|
+
"immutable": true,
|
|
1256
|
+
"locationInModule": {
|
|
1257
|
+
"filename": "src/WorkflowActionVersions.ts",
|
|
1258
|
+
"line": 86
|
|
1259
|
+
},
|
|
1260
|
+
"name": "createGithubAppToken",
|
|
1261
|
+
"optional": true,
|
|
1262
|
+
"type": {
|
|
1263
|
+
"primitive": "string"
|
|
1264
|
+
}
|
|
1265
|
+
},
|
|
1126
1266
|
{
|
|
1127
1267
|
"abstract": true,
|
|
1128
1268
|
"docs": {
|
|
@@ -1253,6 +1393,6 @@
|
|
|
1253
1393
|
"symbolId": "src/WorkflowActionVersions:WorkflowActionVersions"
|
|
1254
1394
|
}
|
|
1255
1395
|
},
|
|
1256
|
-
"version": "1.
|
|
1257
|
-
"fingerprint": "
|
|
1396
|
+
"version": "1.32.0",
|
|
1397
|
+
"fingerprint": "mzAhut3YlIggln/fITyEpqCI9pvzHMHbEObX8fjAVW4="
|
|
1258
1398
|
}
|