@jjrawlins/cdk-deploy-pr-github-action 0.0.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/.tool-versions ADDED
@@ -0,0 +1,3 @@
1
+ # ~~ Generated by projen. To modify, edit .projenrc.ts and run "npx projen".
2
+ nodejs 20.19.0
3
+ yarn 1.22.22
package/API.md ADDED
@@ -0,0 +1,552 @@
1
+ # API Reference <a name="API Reference" id="api-reference"></a>
2
+
3
+
4
+ ## Structs <a name="Structs" id="Structs"></a>
5
+
6
+ ### AwsEnvironment <a name="AwsEnvironment" id="@jjrawlins/cdk-deploy-pr-github-action.AwsEnvironment"></a>
7
+
8
+ AWS environment target for a deployment stage.
9
+
10
+ #### Initializer <a name="Initializer" id="@jjrawlins/cdk-deploy-pr-github-action.AwsEnvironment.Initializer"></a>
11
+
12
+ ```typescript
13
+ import { AwsEnvironment } from '@jjrawlins/cdk-deploy-pr-github-action'
14
+
15
+ const awsEnvironment: AwsEnvironment = { ... }
16
+ ```
17
+
18
+ #### Properties <a name="Properties" id="Properties"></a>
19
+
20
+ | **Name** | **Type** | **Description** |
21
+ | --- | --- | --- |
22
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.AwsEnvironment.property.account">account</a></code> | <code>string</code> | AWS account ID. |
23
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.AwsEnvironment.property.region">region</a></code> | <code>string</code> | AWS region. |
24
+
25
+ ---
26
+
27
+ ##### `account`<sup>Required</sup> <a name="account" id="@jjrawlins/cdk-deploy-pr-github-action.AwsEnvironment.property.account"></a>
28
+
29
+ ```typescript
30
+ public readonly account: string;
31
+ ```
32
+
33
+ - *Type:* string
34
+
35
+ AWS account ID.
36
+
37
+ ---
38
+
39
+ ##### `region`<sup>Required</sup> <a name="region" id="@jjrawlins/cdk-deploy-pr-github-action.AwsEnvironment.property.region"></a>
40
+
41
+ ```typescript
42
+ public readonly region: string;
43
+ ```
44
+
45
+ - *Type:* string
46
+
47
+ AWS region.
48
+
49
+ ---
50
+
51
+ ### CdkDeployPipelineOptions <a name="CdkDeployPipelineOptions" id="@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions"></a>
52
+
53
+ Configuration for the CDK deploy pipeline.
54
+
55
+ #### Initializer <a name="Initializer" id="@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.Initializer"></a>
56
+
57
+ ```typescript
58
+ import { CdkDeployPipelineOptions } from '@jjrawlins/cdk-deploy-pr-github-action'
59
+
60
+ const cdkDeployPipelineOptions: CdkDeployPipelineOptions = { ... }
61
+ ```
62
+
63
+ #### Properties <a name="Properties" id="Properties"></a>
64
+
65
+ | **Name** | **Type** | **Description** |
66
+ | --- | --- | --- |
67
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.property.iamRoleArn">iamRoleArn</a></code> | <code>string</code> | Default OIDC role ARN for AWS credential assumption. |
68
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.property.pkgNamespace">pkgNamespace</a></code> | <code>string</code> | npm scope for versioned cloud assembly packages (e.g., '@defiance-digital'). |
69
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.property.stackPrefix">stackPrefix</a></code> | <code>string</code> | Stack name prefix. |
70
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.property.stages">stages</a></code> | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.DeployStageOptions">DeployStageOptions</a>[]</code> | Deployment stages in declaration order. |
71
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.property.branchName">branchName</a></code> | <code>string</code> | Branch that triggers deployments on push. |
72
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.property.cdkCommand">cdkCommand</a></code> | <code>string</code> | CDK CLI command prefix. |
73
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.property.iamRoleRegion">iamRoleRegion</a></code> | <code>string</code> | Default AWS region for OIDC credential assumption. |
74
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.property.installCommand">installCommand</a></code> | <code>string</code> | Package install command. |
75
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.property.manualDeployment">manualDeployment</a></code> | <code>boolean</code> | Generate a workflow_dispatch workflow for manual deployments and rollbacks. |
76
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.property.nodeVersion">nodeVersion</a></code> | <code>string</code> | Node.js version for workflow runners. |
77
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.property.useGithubPackagesForAssembly">useGithubPackagesForAssembly</a></code> | <code>boolean</code> | Version and publish cloud assembly to GitHub Packages for rollback support. |
78
+
79
+ ---
80
+
81
+ ##### `iamRoleArn`<sup>Required</sup> <a name="iamRoleArn" id="@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.property.iamRoleArn"></a>
82
+
83
+ ```typescript
84
+ public readonly iamRoleArn: string;
85
+ ```
86
+
87
+ - *Type:* string
88
+
89
+ Default OIDC role ARN for AWS credential assumption.
90
+
91
+ ---
92
+
93
+ ##### `pkgNamespace`<sup>Required</sup> <a name="pkgNamespace" id="@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.property.pkgNamespace"></a>
94
+
95
+ ```typescript
96
+ public readonly pkgNamespace: string;
97
+ ```
98
+
99
+ - *Type:* string
100
+
101
+ npm scope for versioned cloud assembly packages (e.g., '@defiance-digital').
102
+
103
+ ---
104
+
105
+ ##### `stackPrefix`<sup>Required</sup> <a name="stackPrefix" id="@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.property.stackPrefix"></a>
106
+
107
+ ```typescript
108
+ public readonly stackPrefix: string;
109
+ ```
110
+
111
+ - *Type:* string
112
+
113
+ Stack name prefix.
114
+
115
+ Stage names are appended with a dash (e.g., 'MyApp' -> 'MyApp-Production')
116
+
117
+ ---
118
+
119
+ ##### `stages`<sup>Required</sup> <a name="stages" id="@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.property.stages"></a>
120
+
121
+ ```typescript
122
+ public readonly stages: DeployStageOptions[];
123
+ ```
124
+
125
+ - *Type:* <a href="#@jjrawlins/cdk-deploy-pr-github-action.DeployStageOptions">DeployStageOptions</a>[]
126
+
127
+ Deployment stages in declaration order.
128
+
129
+ ---
130
+
131
+ ##### `branchName`<sup>Optional</sup> <a name="branchName" id="@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.property.branchName"></a>
132
+
133
+ ```typescript
134
+ public readonly branchName: string;
135
+ ```
136
+
137
+ - *Type:* string
138
+ - *Default:* 'main'
139
+
140
+ Branch that triggers deployments on push.
141
+
142
+ ---
143
+
144
+ ##### `cdkCommand`<sup>Optional</sup> <a name="cdkCommand" id="@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.property.cdkCommand"></a>
145
+
146
+ ```typescript
147
+ public readonly cdkCommand: string;
148
+ ```
149
+
150
+ - *Type:* string
151
+ - *Default:* 'npx cdk'
152
+
153
+ CDK CLI command prefix.
154
+
155
+ ---
156
+
157
+ ##### `iamRoleRegion`<sup>Optional</sup> <a name="iamRoleRegion" id="@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.property.iamRoleRegion"></a>
158
+
159
+ ```typescript
160
+ public readonly iamRoleRegion: string;
161
+ ```
162
+
163
+ - *Type:* string
164
+ - *Default:* 'us-east-1'
165
+
166
+ Default AWS region for OIDC credential assumption.
167
+
168
+ ---
169
+
170
+ ##### `installCommand`<sup>Optional</sup> <a name="installCommand" id="@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.property.installCommand"></a>
171
+
172
+ ```typescript
173
+ public readonly installCommand: string;
174
+ ```
175
+
176
+ - *Type:* string
177
+ - *Default:* 'yarn install --check-files --frozen-lockfile'
178
+
179
+ Package install command.
180
+
181
+ ---
182
+
183
+ ##### `manualDeployment`<sup>Optional</sup> <a name="manualDeployment" id="@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.property.manualDeployment"></a>
184
+
185
+ ```typescript
186
+ public readonly manualDeployment: boolean;
187
+ ```
188
+
189
+ - *Type:* boolean
190
+ - *Default:* true
191
+
192
+ Generate a workflow_dispatch workflow for manual deployments and rollbacks.
193
+
194
+ ---
195
+
196
+ ##### `nodeVersion`<sup>Optional</sup> <a name="nodeVersion" id="@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.property.nodeVersion"></a>
197
+
198
+ ```typescript
199
+ public readonly nodeVersion: string;
200
+ ```
201
+
202
+ - *Type:* string
203
+ - *Default:* '24.x'
204
+
205
+ Node.js version for workflow runners.
206
+
207
+ ---
208
+
209
+ ##### `useGithubPackagesForAssembly`<sup>Optional</sup> <a name="useGithubPackagesForAssembly" id="@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions.property.useGithubPackagesForAssembly"></a>
210
+
211
+ ```typescript
212
+ public readonly useGithubPackagesForAssembly: boolean;
213
+ ```
214
+
215
+ - *Type:* boolean
216
+ - *Default:* true
217
+
218
+ Version and publish cloud assembly to GitHub Packages for rollback support.
219
+
220
+ ---
221
+
222
+ ### DeployDispatchInternalOptions <a name="DeployDispatchInternalOptions" id="@jjrawlins/cdk-deploy-pr-github-action.DeployDispatchInternalOptions"></a>
223
+
224
+ Internal helper to build deploy dispatch workflow options from pipeline options.
225
+
226
+ Exported for use by CdkDeployDispatchWorkflow.
227
+
228
+ #### Initializer <a name="Initializer" id="@jjrawlins/cdk-deploy-pr-github-action.DeployDispatchInternalOptions.Initializer"></a>
229
+
230
+ ```typescript
231
+ import { DeployDispatchInternalOptions } from '@jjrawlins/cdk-deploy-pr-github-action'
232
+
233
+ const deployDispatchInternalOptions: DeployDispatchInternalOptions = { ... }
234
+ ```
235
+
236
+ #### Properties <a name="Properties" id="Properties"></a>
237
+
238
+ | **Name** | **Type** | **Description** |
239
+ | --- | --- | --- |
240
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.DeployDispatchInternalOptions.property.appName">appName</a></code> | <code>string</code> | *No description.* |
241
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.DeployDispatchInternalOptions.property.cdkCommand">cdkCommand</a></code> | <code>string</code> | *No description.* |
242
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.DeployDispatchInternalOptions.property.iamRoleArn">iamRoleArn</a></code> | <code>string</code> | *No description.* |
243
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.DeployDispatchInternalOptions.property.iamRoleRegion">iamRoleRegion</a></code> | <code>string</code> | *No description.* |
244
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.DeployDispatchInternalOptions.property.installCommand">installCommand</a></code> | <code>string</code> | *No description.* |
245
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.DeployDispatchInternalOptions.property.nodeVersion">nodeVersion</a></code> | <code>string</code> | *No description.* |
246
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.DeployDispatchInternalOptions.property.pkgNamespace">pkgNamespace</a></code> | <code>string</code> | *No description.* |
247
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.DeployDispatchInternalOptions.property.stackPrefix">stackPrefix</a></code> | <code>string</code> | *No description.* |
248
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.DeployDispatchInternalOptions.property.stages">stages</a></code> | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.DeployStageOptions">DeployStageOptions</a>[]</code> | *No description.* |
249
+
250
+ ---
251
+
252
+ ##### `appName`<sup>Required</sup> <a name="appName" id="@jjrawlins/cdk-deploy-pr-github-action.DeployDispatchInternalOptions.property.appName"></a>
253
+
254
+ ```typescript
255
+ public readonly appName: string;
256
+ ```
257
+
258
+ - *Type:* string
259
+
260
+ ---
261
+
262
+ ##### `cdkCommand`<sup>Required</sup> <a name="cdkCommand" id="@jjrawlins/cdk-deploy-pr-github-action.DeployDispatchInternalOptions.property.cdkCommand"></a>
263
+
264
+ ```typescript
265
+ public readonly cdkCommand: string;
266
+ ```
267
+
268
+ - *Type:* string
269
+
270
+ ---
271
+
272
+ ##### `iamRoleArn`<sup>Required</sup> <a name="iamRoleArn" id="@jjrawlins/cdk-deploy-pr-github-action.DeployDispatchInternalOptions.property.iamRoleArn"></a>
273
+
274
+ ```typescript
275
+ public readonly iamRoleArn: string;
276
+ ```
277
+
278
+ - *Type:* string
279
+
280
+ ---
281
+
282
+ ##### `iamRoleRegion`<sup>Required</sup> <a name="iamRoleRegion" id="@jjrawlins/cdk-deploy-pr-github-action.DeployDispatchInternalOptions.property.iamRoleRegion"></a>
283
+
284
+ ```typescript
285
+ public readonly iamRoleRegion: string;
286
+ ```
287
+
288
+ - *Type:* string
289
+
290
+ ---
291
+
292
+ ##### `installCommand`<sup>Required</sup> <a name="installCommand" id="@jjrawlins/cdk-deploy-pr-github-action.DeployDispatchInternalOptions.property.installCommand"></a>
293
+
294
+ ```typescript
295
+ public readonly installCommand: string;
296
+ ```
297
+
298
+ - *Type:* string
299
+
300
+ ---
301
+
302
+ ##### `nodeVersion`<sup>Required</sup> <a name="nodeVersion" id="@jjrawlins/cdk-deploy-pr-github-action.DeployDispatchInternalOptions.property.nodeVersion"></a>
303
+
304
+ ```typescript
305
+ public readonly nodeVersion: string;
306
+ ```
307
+
308
+ - *Type:* string
309
+
310
+ ---
311
+
312
+ ##### `pkgNamespace`<sup>Required</sup> <a name="pkgNamespace" id="@jjrawlins/cdk-deploy-pr-github-action.DeployDispatchInternalOptions.property.pkgNamespace"></a>
313
+
314
+ ```typescript
315
+ public readonly pkgNamespace: string;
316
+ ```
317
+
318
+ - *Type:* string
319
+
320
+ ---
321
+
322
+ ##### `stackPrefix`<sup>Required</sup> <a name="stackPrefix" id="@jjrawlins/cdk-deploy-pr-github-action.DeployDispatchInternalOptions.property.stackPrefix"></a>
323
+
324
+ ```typescript
325
+ public readonly stackPrefix: string;
326
+ ```
327
+
328
+ - *Type:* string
329
+
330
+ ---
331
+
332
+ ##### `stages`<sup>Required</sup> <a name="stages" id="@jjrawlins/cdk-deploy-pr-github-action.DeployDispatchInternalOptions.property.stages"></a>
333
+
334
+ ```typescript
335
+ public readonly stages: DeployStageOptions[];
336
+ ```
337
+
338
+ - *Type:* <a href="#@jjrawlins/cdk-deploy-pr-github-action.DeployStageOptions">DeployStageOptions</a>[]
339
+
340
+ ---
341
+
342
+ ### DeployStageOptions <a name="DeployStageOptions" id="@jjrawlins/cdk-deploy-pr-github-action.DeployStageOptions"></a>
343
+
344
+ Configuration for a single deployment stage.
345
+
346
+ #### Initializer <a name="Initializer" id="@jjrawlins/cdk-deploy-pr-github-action.DeployStageOptions.Initializer"></a>
347
+
348
+ ```typescript
349
+ import { DeployStageOptions } from '@jjrawlins/cdk-deploy-pr-github-action'
350
+
351
+ const deployStageOptions: DeployStageOptions = { ... }
352
+ ```
353
+
354
+ #### Properties <a name="Properties" id="Properties"></a>
355
+
356
+ | **Name** | **Type** | **Description** |
357
+ | --- | --- | --- |
358
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.DeployStageOptions.property.env">env</a></code> | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.AwsEnvironment">AwsEnvironment</a></code> | AWS target environment (account + region). |
359
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.DeployStageOptions.property.name">name</a></code> | <code>string</code> | Stage name (used as suffix in job IDs and stack names, e.g., 'Sandbox', 'Production'). |
360
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.DeployStageOptions.property.dependsOn">dependsOn</a></code> | <code>string[]</code> | Stage names that must complete successfully before this stage runs. |
361
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.DeployStageOptions.property.environment">environment</a></code> | <code>string</code> | GitHub Environment name for protection rules, secrets scoping, and deployment approvals. |
362
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.DeployStageOptions.property.iamRoleArn">iamRoleArn</a></code> | <code>string</code> | Override the default OIDC role ARN for this stage. |
363
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.DeployStageOptions.property.iamRoleRegion">iamRoleRegion</a></code> | <code>string</code> | Override the default AWS region for OIDC credential assumption. |
364
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.DeployStageOptions.property.stacks">stacks</a></code> | <code>string[]</code> | Specific CDK stack names to deploy in this stage. |
365
+
366
+ ---
367
+
368
+ ##### `env`<sup>Required</sup> <a name="env" id="@jjrawlins/cdk-deploy-pr-github-action.DeployStageOptions.property.env"></a>
369
+
370
+ ```typescript
371
+ public readonly env: AwsEnvironment;
372
+ ```
373
+
374
+ - *Type:* <a href="#@jjrawlins/cdk-deploy-pr-github-action.AwsEnvironment">AwsEnvironment</a>
375
+
376
+ AWS target environment (account + region).
377
+
378
+ ---
379
+
380
+ ##### `name`<sup>Required</sup> <a name="name" id="@jjrawlins/cdk-deploy-pr-github-action.DeployStageOptions.property.name"></a>
381
+
382
+ ```typescript
383
+ public readonly name: string;
384
+ ```
385
+
386
+ - *Type:* string
387
+
388
+ Stage name (used as suffix in job IDs and stack names, e.g., 'Sandbox', 'Production').
389
+
390
+ ---
391
+
392
+ ##### `dependsOn`<sup>Optional</sup> <a name="dependsOn" id="@jjrawlins/cdk-deploy-pr-github-action.DeployStageOptions.property.dependsOn"></a>
393
+
394
+ ```typescript
395
+ public readonly dependsOn: string[];
396
+ ```
397
+
398
+ - *Type:* string[]
399
+ - *Default:* depends only on publish-assets (runs as soon as assets are ready)
400
+
401
+ Stage names that must complete successfully before this stage runs.
402
+
403
+ Stages with no dependsOn run in parallel after the publish-assets job.
404
+
405
+ ---
406
+
407
+ *Example*
408
+
409
+ ```typescript
410
+ ['Sandbox', 'Dev'] // waits for both before deploying
411
+ ```
412
+
413
+
414
+ ##### `environment`<sup>Optional</sup> <a name="environment" id="@jjrawlins/cdk-deploy-pr-github-action.DeployStageOptions.property.environment"></a>
415
+
416
+ ```typescript
417
+ public readonly environment: string;
418
+ ```
419
+
420
+ - *Type:* string
421
+ - *Default:* uses the stage name
422
+
423
+ GitHub Environment name for protection rules, secrets scoping, and deployment approvals.
424
+
425
+ ---
426
+
427
+ ##### `iamRoleArn`<sup>Optional</sup> <a name="iamRoleArn" id="@jjrawlins/cdk-deploy-pr-github-action.DeployStageOptions.property.iamRoleArn"></a>
428
+
429
+ ```typescript
430
+ public readonly iamRoleArn: string;
431
+ ```
432
+
433
+ - *Type:* string
434
+
435
+ Override the default OIDC role ARN for this stage.
436
+
437
+ Useful for cross-account deployments where each account has its own role.
438
+
439
+ ---
440
+
441
+ ##### `iamRoleRegion`<sup>Optional</sup> <a name="iamRoleRegion" id="@jjrawlins/cdk-deploy-pr-github-action.DeployStageOptions.property.iamRoleRegion"></a>
442
+
443
+ ```typescript
444
+ public readonly iamRoleRegion: string;
445
+ ```
446
+
447
+ - *Type:* string
448
+ - *Default:* uses the pipeline-level iamRoleRegion or the stage env.region
449
+
450
+ Override the default AWS region for OIDC credential assumption.
451
+
452
+ ---
453
+
454
+ ##### `stacks`<sup>Optional</sup> <a name="stacks" id="@jjrawlins/cdk-deploy-pr-github-action.DeployStageOptions.property.stacks"></a>
455
+
456
+ ```typescript
457
+ public readonly stacks: string[];
458
+ ```
459
+
460
+ - *Type:* string[]
461
+ - *Default:* ['{stackPrefix}-{stageName}']
462
+
463
+ Specific CDK stack names to deploy in this stage.
464
+
465
+ ---
466
+
467
+ ## Classes <a name="Classes" id="Classes"></a>
468
+
469
+ ### CdkDeployDispatchWorkflow <a name="CdkDeployDispatchWorkflow" id="@jjrawlins/cdk-deploy-pr-github-action.CdkDeployDispatchWorkflow"></a>
470
+
471
+ Generates a workflow_dispatch workflow for manual CDK deployments and rollbacks.
472
+
473
+ Allows deploying any previously published version of the cloud assembly
474
+ to any configured environment. This enables:
475
+ - Manual promotion between environments
476
+ - Rollback to any previous version
477
+ - Ad-hoc deployments outside the normal CI/CD flow
478
+
479
+ #### Initializers <a name="Initializers" id="@jjrawlins/cdk-deploy-pr-github-action.CdkDeployDispatchWorkflow.Initializer"></a>
480
+
481
+ ```typescript
482
+ import { CdkDeployDispatchWorkflow } from '@jjrawlins/cdk-deploy-pr-github-action'
483
+
484
+ new CdkDeployDispatchWorkflow(project: any, options: DeployDispatchInternalOptions)
485
+ ```
486
+
487
+ | **Name** | **Type** | **Description** |
488
+ | --- | --- | --- |
489
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.CdkDeployDispatchWorkflow.Initializer.parameter.project">project</a></code> | <code>any</code> | *No description.* |
490
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.CdkDeployDispatchWorkflow.Initializer.parameter.options">options</a></code> | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.DeployDispatchInternalOptions">DeployDispatchInternalOptions</a></code> | *No description.* |
491
+
492
+ ---
493
+
494
+ ##### `project`<sup>Required</sup> <a name="project" id="@jjrawlins/cdk-deploy-pr-github-action.CdkDeployDispatchWorkflow.Initializer.parameter.project"></a>
495
+
496
+ - *Type:* any
497
+
498
+ ---
499
+
500
+ ##### `options`<sup>Required</sup> <a name="options" id="@jjrawlins/cdk-deploy-pr-github-action.CdkDeployDispatchWorkflow.Initializer.parameter.options"></a>
501
+
502
+ - *Type:* <a href="#@jjrawlins/cdk-deploy-pr-github-action.DeployDispatchInternalOptions">DeployDispatchInternalOptions</a>
503
+
504
+ ---
505
+
506
+
507
+
508
+
509
+
510
+ ### CdkDeployPipeline <a name="CdkDeployPipeline" id="@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipeline"></a>
511
+
512
+ Generates GitHub Actions workflows for CDK deployments.
513
+
514
+ Creates a `deploy.yml` workflow with:
515
+ - Synth job to compile and synthesize the CDK app
516
+ - Asset publish job to upload Lambda/container assets to AWS
517
+ - Per-stage deploy jobs with GitHub Environments, parallel execution, and concurrency groups
518
+
519
+ Optionally creates a `deploy-dispatch.yml` workflow for manual deployments and rollbacks.
520
+
521
+ #### Initializers <a name="Initializers" id="@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipeline.Initializer"></a>
522
+
523
+ ```typescript
524
+ import { CdkDeployPipeline } from '@jjrawlins/cdk-deploy-pr-github-action'
525
+
526
+ new CdkDeployPipeline(project: any, options: CdkDeployPipelineOptions)
527
+ ```
528
+
529
+ | **Name** | **Type** | **Description** |
530
+ | --- | --- | --- |
531
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipeline.Initializer.parameter.project">project</a></code> | <code>any</code> | *No description.* |
532
+ | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipeline.Initializer.parameter.options">options</a></code> | <code><a href="#@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions">CdkDeployPipelineOptions</a></code> | *No description.* |
533
+
534
+ ---
535
+
536
+ ##### `project`<sup>Required</sup> <a name="project" id="@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipeline.Initializer.parameter.project"></a>
537
+
538
+ - *Type:* any
539
+
540
+ ---
541
+
542
+ ##### `options`<sup>Required</sup> <a name="options" id="@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipeline.Initializer.parameter.options"></a>
543
+
544
+ - *Type:* <a href="#@jjrawlins/cdk-deploy-pr-github-action.CdkDeployPipelineOptions">CdkDeployPipelineOptions</a>
545
+
546
+ ---
547
+
548
+
549
+
550
+
551
+
552
+