@taimos/projen 0.1.66 → 0.1.68
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 +244 -36
- package/API.md +330 -0
- package/lib/components/index.d.ts +1 -0
- package/lib/components/index.js +18 -0
- package/lib/components/production-release.d.ts +54 -0
- package/lib/components/production-release.js +104 -0
- package/lib/index.d.ts +1 -0
- package/lib/index.js +2 -1
- package/lib/projects/cdk-app.js +1 -1
- package/lib/projects/cdk-construct.js +1 -1
- package/lib/projects/monorepo.d.ts +19 -0
- package/lib/projects/monorepo.js +13 -2
- package/lib/projects/private-cdk-app.js +1 -1
- package/lib/projects/private-ts-lib.js +1 -1
- package/lib/projects/prod-cdk-app.js +1 -1
- package/lib/projects/ts-lib.js +1 -1
- package/package.json +3 -2
package/API.md
CHANGED
|
@@ -2,6 +2,213 @@
|
|
|
2
2
|
|
|
3
3
|
## Constructs <a name="Constructs" id="Constructs"></a>
|
|
4
4
|
|
|
5
|
+
### GitHubProductionRelease <a name="GitHubProductionRelease" id="@taimos/projen.GitHubProductionRelease"></a>
|
|
6
|
+
|
|
7
|
+
Adds a manual "Production Release" workflow that promotes a branch into a production branch.
|
|
8
|
+
|
|
9
|
+
The workflow is triggered via `workflow_dispatch`. It fast-forward merges the
|
|
10
|
+
project's default release branch into the selected production branch and
|
|
11
|
+
pushes it. This keeps a production promotion a deliberate, auditable manual
|
|
12
|
+
action separate from merging to the default release branch. When several
|
|
13
|
+
production branches are configured, the operator chooses the target at
|
|
14
|
+
dispatch time.
|
|
15
|
+
|
|
16
|
+
#### Initializers <a name="Initializers" id="@taimos/projen.GitHubProductionRelease.Initializer"></a>
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { GitHubProductionRelease } from '@taimos/projen'
|
|
20
|
+
|
|
21
|
+
new GitHubProductionRelease(scope: GitHubProject, options?: GitHubProductionReleaseOptions)
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
| **Name** | **Type** | **Description** |
|
|
25
|
+
| --- | --- | --- |
|
|
26
|
+
| <code><a href="#@taimos/projen.GitHubProductionRelease.Initializer.parameter.scope">scope</a></code> | <code>projen.github.GitHubProject</code> | *No description.* |
|
|
27
|
+
| <code><a href="#@taimos/projen.GitHubProductionRelease.Initializer.parameter.options">options</a></code> | <code><a href="#@taimos/projen.GitHubProductionReleaseOptions">GitHubProductionReleaseOptions</a></code> | *No description.* |
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
##### `scope`<sup>Required</sup> <a name="scope" id="@taimos/projen.GitHubProductionRelease.Initializer.parameter.scope"></a>
|
|
32
|
+
|
|
33
|
+
- *Type:* projen.github.GitHubProject
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
##### `options`<sup>Optional</sup> <a name="options" id="@taimos/projen.GitHubProductionRelease.Initializer.parameter.options"></a>
|
|
38
|
+
|
|
39
|
+
- *Type:* <a href="#@taimos/projen.GitHubProductionReleaseOptions">GitHubProductionReleaseOptions</a>
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
44
|
+
|
|
45
|
+
| **Name** | **Description** |
|
|
46
|
+
| --- | --- |
|
|
47
|
+
| <code><a href="#@taimos/projen.GitHubProductionRelease.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
48
|
+
| <code><a href="#@taimos/projen.GitHubProductionRelease.with">with</a></code> | Applies one or more mixins to this construct. |
|
|
49
|
+
| <code><a href="#@taimos/projen.GitHubProductionRelease.postSynthesize">postSynthesize</a></code> | Called after synthesis. |
|
|
50
|
+
| <code><a href="#@taimos/projen.GitHubProductionRelease.preSynthesize">preSynthesize</a></code> | Called before synthesis. |
|
|
51
|
+
| <code><a href="#@taimos/projen.GitHubProductionRelease.synthesize">synthesize</a></code> | Synthesizes files to the project output directory. |
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
##### `toString` <a name="toString" id="@taimos/projen.GitHubProductionRelease.toString"></a>
|
|
56
|
+
|
|
57
|
+
```typescript
|
|
58
|
+
public toString(): string
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Returns a string representation of this construct.
|
|
62
|
+
|
|
63
|
+
##### `with` <a name="with" id="@taimos/projen.GitHubProductionRelease.with"></a>
|
|
64
|
+
|
|
65
|
+
```typescript
|
|
66
|
+
public with(mixins: ...IMixin[]): IConstruct
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Applies one or more mixins to this construct.
|
|
70
|
+
|
|
71
|
+
Mixins are applied in order. The list of constructs is captured at the
|
|
72
|
+
start of the call, so constructs added by a mixin will not be visited.
|
|
73
|
+
Use multiple `with()` calls if subsequent mixins should apply to added
|
|
74
|
+
constructs.
|
|
75
|
+
|
|
76
|
+
###### `mixins`<sup>Required</sup> <a name="mixins" id="@taimos/projen.GitHubProductionRelease.with.parameter.mixins"></a>
|
|
77
|
+
|
|
78
|
+
- *Type:* ...constructs.IMixin[]
|
|
79
|
+
|
|
80
|
+
The mixins to apply.
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
##### `postSynthesize` <a name="postSynthesize" id="@taimos/projen.GitHubProductionRelease.postSynthesize"></a>
|
|
85
|
+
|
|
86
|
+
```typescript
|
|
87
|
+
public postSynthesize(): void
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Called after synthesis.
|
|
91
|
+
|
|
92
|
+
Order is *not* guaranteed.
|
|
93
|
+
|
|
94
|
+
##### `preSynthesize` <a name="preSynthesize" id="@taimos/projen.GitHubProductionRelease.preSynthesize"></a>
|
|
95
|
+
|
|
96
|
+
```typescript
|
|
97
|
+
public preSynthesize(): void
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Called before synthesis.
|
|
101
|
+
|
|
102
|
+
##### `synthesize` <a name="synthesize" id="@taimos/projen.GitHubProductionRelease.synthesize"></a>
|
|
103
|
+
|
|
104
|
+
```typescript
|
|
105
|
+
public synthesize(): void
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
Synthesizes files to the project output directory.
|
|
109
|
+
|
|
110
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
111
|
+
|
|
112
|
+
| **Name** | **Description** |
|
|
113
|
+
| --- | --- |
|
|
114
|
+
| <code><a href="#@taimos/projen.GitHubProductionRelease.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
115
|
+
| <code><a href="#@taimos/projen.GitHubProductionRelease.isComponent">isComponent</a></code> | Test whether the given construct is a component. |
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
##### `isConstruct` <a name="isConstruct" id="@taimos/projen.GitHubProductionRelease.isConstruct"></a>
|
|
120
|
+
|
|
121
|
+
```typescript
|
|
122
|
+
import { GitHubProductionRelease } from '@taimos/projen'
|
|
123
|
+
|
|
124
|
+
GitHubProductionRelease.isConstruct(x: any)
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
Checks if `x` is a construct.
|
|
128
|
+
|
|
129
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
130
|
+
instances, even when the construct library is symlinked.
|
|
131
|
+
|
|
132
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
133
|
+
disk are seen as independent, completely different libraries. As a
|
|
134
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
135
|
+
is seen as a different class, and an instance of one class will not test as
|
|
136
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
137
|
+
like this, but users may manually symlink construct libraries together or
|
|
138
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
139
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
140
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
141
|
+
this type-testing method instead.
|
|
142
|
+
|
|
143
|
+
###### `x`<sup>Required</sup> <a name="x" id="@taimos/projen.GitHubProductionRelease.isConstruct.parameter.x"></a>
|
|
144
|
+
|
|
145
|
+
- *Type:* any
|
|
146
|
+
|
|
147
|
+
Any object.
|
|
148
|
+
|
|
149
|
+
---
|
|
150
|
+
|
|
151
|
+
##### `isComponent` <a name="isComponent" id="@taimos/projen.GitHubProductionRelease.isComponent"></a>
|
|
152
|
+
|
|
153
|
+
```typescript
|
|
154
|
+
import { GitHubProductionRelease } from '@taimos/projen'
|
|
155
|
+
|
|
156
|
+
GitHubProductionRelease.isComponent(x: any)
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
Test whether the given construct is a component.
|
|
160
|
+
|
|
161
|
+
###### `x`<sup>Required</sup> <a name="x" id="@taimos/projen.GitHubProductionRelease.isComponent.parameter.x"></a>
|
|
162
|
+
|
|
163
|
+
- *Type:* any
|
|
164
|
+
|
|
165
|
+
---
|
|
166
|
+
|
|
167
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
168
|
+
|
|
169
|
+
| **Name** | **Type** | **Description** |
|
|
170
|
+
| --- | --- | --- |
|
|
171
|
+
| <code><a href="#@taimos/projen.GitHubProductionRelease.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
172
|
+
| <code><a href="#@taimos/projen.GitHubProductionRelease.property.project">project</a></code> | <code>projen.Project</code> | *No description.* |
|
|
173
|
+
| <code><a href="#@taimos/projen.GitHubProductionRelease.property.workflow">workflow</a></code> | <code>projen.github.GithubWorkflow</code> | The generated production release workflow. |
|
|
174
|
+
|
|
175
|
+
---
|
|
176
|
+
|
|
177
|
+
##### `node`<sup>Required</sup> <a name="node" id="@taimos/projen.GitHubProductionRelease.property.node"></a>
|
|
178
|
+
|
|
179
|
+
```typescript
|
|
180
|
+
public readonly node: Node;
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
- *Type:* constructs.Node
|
|
184
|
+
|
|
185
|
+
The tree node.
|
|
186
|
+
|
|
187
|
+
---
|
|
188
|
+
|
|
189
|
+
##### `project`<sup>Required</sup> <a name="project" id="@taimos/projen.GitHubProductionRelease.property.project"></a>
|
|
190
|
+
|
|
191
|
+
```typescript
|
|
192
|
+
public readonly project: Project;
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
- *Type:* projen.Project
|
|
196
|
+
|
|
197
|
+
---
|
|
198
|
+
|
|
199
|
+
##### `workflow`<sup>Required</sup> <a name="workflow" id="@taimos/projen.GitHubProductionRelease.property.workflow"></a>
|
|
200
|
+
|
|
201
|
+
```typescript
|
|
202
|
+
public readonly workflow: GithubWorkflow;
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
- *Type:* projen.github.GithubWorkflow
|
|
206
|
+
|
|
207
|
+
The generated production release workflow.
|
|
208
|
+
|
|
209
|
+
---
|
|
210
|
+
|
|
211
|
+
|
|
5
212
|
### MonorepoProject <a name="MonorepoProject" id="@taimos/projen.MonorepoProject"></a>
|
|
6
213
|
|
|
7
214
|
Private PNPM-workspace monorepo root, following Taimos ADR-0002.
|
|
@@ -666,10 +873,12 @@ When given a project, this it the project itself.
|
|
|
666
873
|
| <code><a href="#@taimos/projen.MonorepoProject.property.eslint">eslint</a></code> | <code>projen.javascript.Eslint</code> | *No description.* |
|
|
667
874
|
| <code><a href="#@taimos/projen.MonorepoProject.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
|
|
668
875
|
| <code><a href="#@taimos/projen.MonorepoProject.property.tsconfigEslint">tsconfigEslint</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
|
|
876
|
+
| <code><a href="#@taimos/projen.MonorepoProject.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The default release branch (promoted by the production release workflow). |
|
|
669
877
|
| <code><a href="#@taimos/projen.MonorepoProject.property.prBuildWorkflow">prBuildWorkflow</a></code> | <code>projen.github.GithubWorkflow</code> | The unified PR build workflow. |
|
|
670
878
|
| <code><a href="#@taimos/projen.MonorepoProject.property.workspaceFile">workspaceFile</a></code> | <code>projen.YamlFile</code> | The generated `pnpm-workspace.yaml`. |
|
|
671
879
|
| <code><a href="#@taimos/projen.MonorepoProject.property.amplifyFile">amplifyFile</a></code> | <code>projen.YamlFile</code> | The generated `amplify.yml`, if any Amplify apps were configured. |
|
|
672
880
|
| <code><a href="#@taimos/projen.MonorepoProject.property.assignApprover">assignApprover</a></code> | <code>projen-pipelines.GitHubAssignApprover</code> | The PR approver assignment, if enabled. |
|
|
881
|
+
| <code><a href="#@taimos/projen.MonorepoProject.property.productionRelease">productionRelease</a></code> | <code><a href="#@taimos/projen.GitHubProductionRelease">GitHubProductionRelease</a></code> | The production release workflow, if enabled. |
|
|
673
882
|
|
|
674
883
|
---
|
|
675
884
|
|
|
@@ -1356,6 +1565,18 @@ public readonly tsconfigEslint: TypescriptConfig;
|
|
|
1356
1565
|
|
|
1357
1566
|
---
|
|
1358
1567
|
|
|
1568
|
+
##### `defaultReleaseBranch`<sup>Required</sup> <a name="defaultReleaseBranch" id="@taimos/projen.MonorepoProject.property.defaultReleaseBranch"></a>
|
|
1569
|
+
|
|
1570
|
+
```typescript
|
|
1571
|
+
public readonly defaultReleaseBranch: string;
|
|
1572
|
+
```
|
|
1573
|
+
|
|
1574
|
+
- *Type:* string
|
|
1575
|
+
|
|
1576
|
+
The default release branch (promoted by the production release workflow).
|
|
1577
|
+
|
|
1578
|
+
---
|
|
1579
|
+
|
|
1359
1580
|
##### `prBuildWorkflow`<sup>Required</sup> <a name="prBuildWorkflow" id="@taimos/projen.MonorepoProject.property.prBuildWorkflow"></a>
|
|
1360
1581
|
|
|
1361
1582
|
```typescript
|
|
@@ -1404,6 +1625,18 @@ The PR approver assignment, if enabled.
|
|
|
1404
1625
|
|
|
1405
1626
|
---
|
|
1406
1627
|
|
|
1628
|
+
##### `productionRelease`<sup>Optional</sup> <a name="productionRelease" id="@taimos/projen.MonorepoProject.property.productionRelease"></a>
|
|
1629
|
+
|
|
1630
|
+
```typescript
|
|
1631
|
+
public readonly productionRelease: GitHubProductionRelease;
|
|
1632
|
+
```
|
|
1633
|
+
|
|
1634
|
+
- *Type:* <a href="#@taimos/projen.GitHubProductionRelease">GitHubProductionRelease</a>
|
|
1635
|
+
|
|
1636
|
+
The production release workflow, if enabled.
|
|
1637
|
+
|
|
1638
|
+
---
|
|
1639
|
+
|
|
1407
1640
|
#### Constants <a name="Constants" id="Constants"></a>
|
|
1408
1641
|
|
|
1409
1642
|
| **Name** | **Type** | **Description** |
|
|
@@ -9922,6 +10155,72 @@ public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string;
|
|
|
9922
10155
|
|
|
9923
10156
|
## Structs <a name="Structs" id="Structs"></a>
|
|
9924
10157
|
|
|
10158
|
+
### GitHubProductionReleaseOptions <a name="GitHubProductionReleaseOptions" id="@taimos/projen.GitHubProductionReleaseOptions"></a>
|
|
10159
|
+
|
|
10160
|
+
#### Initializer <a name="Initializer" id="@taimos/projen.GitHubProductionReleaseOptions.Initializer"></a>
|
|
10161
|
+
|
|
10162
|
+
```typescript
|
|
10163
|
+
import { GitHubProductionReleaseOptions } from '@taimos/projen'
|
|
10164
|
+
|
|
10165
|
+
const gitHubProductionReleaseOptions: GitHubProductionReleaseOptions = { ... }
|
|
10166
|
+
```
|
|
10167
|
+
|
|
10168
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
10169
|
+
|
|
10170
|
+
| **Name** | **Type** | **Description** |
|
|
10171
|
+
| --- | --- | --- |
|
|
10172
|
+
| <code><a href="#@taimos/projen.GitHubProductionReleaseOptions.property.productionBranches">productionBranches</a></code> | <code>string[]</code> | The production branches that the source branch may be promoted into. |
|
|
10173
|
+
| <code><a href="#@taimos/projen.GitHubProductionReleaseOptions.property.runnerTags">runnerTags</a></code> | <code>string[]</code> | The runner tags used to select the runner. |
|
|
10174
|
+
| <code><a href="#@taimos/projen.GitHubProductionReleaseOptions.property.workflowName">workflowName</a></code> | <code>string</code> | The name of the generated workflow (and its `.yml` file). |
|
|
10175
|
+
|
|
10176
|
+
---
|
|
10177
|
+
|
|
10178
|
+
##### `productionBranches`<sup>Optional</sup> <a name="productionBranches" id="@taimos/projen.GitHubProductionReleaseOptions.property.productionBranches"></a>
|
|
10179
|
+
|
|
10180
|
+
```typescript
|
|
10181
|
+
public readonly productionBranches: string[];
|
|
10182
|
+
```
|
|
10183
|
+
|
|
10184
|
+
- *Type:* string[]
|
|
10185
|
+
- *Default:* ['production']
|
|
10186
|
+
|
|
10187
|
+
The production branches that the source branch may be promoted into.
|
|
10188
|
+
|
|
10189
|
+
Each branch typically backs its own production deployment — e.g. one Amplify
|
|
10190
|
+
app tracking `production` and another tracking `production2`. When more than
|
|
10191
|
+
one branch is given, the `workflow_dispatch` trigger exposes a `target`
|
|
10192
|
+
choice input so the operator picks which branch to promote into at dispatch
|
|
10193
|
+
time. The first entry is the default selection. With a single branch, no
|
|
10194
|
+
input is rendered and that branch is always the target.
|
|
10195
|
+
|
|
10196
|
+
---
|
|
10197
|
+
|
|
10198
|
+
##### `runnerTags`<sup>Optional</sup> <a name="runnerTags" id="@taimos/projen.GitHubProductionReleaseOptions.property.runnerTags"></a>
|
|
10199
|
+
|
|
10200
|
+
```typescript
|
|
10201
|
+
public readonly runnerTags: string[];
|
|
10202
|
+
```
|
|
10203
|
+
|
|
10204
|
+
- *Type:* string[]
|
|
10205
|
+
- *Default:* ['ubuntu-latest']
|
|
10206
|
+
|
|
10207
|
+
The runner tags used to select the runner.
|
|
10208
|
+
|
|
10209
|
+
---
|
|
10210
|
+
|
|
10211
|
+
##### `workflowName`<sup>Optional</sup> <a name="workflowName" id="@taimos/projen.GitHubProductionReleaseOptions.property.workflowName"></a>
|
|
10212
|
+
|
|
10213
|
+
```typescript
|
|
10214
|
+
public readonly workflowName: string;
|
|
10215
|
+
```
|
|
10216
|
+
|
|
10217
|
+
- *Type:* string
|
|
10218
|
+
- *Default:* 'production-release'
|
|
10219
|
+
|
|
10220
|
+
The name of the generated workflow (and its `.yml` file).
|
|
10221
|
+
|
|
10222
|
+
---
|
|
10223
|
+
|
|
9925
10224
|
### MonorepoAmplifyApp <a name="MonorepoAmplifyApp" id="@taimos/projen.MonorepoAmplifyApp"></a>
|
|
9926
10225
|
|
|
9927
10226
|
One AWS Amplify Hosting application served from a workspace package.
|
|
@@ -10257,6 +10556,8 @@ const monorepoProjectOptions: MonorepoProjectOptions = { ... }
|
|
|
10257
10556
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.defaultApprovers">defaultApprovers</a></code> | <code>string[]</code> | Approvers assigned when no author-specific mapping matches. |
|
|
10258
10557
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.nodeVersion">nodeVersion</a></code> | <code>string</code> | The Node.js version used in the generated build workflow. |
|
|
10259
10558
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.pnpmWorkspaceVersion">pnpmWorkspaceVersion</a></code> | <code>string</code> | The pnpm version pinned for the workspace and CI. |
|
|
10559
|
+
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.productionRelease">productionRelease</a></code> | <code>boolean</code> | Whether to add a manual "Production Release" workflow that promotes a branch to the production branch (see `GitHubProductionRelease`). |
|
|
10560
|
+
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.productionReleaseOptions">productionReleaseOptions</a></code> | <code><a href="#@taimos/projen.GitHubProductionReleaseOptions">GitHubProductionReleaseOptions</a></code> | Options for the production release workflow. |
|
|
10260
10561
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.runTestsInBuild">runTestsInBuild</a></code> | <code>boolean</code> | Whether the unified build workflow also runs `pnpm -r run test`. |
|
|
10261
10562
|
| <code><a href="#@taimos/projen.MonorepoProjectOptions.property.workspaceOptions">workspaceOptions</a></code> | <code><a href="#@taimos/projen.MonorepoWorkspaceOptions">MonorepoWorkspaceOptions</a></code> | PNPM workspace tuning for the generated `pnpm-workspace.yaml`. |
|
|
10262
10563
|
|
|
@@ -12469,6 +12770,35 @@ The pnpm version pinned for the workspace and CI.
|
|
|
12469
12770
|
|
|
12470
12771
|
---
|
|
12471
12772
|
|
|
12773
|
+
##### `productionRelease`<sup>Optional</sup> <a name="productionRelease" id="@taimos/projen.MonorepoProjectOptions.property.productionRelease"></a>
|
|
12774
|
+
|
|
12775
|
+
```typescript
|
|
12776
|
+
public readonly productionRelease: boolean;
|
|
12777
|
+
```
|
|
12778
|
+
|
|
12779
|
+
- *Type:* boolean
|
|
12780
|
+
- *Default:* false
|
|
12781
|
+
|
|
12782
|
+
Whether to add a manual "Production Release" workflow that promotes a branch to the production branch (see `GitHubProductionRelease`).
|
|
12783
|
+
|
|
12784
|
+
---
|
|
12785
|
+
|
|
12786
|
+
##### `productionReleaseOptions`<sup>Optional</sup> <a name="productionReleaseOptions" id="@taimos/projen.MonorepoProjectOptions.property.productionReleaseOptions"></a>
|
|
12787
|
+
|
|
12788
|
+
```typescript
|
|
12789
|
+
public readonly productionReleaseOptions: GitHubProductionReleaseOptions;
|
|
12790
|
+
```
|
|
12791
|
+
|
|
12792
|
+
- *Type:* <a href="#@taimos/projen.GitHubProductionReleaseOptions">GitHubProductionReleaseOptions</a>
|
|
12793
|
+
- *Default:* promote `main` to a `production` branch
|
|
12794
|
+
|
|
12795
|
+
Options for the production release workflow.
|
|
12796
|
+
|
|
12797
|
+
Only used when
|
|
12798
|
+
`productionRelease` is enabled.
|
|
12799
|
+
|
|
12800
|
+
---
|
|
12801
|
+
|
|
12472
12802
|
##### `runTestsInBuild`<sup>Optional</sup> <a name="runTestsInBuild" id="@taimos/projen.MonorepoProjectOptions.property.runTestsInBuild"></a>
|
|
12473
12803
|
|
|
12474
12804
|
```typescript
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './production-release';
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./production-release"), exports);
|
|
18
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29tcG9uZW50cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7O0FBQUEsdURBQXFDIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0ICogZnJvbSAnLi9wcm9kdWN0aW9uLXJlbGVhc2UnO1xuIl19
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import { Component, github } from 'projen';
|
|
2
|
+
import { GitHubProject } from 'projen/lib/github';
|
|
3
|
+
export interface GitHubProductionReleaseOptions {
|
|
4
|
+
/**
|
|
5
|
+
* The production branches that the source branch may be promoted into.
|
|
6
|
+
*
|
|
7
|
+
* Each branch typically backs its own production deployment — e.g. one Amplify
|
|
8
|
+
* app tracking `production` and another tracking `production2`. When more than
|
|
9
|
+
* one branch is given, the `workflow_dispatch` trigger exposes a `target`
|
|
10
|
+
* choice input so the operator picks which branch to promote into at dispatch
|
|
11
|
+
* time. The first entry is the default selection. With a single branch, no
|
|
12
|
+
* input is rendered and that branch is always the target.
|
|
13
|
+
*
|
|
14
|
+
* @default ['production']
|
|
15
|
+
*/
|
|
16
|
+
readonly productionBranches?: string[];
|
|
17
|
+
/**
|
|
18
|
+
* The name of the generated workflow (and its `.yml` file).
|
|
19
|
+
*
|
|
20
|
+
* @default 'production-release'
|
|
21
|
+
*/
|
|
22
|
+
readonly workflowName?: string;
|
|
23
|
+
/**
|
|
24
|
+
* The runner tags used to select the runner.
|
|
25
|
+
*
|
|
26
|
+
* @default ['ubuntu-latest']
|
|
27
|
+
*/
|
|
28
|
+
readonly runnerTags?: string[];
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Adds a manual "Production Release" workflow that promotes a branch into a
|
|
32
|
+
* production branch.
|
|
33
|
+
*
|
|
34
|
+
* The workflow is triggered via `workflow_dispatch`. It fast-forward merges the
|
|
35
|
+
* project's default release branch into the selected production branch and
|
|
36
|
+
* pushes it. This keeps a production promotion a deliberate, auditable manual
|
|
37
|
+
* action separate from merging to the default release branch. When several
|
|
38
|
+
* production branches are configured, the operator chooses the target at
|
|
39
|
+
* dispatch time.
|
|
40
|
+
*/
|
|
41
|
+
export declare class GitHubProductionRelease extends Component {
|
|
42
|
+
/**
|
|
43
|
+
* Resolves the branch that is promoted — the project's default release branch.
|
|
44
|
+
*
|
|
45
|
+
* `NodeProject` does not expose the configured default release branch as a
|
|
46
|
+
* public field, so this reads the best available source: a project that
|
|
47
|
+
* exposes `defaultReleaseBranch` (e.g. `MonorepoProject`), then the release
|
|
48
|
+
* component's default branch, falling back to `main`.
|
|
49
|
+
*/
|
|
50
|
+
private static resolveDefaultReleaseBranch;
|
|
51
|
+
/** The generated production release workflow. */
|
|
52
|
+
readonly workflow: github.GithubWorkflow;
|
|
53
|
+
constructor(scope: GitHubProject, options?: GitHubProductionReleaseOptions);
|
|
54
|
+
}
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.GitHubProductionRelease = void 0;
|
|
4
|
+
const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
|
|
5
|
+
const projen_1 = require("projen");
|
|
6
|
+
/**
|
|
7
|
+
* Adds a manual "Production Release" workflow that promotes a branch into a
|
|
8
|
+
* production branch.
|
|
9
|
+
*
|
|
10
|
+
* The workflow is triggered via `workflow_dispatch`. It fast-forward merges the
|
|
11
|
+
* project's default release branch into the selected production branch and
|
|
12
|
+
* pushes it. This keeps a production promotion a deliberate, auditable manual
|
|
13
|
+
* action separate from merging to the default release branch. When several
|
|
14
|
+
* production branches are configured, the operator chooses the target at
|
|
15
|
+
* dispatch time.
|
|
16
|
+
*/
|
|
17
|
+
class GitHubProductionRelease extends projen_1.Component {
|
|
18
|
+
static [JSII_RTTI_SYMBOL_1] = { fqn: "@taimos/projen.GitHubProductionRelease", version: "0.1.68" };
|
|
19
|
+
/**
|
|
20
|
+
* Resolves the branch that is promoted — the project's default release branch.
|
|
21
|
+
*
|
|
22
|
+
* `NodeProject` does not expose the configured default release branch as a
|
|
23
|
+
* public field, so this reads the best available source: a project that
|
|
24
|
+
* exposes `defaultReleaseBranch` (e.g. `MonorepoProject`), then the release
|
|
25
|
+
* component's default branch, falling back to `main`.
|
|
26
|
+
*/
|
|
27
|
+
static resolveDefaultReleaseBranch(scope) {
|
|
28
|
+
const anyScope = scope;
|
|
29
|
+
return anyScope.defaultReleaseBranch
|
|
30
|
+
?? anyScope.release?.defaultBranch
|
|
31
|
+
?? 'main';
|
|
32
|
+
}
|
|
33
|
+
/** The generated production release workflow. */
|
|
34
|
+
workflow;
|
|
35
|
+
constructor(scope, options = {}) {
|
|
36
|
+
super(scope);
|
|
37
|
+
if (!scope.github) {
|
|
38
|
+
throw new Error('GitHubProductionRelease requires a project with GitHub enabled');
|
|
39
|
+
}
|
|
40
|
+
const sourceBranch = GitHubProductionRelease.resolveDefaultReleaseBranch(scope);
|
|
41
|
+
const productionBranches = options.productionBranches ?? ['production'];
|
|
42
|
+
if (productionBranches.length === 0) {
|
|
43
|
+
throw new Error('GitHubProductionRelease requires at least one production branch');
|
|
44
|
+
}
|
|
45
|
+
const workflowName = options.workflowName ?? 'production-release';
|
|
46
|
+
const runnerTags = options.runnerTags ?? ['ubuntu-latest'];
|
|
47
|
+
const multipleTargets = productionBranches.length > 1;
|
|
48
|
+
this.workflow = new projen_1.github.GithubWorkflow(scope.github, workflowName);
|
|
49
|
+
this.workflow.on({
|
|
50
|
+
workflowDispatch: multipleTargets ? {
|
|
51
|
+
inputs: {
|
|
52
|
+
target: {
|
|
53
|
+
description: `Production branch to promote ${sourceBranch} into`,
|
|
54
|
+
type: 'choice',
|
|
55
|
+
options: productionBranches,
|
|
56
|
+
default: productionBranches[0],
|
|
57
|
+
required: true,
|
|
58
|
+
},
|
|
59
|
+
},
|
|
60
|
+
} : {},
|
|
61
|
+
});
|
|
62
|
+
// The target branch is read from an env var rather than interpolated into a
|
|
63
|
+
// run script, so the dispatch input cannot be used for shell injection.
|
|
64
|
+
const targetRef = multipleTargets ? '${{ inputs.target }}' : productionBranches[0];
|
|
65
|
+
this.workflow.addJob('merge-to-production', {
|
|
66
|
+
name: 'Promote to production',
|
|
67
|
+
runsOn: runnerTags,
|
|
68
|
+
permissions: { contents: projen_1.github.workflows.JobPermission.WRITE },
|
|
69
|
+
env: { TARGET_BRANCH: targetRef },
|
|
70
|
+
steps: [
|
|
71
|
+
{
|
|
72
|
+
name: 'Checkout repository',
|
|
73
|
+
uses: 'actions/checkout@v4',
|
|
74
|
+
with: { 'fetch-depth': 0 },
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
name: 'Configure git',
|
|
78
|
+
run: [
|
|
79
|
+
'git config user.name "github-actions[bot]"',
|
|
80
|
+
'git config user.email "github-actions[bot]@users.noreply.github.com"',
|
|
81
|
+
].join('\n'),
|
|
82
|
+
},
|
|
83
|
+
{
|
|
84
|
+
name: 'Fetch all branches',
|
|
85
|
+
run: 'git fetch --all',
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
name: 'Checkout production branch',
|
|
89
|
+
run: 'git checkout "$TARGET_BRANCH"',
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
name: `Merge ${sourceBranch} (fast-forward only)`,
|
|
93
|
+
run: `git merge --ff-only "origin/${sourceBranch}"`,
|
|
94
|
+
},
|
|
95
|
+
{
|
|
96
|
+
name: 'Push to production branch',
|
|
97
|
+
run: 'git push origin "$TARGET_BRANCH"',
|
|
98
|
+
},
|
|
99
|
+
],
|
|
100
|
+
});
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
exports.GitHubProductionRelease = GitHubProductionRelease;
|
|
104
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"production-release.js","sourceRoot":"","sources":["../../src/components/production-release.ts"],"names":[],"mappings":";;;;AAAA,mCAA2C;AAiC3C;;;;;;;;;;GAUG;AACH,MAAa,uBAAwB,SAAQ,kBAAS;;IAEpD;;;;;;;OAOG;IACK,MAAM,CAAC,2BAA2B,CAAC,KAAoB;QAC7D,MAAM,QAAQ,GAAG,KAAY,CAAC;QAC9B,OAAO,QAAQ,CAAC,oBAAoB;eAC/B,QAAQ,CAAC,OAAO,EAAE,aAAa;eAC/B,MAAM,CAAC;IACd,CAAC;IAED,iDAAiD;IACjC,QAAQ,CAAwB;IAEhD,YAAY,KAAoB,EAAE,UAA0C,EAAE;QAC5E,KAAK,CAAC,KAAK,CAAC,CAAC;QAEb,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;QACpF,CAAC;QAED,MAAM,YAAY,GAAG,uBAAuB,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC;QAChF,MAAM,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,IAAI,CAAC,YAAY,CAAC,CAAC;QACxE,IAAI,kBAAkB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAC;QACrF,CAAC;QACD,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,oBAAoB,CAAC;QAClE,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,CAAC,eAAe,CAAC,CAAC;QAE3D,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,GAAG,CAAC,CAAC;QAEtD,IAAI,CAAC,QAAQ,GAAG,IAAI,eAAM,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QACtE,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACf,gBAAgB,EAAE,eAAe,CAAC,CAAC,CAAC;gBAClC,MAAM,EAAE;oBACN,MAAM,EAAE;wBACN,WAAW,EAAE,gCAAgC,YAAY,OAAO;wBAChE,IAAI,EAAE,QAAQ;wBACd,OAAO,EAAE,kBAAkB;wBAC3B,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC;wBAC9B,QAAQ,EAAE,IAAI;qBACf;iBACF;aACF,CAAC,CAAC,CAAC,EAAE;SACP,CAAC,CAAC;QAEH,4EAA4E;QAC5E,wEAAwE;QACxE,MAAM,SAAS,GAAG,eAAe,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;QAEnF,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,qBAAqB,EAAE;YAC1C,IAAI,EAAE,uBAAuB;YAC7B,MAAM,EAAE,UAAU;YAClB,WAAW,EAAE,EAAE,QAAQ,EAAE,eAAM,CAAC,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE;YAC/D,GAAG,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE;YACjC,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,qBAAqB;oBAC3B,IAAI,EAAE,qBAAqB;oBAC3B,IAAI,EAAE,EAAE,aAAa,EAAE,CAAC,EAAE;iBAC3B;gBACD;oBACE,IAAI,EAAE,eAAe;oBACrB,GAAG,EAAE;wBACH,4CAA4C;wBAC5C,sEAAsE;qBACvE,CAAC,IAAI,CAAC,IAAI,CAAC;iBACb;gBACD;oBACE,IAAI,EAAE,oBAAoB;oBAC1B,GAAG,EAAE,iBAAiB;iBACvB;gBACD;oBACE,IAAI,EAAE,4BAA4B;oBAClC,GAAG,EAAE,+BAA+B;iBACrC;gBACD;oBACE,IAAI,EAAE,SAAS,YAAY,sBAAsB;oBACjD,GAAG,EAAE,+BAA+B,YAAY,GAAG;iBACpD;gBACD;oBACE,IAAI,EAAE,2BAA2B;oBACjC,GAAG,EAAE,kCAAkC;iBACxC;aACF;SACF,CAAC,CAAC;IACL,CAAC;;AA5FH,0DA6FC","sourcesContent":["import { Component, github } from 'projen';\nimport { GitHubProject } from 'projen/lib/github';\n\nexport interface GitHubProductionReleaseOptions {\n  /**\n   * The production branches that the source branch may be promoted into.\n   *\n   * Each branch typically backs its own production deployment — e.g. one Amplify\n   * app tracking `production` and another tracking `production2`. When more than\n   * one branch is given, the `workflow_dispatch` trigger exposes a `target`\n   * choice input so the operator picks which branch to promote into at dispatch\n   * time. The first entry is the default selection. With a single branch, no\n   * input is rendered and that branch is always the target.\n   *\n   * @default ['production']\n   */\n  readonly productionBranches?: string[];\n\n  /**\n   * The name of the generated workflow (and its `.yml` file).\n   *\n   * @default 'production-release'\n   */\n  readonly workflowName?: string;\n\n  /**\n   * The runner tags used to select the runner.\n   *\n   * @default ['ubuntu-latest']\n   */\n  readonly runnerTags?: string[];\n}\n\n/**\n * Adds a manual \"Production Release\" workflow that promotes a branch into a\n * production branch.\n *\n * The workflow is triggered via `workflow_dispatch`. It fast-forward merges the\n * project's default release branch into the selected production branch and\n * pushes it. This keeps a production promotion a deliberate, auditable manual\n * action separate from merging to the default release branch. When several\n * production branches are configured, the operator chooses the target at\n * dispatch time.\n */\nexport class GitHubProductionRelease extends Component {\n\n  /**\n   * Resolves the branch that is promoted — the project's default release branch.\n   *\n   * `NodeProject` does not expose the configured default release branch as a\n   * public field, so this reads the best available source: a project that\n   * exposes `defaultReleaseBranch` (e.g. `MonorepoProject`), then the release\n   * component's default branch, falling back to `main`.\n   */\n  private static resolveDefaultReleaseBranch(scope: GitHubProject): string {\n    const anyScope = scope as any;\n    return anyScope.defaultReleaseBranch\n      ?? anyScope.release?.defaultBranch\n      ?? 'main';\n  }\n\n  /** The generated production release workflow. */\n  public readonly workflow: github.GithubWorkflow;\n\n  constructor(scope: GitHubProject, options: GitHubProductionReleaseOptions = {}) {\n    super(scope);\n\n    if (!scope.github) {\n      throw new Error('GitHubProductionRelease requires a project with GitHub enabled');\n    }\n\n    const sourceBranch = GitHubProductionRelease.resolveDefaultReleaseBranch(scope);\n    const productionBranches = options.productionBranches ?? ['production'];\n    if (productionBranches.length === 0) {\n      throw new Error('GitHubProductionRelease requires at least one production branch');\n    }\n    const workflowName = options.workflowName ?? 'production-release';\n    const runnerTags = options.runnerTags ?? ['ubuntu-latest'];\n\n    const multipleTargets = productionBranches.length > 1;\n\n    this.workflow = new github.GithubWorkflow(scope.github, workflowName);\n    this.workflow.on({\n      workflowDispatch: multipleTargets ? {\n        inputs: {\n          target: {\n            description: `Production branch to promote ${sourceBranch} into`,\n            type: 'choice',\n            options: productionBranches,\n            default: productionBranches[0],\n            required: true,\n          },\n        },\n      } : {},\n    });\n\n    // The target branch is read from an env var rather than interpolated into a\n    // run script, so the dispatch input cannot be used for shell injection.\n    const targetRef = multipleTargets ? '${{ inputs.target }}' : productionBranches[0];\n\n    this.workflow.addJob('merge-to-production', {\n      name: 'Promote to production',\n      runsOn: runnerTags,\n      permissions: { contents: github.workflows.JobPermission.WRITE },\n      env: { TARGET_BRANCH: targetRef },\n      steps: [\n        {\n          name: 'Checkout repository',\n          uses: 'actions/checkout@v4',\n          with: { 'fetch-depth': 0 },\n        },\n        {\n          name: 'Configure git',\n          run: [\n            'git config user.name \"github-actions[bot]\"',\n            'git config user.email \"github-actions[bot]@users.noreply.github.com\"',\n          ].join('\\n'),\n        },\n        {\n          name: 'Fetch all branches',\n          run: 'git fetch --all',\n        },\n        {\n          name: 'Checkout production branch',\n          run: 'git checkout \"$TARGET_BRANCH\"',\n        },\n        {\n          name: `Merge ${sourceBranch} (fast-forward only)`,\n          run: `git merge --ff-only \"origin/${sourceBranch}\"`,\n        },\n        {\n          name: 'Push to production branch',\n          run: 'git push origin \"$TARGET_BRANCH\"',\n        },\n      ],\n    });\n  }\n}\n"]}
|
package/lib/index.d.ts
CHANGED
package/lib/index.js
CHANGED
|
@@ -14,5 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
14
14
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./components"), exports);
|
|
17
18
|
__exportStar(require("./projects"), exports);
|
|
18
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
19
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLCtDQUE2QjtBQUM3Qiw2Q0FBMkIiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgKiBmcm9tICcuL2NvbXBvbmVudHMnO1xuZXhwb3J0ICogZnJvbSAnLi9wcm9qZWN0cyc7Il19
|
package/lib/projects/cdk-app.js
CHANGED
|
@@ -9,7 +9,7 @@ const projen_1 = require("projen");
|
|
|
9
9
|
* @pjid taimos-cdk-app
|
|
10
10
|
*/
|
|
11
11
|
class TaimosCdkApp extends projen_1.awscdk.AwsCdkTypeScriptApp {
|
|
12
|
-
static [JSII_RTTI_SYMBOL_1] = { fqn: "@taimos/projen.TaimosCdkApp", version: "0.1.
|
|
12
|
+
static [JSII_RTTI_SYMBOL_1] = { fqn: "@taimos/projen.TaimosCdkApp", version: "0.1.68" };
|
|
13
13
|
constructor(options) {
|
|
14
14
|
super({
|
|
15
15
|
authorEmail: 'info@taimos.de',
|
|
@@ -9,7 +9,7 @@ const projen_1 = require("projen");
|
|
|
9
9
|
* @pjid taimos-awscdk-construct
|
|
10
10
|
*/
|
|
11
11
|
class TaimosCdkConstructLibrary extends projen_1.awscdk.AwsCdkConstructLibrary {
|
|
12
|
-
static [JSII_RTTI_SYMBOL_1] = { fqn: "@taimos/projen.TaimosCdkConstructLibrary", version: "0.1.
|
|
12
|
+
static [JSII_RTTI_SYMBOL_1] = { fqn: "@taimos/projen.TaimosCdkConstructLibrary", version: "0.1.68" };
|
|
13
13
|
constructor(options) {
|
|
14
14
|
super({
|
|
15
15
|
authorOrganization: true,
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { github, typescript, YamlFile } from 'projen';
|
|
2
2
|
import { GitHubAssignApprover } from 'projen-pipelines';
|
|
3
|
+
import { GitHubProductionRelease, GitHubProductionReleaseOptions } from '../components';
|
|
3
4
|
/**
|
|
4
5
|
* The frontend framework an Amplify Hosting application is built with.
|
|
5
6
|
*
|
|
@@ -176,6 +177,20 @@ export interface MonorepoProjectOptions extends typescript.TypeScriptProjectOpti
|
|
|
176
177
|
* @default []
|
|
177
178
|
*/
|
|
178
179
|
readonly amplifyApps?: MonorepoAmplifyApp[];
|
|
180
|
+
/**
|
|
181
|
+
* Whether to add a manual "Production Release" workflow that promotes a branch
|
|
182
|
+
* to the production branch (see `GitHubProductionRelease`).
|
|
183
|
+
*
|
|
184
|
+
* @default false
|
|
185
|
+
*/
|
|
186
|
+
readonly productionRelease?: boolean;
|
|
187
|
+
/**
|
|
188
|
+
* Options for the production release workflow. Only used when
|
|
189
|
+
* `productionRelease` is enabled.
|
|
190
|
+
*
|
|
191
|
+
* @default - promote `main` to a `production` branch
|
|
192
|
+
*/
|
|
193
|
+
readonly productionReleaseOptions?: GitHubProductionReleaseOptions;
|
|
179
194
|
}
|
|
180
195
|
/**
|
|
181
196
|
* Private PNPM-workspace monorepo root, following Taimos ADR-0002.
|
|
@@ -199,6 +214,10 @@ export declare class MonorepoProject extends typescript.TypeScriptProject {
|
|
|
199
214
|
readonly amplifyFile?: YamlFile;
|
|
200
215
|
/** The PR approver assignment, if enabled. */
|
|
201
216
|
readonly assignApprover?: GitHubAssignApprover;
|
|
217
|
+
/** The production release workflow, if enabled. */
|
|
218
|
+
readonly productionRelease?: GitHubProductionRelease;
|
|
219
|
+
/** The default release branch (promoted by the production release workflow). */
|
|
220
|
+
readonly defaultReleaseBranch: string;
|
|
202
221
|
constructor(options: MonorepoProjectOptions);
|
|
203
222
|
private renderAmplifyApp;
|
|
204
223
|
}
|