deployable-awscdk-app-ts 0.1.43 → 0.1.44
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 +2 -2
- package/API.md +2085 -578
- package/lib/index.js +1 -1
- package/package.json +3 -3
package/API.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
# API Reference <a name="API Reference" id="api-reference"></a>
|
|
2
2
|
|
|
3
3
|
|
|
4
|
-
## Structs <a name="Structs" id="
|
|
4
|
+
## Structs <a name="Structs" id="Structs"></a>
|
|
5
5
|
|
|
6
|
-
### AWSCredentials <a name="deployable-awscdk-app-ts.AWSCredentials"
|
|
6
|
+
### AWSCredentials <a name="AWSCredentials" id="deployable-awscdk-app-ts.AWSCredentials"></a>
|
|
7
7
|
|
|
8
|
-
#### Initializer <a name="
|
|
8
|
+
#### Initializer <a name="Initializer" id="deployable-awscdk-app-ts.AWSCredentials.Initializer"></a>
|
|
9
9
|
|
|
10
10
|
```typescript
|
|
11
11
|
import { AWSCredentials } from 'deployable-awscdk-app-ts'
|
|
@@ -13,84 +13,91 @@ import { AWSCredentials } from 'deployable-awscdk-app-ts'
|
|
|
13
13
|
const aWSCredentials: AWSCredentials = { ... }
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
#### Properties <a name="Properties" id="
|
|
16
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
17
17
|
|
|
18
18
|
| **Name** | **Type** | **Description** |
|
|
19
19
|
| --- | --- | --- |
|
|
20
|
-
|
|
|
21
|
-
|
|
|
22
|
-
|
|
|
23
|
-
|
|
|
24
|
-
|
|
|
20
|
+
| <code><a href="#deployable-awscdk-app-ts.AWSCredentials.property.region">region</a></code> | <code>string</code> | Default AWS region for the account. |
|
|
21
|
+
| <code><a href="#deployable-awscdk-app-ts.AWSCredentials.property.accessKeyIdSecretName">accessKeyIdSecretName</a></code> | <code>string</code> | GitHub Secret name for AWS Access Key Id. |
|
|
22
|
+
| <code><a href="#deployable-awscdk-app-ts.AWSCredentials.property.assumeRoleDurationSeconds">assumeRoleDurationSeconds</a></code> | <code>number</code> | Duration of assume role session. |
|
|
23
|
+
| <code><a href="#deployable-awscdk-app-ts.AWSCredentials.property.roleToAssume">roleToAssume</a></code> | <code>string</code> | ARN of AWS role to be assumed. |
|
|
24
|
+
| <code><a href="#deployable-awscdk-app-ts.AWSCredentials.property.secretAccessKeySecretName">secretAccessKeySecretName</a></code> | <code>string</code> | GitHub Secret name for AWS Secret Access Key. |
|
|
25
25
|
|
|
26
26
|
---
|
|
27
27
|
|
|
28
|
-
##### `region`<sup>Required</sup> <a name="deployable-awscdk-app-ts.AWSCredentials.property.region"
|
|
28
|
+
##### `region`<sup>Required</sup> <a name="region" id="deployable-awscdk-app-ts.AWSCredentials.property.region"></a>
|
|
29
29
|
|
|
30
30
|
```typescript
|
|
31
31
|
public readonly region: string;
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
- *Type:*
|
|
34
|
+
- *Type:* string
|
|
35
35
|
|
|
36
36
|
Default AWS region for the account.
|
|
37
37
|
|
|
38
38
|
---
|
|
39
39
|
|
|
40
|
-
|
|
40
|
+
*Example*
|
|
41
|
+
|
|
42
|
+
```typescript
|
|
43
|
+
"us-east-2"
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
##### `accessKeyIdSecretName`<sup>Optional</sup> <a name="accessKeyIdSecretName" id="deployable-awscdk-app-ts.AWSCredentials.property.accessKeyIdSecretName"></a>
|
|
41
48
|
|
|
42
49
|
```typescript
|
|
43
50
|
public readonly accessKeyIdSecretName: string;
|
|
44
51
|
```
|
|
45
52
|
|
|
46
|
-
- *Type:*
|
|
53
|
+
- *Type:* string
|
|
47
54
|
- *Default:* "AWS_ACCESS_KEY_ID"
|
|
48
55
|
|
|
49
56
|
GitHub Secret name for AWS Access Key Id.
|
|
50
57
|
|
|
51
58
|
---
|
|
52
59
|
|
|
53
|
-
##### `assumeRoleDurationSeconds`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.AWSCredentials.property.assumeRoleDurationSeconds"
|
|
60
|
+
##### `assumeRoleDurationSeconds`<sup>Optional</sup> <a name="assumeRoleDurationSeconds" id="deployable-awscdk-app-ts.AWSCredentials.property.assumeRoleDurationSeconds"></a>
|
|
54
61
|
|
|
55
62
|
```typescript
|
|
56
63
|
public readonly assumeRoleDurationSeconds: number;
|
|
57
64
|
```
|
|
58
65
|
|
|
59
|
-
- *Type:*
|
|
66
|
+
- *Type:* number
|
|
60
67
|
- *Default:* 900
|
|
61
68
|
|
|
62
69
|
Duration of assume role session.
|
|
63
70
|
|
|
64
71
|
---
|
|
65
72
|
|
|
66
|
-
##### `roleToAssume`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.AWSCredentials.property.roleToAssume"
|
|
73
|
+
##### `roleToAssume`<sup>Optional</sup> <a name="roleToAssume" id="deployable-awscdk-app-ts.AWSCredentials.property.roleToAssume"></a>
|
|
67
74
|
|
|
68
75
|
```typescript
|
|
69
76
|
public readonly roleToAssume: string;
|
|
70
77
|
```
|
|
71
78
|
|
|
72
|
-
- *Type:*
|
|
79
|
+
- *Type:* string
|
|
73
80
|
|
|
74
81
|
ARN of AWS role to be assumed.
|
|
75
82
|
|
|
76
83
|
---
|
|
77
84
|
|
|
78
|
-
##### `secretAccessKeySecretName`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.AWSCredentials.property.secretAccessKeySecretName"
|
|
85
|
+
##### `secretAccessKeySecretName`<sup>Optional</sup> <a name="secretAccessKeySecretName" id="deployable-awscdk-app-ts.AWSCredentials.property.secretAccessKeySecretName"></a>
|
|
79
86
|
|
|
80
87
|
```typescript
|
|
81
88
|
public readonly secretAccessKeySecretName: string;
|
|
82
89
|
```
|
|
83
90
|
|
|
84
|
-
- *Type:*
|
|
91
|
+
- *Type:* string
|
|
85
92
|
- *Default:* "AWS_SECRET_ACCESS_KEY"
|
|
86
93
|
|
|
87
94
|
GitHub Secret name for AWS Secret Access Key.
|
|
88
95
|
|
|
89
96
|
---
|
|
90
97
|
|
|
91
|
-
### DeployableAwsCdkTypeScriptAppOptions <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions"
|
|
98
|
+
### DeployableAwsCdkTypeScriptAppOptions <a name="DeployableAwsCdkTypeScriptAppOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions"></a>
|
|
92
99
|
|
|
93
|
-
#### Initializer <a name="
|
|
100
|
+
#### Initializer <a name="Initializer" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.Initializer"></a>
|
|
94
101
|
|
|
95
102
|
```typescript
|
|
96
103
|
import { DeployableAwsCdkTypeScriptAppOptions } from 'deployable-awscdk-app-ts'
|
|
@@ -98,256 +105,260 @@ import { DeployableAwsCdkTypeScriptAppOptions } from 'deployable-awscdk-app-ts'
|
|
|
98
105
|
const deployableAwsCdkTypeScriptAppOptions: DeployableAwsCdkTypeScriptAppOptions = { ... }
|
|
99
106
|
```
|
|
100
107
|
|
|
101
|
-
#### Properties <a name="Properties" id="
|
|
108
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
102
109
|
|
|
103
110
|
| **Name** | **Type** | **Description** |
|
|
104
111
|
| --- | --- | --- |
|
|
105
|
-
|
|
|
106
|
-
|
|
|
107
|
-
|
|
|
108
|
-
|
|
|
109
|
-
|
|
|
110
|
-
|
|
|
111
|
-
|
|
|
112
|
-
|
|
|
113
|
-
|
|
|
114
|
-
|
|
|
115
|
-
|
|
|
116
|
-
|
|
|
117
|
-
|
|
|
118
|
-
|
|
|
119
|
-
|
|
|
120
|
-
|
|
|
121
|
-
|
|
|
122
|
-
|
|
|
123
|
-
|
|
|
124
|
-
|
|
|
125
|
-
|
|
|
126
|
-
|
|
|
127
|
-
|
|
|
128
|
-
|
|
|
129
|
-
|
|
|
130
|
-
|
|
|
131
|
-
|
|
|
132
|
-
|
|
|
133
|
-
|
|
|
134
|
-
|
|
|
135
|
-
|
|
|
136
|
-
|
|
|
137
|
-
|
|
|
138
|
-
|
|
|
139
|
-
|
|
|
140
|
-
|
|
|
141
|
-
|
|
|
142
|
-
|
|
|
143
|
-
|
|
|
144
|
-
|
|
|
145
|
-
|
|
|
146
|
-
|
|
|
147
|
-
|
|
|
148
|
-
|
|
|
149
|
-
|
|
|
150
|
-
|
|
|
151
|
-
|
|
|
152
|
-
|
|
|
153
|
-
|
|
|
154
|
-
|
|
|
155
|
-
|
|
|
156
|
-
|
|
|
157
|
-
|
|
|
158
|
-
|
|
|
159
|
-
|
|
|
160
|
-
|
|
|
161
|
-
|
|
|
162
|
-
|
|
|
163
|
-
|
|
|
164
|
-
|
|
|
165
|
-
|
|
|
166
|
-
|
|
|
167
|
-
|
|
|
168
|
-
|
|
|
169
|
-
|
|
|
170
|
-
|
|
|
171
|
-
|
|
|
172
|
-
|
|
|
173
|
-
|
|
|
174
|
-
|
|
|
175
|
-
|
|
|
176
|
-
|
|
|
177
|
-
|
|
|
178
|
-
|
|
|
179
|
-
|
|
|
180
|
-
|
|
|
181
|
-
|
|
|
182
|
-
|
|
|
183
|
-
|
|
|
184
|
-
|
|
|
185
|
-
|
|
|
186
|
-
|
|
|
187
|
-
|
|
|
188
|
-
|
|
|
189
|
-
|
|
|
190
|
-
|
|
|
191
|
-
|
|
|
192
|
-
|
|
|
193
|
-
|
|
|
194
|
-
|
|
|
195
|
-
|
|
|
196
|
-
|
|
|
197
|
-
|
|
|
198
|
-
|
|
|
199
|
-
|
|
|
200
|
-
|
|
|
201
|
-
|
|
|
202
|
-
|
|
|
203
|
-
|
|
|
204
|
-
|
|
|
205
|
-
|
|
|
206
|
-
|
|
|
207
|
-
|
|
|
208
|
-
|
|
|
209
|
-
|
|
|
210
|
-
|
|
|
211
|
-
|
|
|
212
|
-
|
|
|
213
|
-
|
|
|
214
|
-
|
|
|
215
|
-
|
|
|
216
|
-
|
|
|
217
|
-
|
|
|
218
|
-
|
|
|
219
|
-
|
|
|
220
|
-
|
|
|
221
|
-
|
|
|
222
|
-
|
|
|
223
|
-
|
|
|
224
|
-
|
|
|
225
|
-
|
|
|
226
|
-
|
|
|
227
|
-
|
|
|
228
|
-
|
|
|
229
|
-
|
|
|
230
|
-
|
|
|
231
|
-
|
|
|
232
|
-
|
|
|
233
|
-
|
|
|
234
|
-
|
|
|
235
|
-
|
|
|
236
|
-
|
|
|
237
|
-
|
|
|
238
|
-
|
|
|
239
|
-
|
|
|
240
|
-
|
|
|
241
|
-
|
|
|
242
|
-
|
|
|
243
|
-
|
|
|
244
|
-
|
|
|
245
|
-
|
|
|
246
|
-
|
|
|
247
|
-
|
|
|
248
|
-
|
|
|
249
|
-
|
|
|
250
|
-
|
|
|
251
|
-
|
|
|
252
|
-
|
|
|
253
|
-
|
|
|
254
|
-
|
|
|
255
|
-
|
|
|
256
|
-
|
|
|
257
|
-
|
|
|
258
|
-
|
|
|
259
|
-
|
|
|
260
|
-
|
|
|
261
|
-
|
|
|
262
|
-
|
|
|
263
|
-
|
|
264
|
-
---
|
|
265
|
-
|
|
266
|
-
##### `name`<sup>Required</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.name"
|
|
112
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
|
|
113
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
|
114
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.gitOptions">gitOptions</a></code> | <code>projen.GitOptions</code> | Configuration options for git. |
|
|
115
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.logging">logging</a></code> | <code>projen.LoggerOptions</code> | Configure logging options such as verbosity. |
|
|
116
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. |
|
|
117
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.parent">parent</a></code> | <code>projen.Project</code> | The parent project, if this project is part of a bigger project. |
|
|
118
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenCommand">projenCommand</a></code> | <code>string</code> | The shell command to use in order to run the projen CLI. |
|
|
119
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcJson">projenrcJson</a></code> | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
|
|
120
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcJsonOptions">projenrcJsonOptions</a></code> | <code>projen.ProjenrcOptions</code> | Options for .projenrc.json. |
|
|
121
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.renovatebot">renovatebot</a></code> | <code>boolean</code> | Use renovatebot to handle dependency upgrades. |
|
|
122
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.renovatebotOptions">renovatebotOptions</a></code> | <code>projen.RenovatebotOptions</code> | Options for renovatebot. |
|
|
123
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoApproveOptions">autoApproveOptions</a></code> | <code>projen.github.AutoApproveOptions</code> | Enable and configure the 'auto approve' workflow. |
|
|
124
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoMerge">autoMerge</a></code> | <code>boolean</code> | Enable automatic merging on GitHub. |
|
|
125
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoMergeOptions">autoMergeOptions</a></code> | <code>projen.github.AutoMergeOptions</code> | Configure options for automatic merging on GitHub. |
|
|
126
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
|
|
127
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.devContainer">devContainer</a></code> | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces). |
|
|
128
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.github">github</a></code> | <code>boolean</code> | Enable GitHub integration. |
|
|
129
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.githubOptions">githubOptions</a></code> | <code>projen.github.GitHubOptions</code> | Options for GitHub integration. |
|
|
130
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.gitpod">gitpod</a></code> | <code>boolean</code> | Add a Gitpod development environment. |
|
|
131
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.mergify">mergify</a></code> | <code>boolean</code> | Whether mergify should be enabled on this repository or not. |
|
|
132
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.mergifyOptions">mergifyOptions</a></code> | <code>projen.github.MergifyOptions</code> | Options for mergify. |
|
|
133
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | Which type of project this is (library/app). |
|
|
134
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenCredentials">projenCredentials</a></code> | <code>projen.github.GithubCredentials</code> | Choose a method of providing GitHub API access for projen workflows. |
|
|
135
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenTokenSecret">projenTokenSecret</a></code> | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. |
|
|
136
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.readme">readme</a></code> | <code>projen.SampleReadmeProps</code> | The README setup. |
|
|
137
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.stale">stale</a></code> | <code>boolean</code> | Auto-close of stale issues and pull request. |
|
|
138
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.staleOptions">staleOptions</a></code> | <code>projen.github.StaleOptions</code> | Auto-close stale issues and pull requests. |
|
|
139
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.vscode">vscode</a></code> | <code>boolean</code> | Enable VSCode integration. |
|
|
140
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`. |
|
|
141
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.authorEmail">authorEmail</a></code> | <code>string</code> | Author's e-mail. |
|
|
142
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.authorName">authorName</a></code> | <code>string</code> | Author's name. |
|
|
143
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.authorOrganization">authorOrganization</a></code> | <code>boolean</code> | Is the author an organization. |
|
|
144
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.authorUrl">authorUrl</a></code> | <code>string</code> | Author's URL / Website. |
|
|
145
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoDetectBin">autoDetectBin</a></code> | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. |
|
|
146
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.bin">bin</a></code> | <code>{[ key: string ]: string}</code> | Binary programs vended with your module. |
|
|
147
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.bugsEmail">bugsEmail</a></code> | <code>string</code> | The email address to which issues should be reported. |
|
|
148
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.bugsUrl">bugsUrl</a></code> | <code>string</code> | The url to your project's issue tracker. |
|
|
149
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
150
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
151
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
|
|
152
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.description">description</a></code> | <code>string</code> | The description is just a string that helps people understand the purpose of the package. |
|
|
153
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.devDeps">devDeps</a></code> | <code>string[]</code> | Build dependencies for this module. |
|
|
154
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.entrypoint">entrypoint</a></code> | <code>string</code> | Module entrypoint (`main` in `package.json`). |
|
|
155
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.homepage">homepage</a></code> | <code>string</code> | Package's Homepage / Website. |
|
|
156
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.keywords">keywords</a></code> | <code>string[]</code> | Keywords to include in `package.json`. |
|
|
157
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.license">license</a></code> | <code>string</code> | License's SPDX identifier. |
|
|
158
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.licensed">licensed</a></code> | <code>boolean</code> | Indicates if a license should be added. |
|
|
159
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Minimum node.js version to require via `engines` (inclusive). |
|
|
160
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive). |
|
|
161
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmAccess">npmAccess</a></code> | <code>projen.javascript.NpmAccess</code> | Access level of the npm package. |
|
|
162
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
|
|
163
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
164
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
|
|
165
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
|
|
166
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
|
|
167
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
|
|
168
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.peerDeps">peerDeps</a></code> | <code>string[]</code> | Peer dependencies for this module. |
|
|
169
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.pnpmVersion">pnpmVersion</a></code> | <code>string</code> | The version of PNPM to use if using PNPM as a package manager. |
|
|
170
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.repository">repository</a></code> | <code>string</code> | The repository is the location where the actual code for your package lives. |
|
|
171
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.repositoryDirectory">repositoryDirectory</a></code> | <code>string</code> | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. |
|
|
172
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
|
|
173
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.scripts">scripts</a></code> | <code>{[ key: string ]: string}</code> | npm scripts to include. |
|
|
174
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
|
|
175
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.jsiiReleaseVersion">jsiiReleaseVersion</a></code> | <code>string</code> | Version requirement of `publib` which is used to publish modules to npm. |
|
|
176
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | Major version to release from the default branch. |
|
|
177
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.minMajorVersion">minMajorVersion</a></code> | <code>number</code> | Minimal Major version to release. |
|
|
178
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmDistTag">npmDistTag</a></code> | <code>string</code> | The npmDistTag to use when publishing from the default branch. |
|
|
179
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.postBuildSteps">postBuildSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | Steps to execute after build as part of the release workflow. |
|
|
180
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.prerelease">prerelease</a></code> | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). |
|
|
181
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.publishDryRun">publishDryRun</a></code> | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command. |
|
|
182
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.publishTasks">publishTasks</a></code> | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows. |
|
|
183
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
|
|
184
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
|
|
185
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
|
|
186
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
|
|
187
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseSchedule">releaseSchedule</a></code> | <code>string</code> | CRON schedule to trigger new releases. |
|
|
188
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseTagPrefix">releaseTagPrefix</a></code> | <code>string</code> | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. |
|
|
189
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
190
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
191
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseWorkflowSetupSteps">releaseWorkflowSetupSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | A set of workflow steps to execute in order to setup the workflow container. |
|
|
192
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.versionrcOptions">versionrcOptions</a></code> | <code>{[ key: string ]: any}</code> | Custom configuration used when creating changelog with standard-version package. |
|
|
193
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowContainerImage">workflowContainerImage</a></code> | <code>string</code> | Container image to use for GitHub workflows. |
|
|
194
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
|
|
195
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
|
|
196
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
197
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). |
|
|
198
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
|
|
199
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
|
|
200
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
201
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with @codeCovTokenSecret. |
|
|
202
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
|
|
203
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
204
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
205
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
|
|
206
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.dependabotOptions">dependabotOptions</a></code> | <code>projen.github.DependabotOptions</code> | Options for dependabot. |
|
|
207
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.depsUpgrade">depsUpgrade</a></code> | <code>boolean</code> | Use github workflows to handle dependency upgrades. |
|
|
208
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.depsUpgradeOptions">depsUpgradeOptions</a></code> | <code>projen.javascript.UpgradeDependenciesOptions</code> | Options for `UpgradeDependencies`. |
|
|
209
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.gitignore">gitignore</a></code> | <code>string[]</code> | Additional entries to .gitignore. |
|
|
210
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.jest">jest</a></code> | <code>boolean</code> | Setup jest unit tests. |
|
|
211
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.jestOptions">jestOptions</a></code> | <code>projen.javascript.JestOptions</code> | Jest options. |
|
|
212
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.mutableBuild">mutableBuild</a></code> | <code>boolean</code> | Automatically update files modified during builds to pull-request branches. |
|
|
213
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmignore">npmignore</a></code> | <code>string[]</code> | Additional entries to .npmignore. |
|
|
214
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmignoreEnabled">npmignoreEnabled</a></code> | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. |
|
|
215
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.package">package</a></code> | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). |
|
|
216
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.prettier">prettier</a></code> | <code>boolean</code> | Setup prettier. |
|
|
217
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.prettierOptions">prettierOptions</a></code> | <code>projen.javascript.PrettierOptions</code> | Prettier options. |
|
|
218
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenDevDependency">projenDevDependency</a></code> | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency. |
|
|
219
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcJs">projenrcJs</a></code> | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. |
|
|
220
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcJsOptions">projenrcJsOptions</a></code> | <code>projen.javascript.ProjenrcOptions</code> | Options for .projenrc.js. |
|
|
221
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenVersion">projenVersion</a></code> | <code>string</code> | Version of projen to install. |
|
|
222
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.pullRequestTemplate">pullRequestTemplate</a></code> | <code>boolean</code> | Include a GitHub pull request template. |
|
|
223
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.pullRequestTemplateContents">pullRequestTemplateContents</a></code> | <code>string[]</code> | The contents of the pull request template. |
|
|
224
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
|
|
225
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
|
|
226
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
|
|
227
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowBootstrapSteps">workflowBootstrapSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | Workflow steps to use in order to bootstrap this repo. |
|
|
228
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
|
|
229
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version to use in GitHub workflows. |
|
|
230
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
|
|
231
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
|
|
232
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | Docs directory. |
|
|
233
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.entrypointTypes">entrypointTypes</a></code> | <code>string</code> | The .d.ts file that includes the type declarations for this module. |
|
|
234
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.eslint">eslint</a></code> | <code>boolean</code> | Setup eslint. |
|
|
235
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.eslintOptions">eslintOptions</a></code> | <code>projen.javascript.EslintOptions</code> | Eslint options. |
|
|
236
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.libdir">libdir</a></code> | <code>string</code> | Typescript artifacts output directory. |
|
|
237
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcTs">projenrcTs</a></code> | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`). |
|
|
238
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcTsOptions">projenrcTsOptions</a></code> | <code>projen.typescript.ProjenrcOptions</code> | Options for .projenrc.ts. |
|
|
239
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.sampleCode">sampleCode</a></code> | <code>boolean</code> | Generate one-time sample in `src/` and `test/` if there are no files there. |
|
|
240
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.srcdir">srcdir</a></code> | <code>string</code> | Typescript sources directory. |
|
|
241
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.testdir">testdir</a></code> | <code>string</code> | Jest tests directory. Tests files should be named `xxx.test.ts`. |
|
|
242
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom TSConfig. |
|
|
243
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
244
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name of the development tsconfig.json file. |
|
|
245
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
246
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.buildCommand">buildCommand</a></code> | <code>string</code> | A command to execute before synthesis. |
|
|
247
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkout">cdkout</a></code> | <code>string</code> | cdk.out directory. |
|
|
248
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.context">context</a></code> | <code>{[ key: string ]: any}</code> | Additional context to include in `cdk.json`. |
|
|
249
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.featureFlags">featureFlags</a></code> | <code>boolean</code> | Include all feature flags in cdk.json. |
|
|
250
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.requireApproval">requireApproval</a></code> | <code>projen.awscdk.ApprovalLevel</code> | To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. |
|
|
251
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.watchExcludes">watchExcludes</a></code> | <code>string[]</code> | Glob patterns to exclude from `cdk watch`. |
|
|
252
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.watchIncludes">watchIncludes</a></code> | <code>string[]</code> | Glob patterns to include in `cdk watch`. |
|
|
253
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkVersion">cdkVersion</a></code> | <code>string</code> | Minimum version of the AWS CDK to depend on. |
|
|
254
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkAssert">cdkAssert</a></code> | <code>boolean</code> | Warning: NodeJS only. |
|
|
255
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkAssertions">cdkAssertions</a></code> | <code>boolean</code> | Install the assertions library? |
|
|
256
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkDependencies">cdkDependencies</a></code> | <code>string[]</code> | Which AWS CDKv1 modules this project requires. |
|
|
257
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkDependenciesAsDeps">cdkDependenciesAsDeps</a></code> | <code>boolean</code> | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). |
|
|
258
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkTestDependencies">cdkTestDependencies</a></code> | <code>string[]</code> | AWS CDK modules required for testing. |
|
|
259
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkVersionPinning">cdkVersionPinning</a></code> | <code>boolean</code> | Use pinned version instead of caret version for CDK. |
|
|
260
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.constructsVersion">constructsVersion</a></code> | <code>string</code> | Minimum version of the `constructs` library to depend on. |
|
|
261
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.appEntrypoint">appEntrypoint</a></code> | <code>string</code> | The CDK app's entrypoint (relative to the source directory, which is "src" by default). |
|
|
262
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.edgeLambdaAutoDiscover">edgeLambdaAutoDiscover</a></code> | <code>boolean</code> | Automatically adds an `cloudfront.experimental.EdgeFunction` for each `.edge-lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. |
|
|
263
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.integrationTestAutoDiscover">integrationTestAutoDiscover</a></code> | <code>boolean</code> | Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory. |
|
|
264
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.lambdaAutoDiscover">lambdaAutoDiscover</a></code> | <code>boolean</code> | Automatically adds an `awscdk.LambdaFunction` for each `.lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. |
|
|
265
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.lambdaExtensionAutoDiscover">lambdaExtensionAutoDiscover</a></code> | <code>boolean</code> | Automatically adds an `awscdk.LambdaExtension` for each `.lambda-extension.ts` entrypoint in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. |
|
|
266
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.lambdaOptions">lambdaOptions</a></code> | <code>projen.awscdk.LambdaFunctionCommonOptions</code> | Common options for all AWS Lambda functions. |
|
|
267
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.checkActiveDeployment">checkActiveDeployment</a></code> | <code>boolean</code> | Whether to check and skip the deployment for environments that have active deployment of the same commit. |
|
|
268
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.deployOptions">deployOptions</a></code> | <code><a href="#deployable-awscdk-app-ts.DeployOptions">DeployOptions</a></code> | Deployment options. |
|
|
269
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.generateNvmrc">generateNvmrc</a></code> | <code>boolean</code> | Whether to generate nvmrc file for the node version of the project if set to true, and no "workflowNodeVersion" is specified will use version 14.18.1. |
|
|
270
|
+
|
|
271
|
+
---
|
|
272
|
+
|
|
273
|
+
##### `name`<sup>Required</sup> <a name="name" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.name"></a>
|
|
267
274
|
|
|
268
275
|
```typescript
|
|
269
276
|
public readonly name: string;
|
|
270
277
|
```
|
|
271
278
|
|
|
272
|
-
- *Type:*
|
|
279
|
+
- *Type:* string
|
|
273
280
|
- *Default:* $BASEDIR
|
|
274
281
|
|
|
275
282
|
This is the name of your project.
|
|
276
283
|
|
|
277
284
|
---
|
|
278
285
|
|
|
279
|
-
##### `commitGenerated`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.commitGenerated"
|
|
286
|
+
##### `commitGenerated`<sup>Optional</sup> <a name="commitGenerated" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.commitGenerated"></a>
|
|
280
287
|
|
|
281
288
|
```typescript
|
|
282
289
|
public readonly commitGenerated: boolean;
|
|
283
290
|
```
|
|
284
291
|
|
|
285
|
-
- *Type:*
|
|
292
|
+
- *Type:* boolean
|
|
286
293
|
- *Default:* true
|
|
287
294
|
|
|
288
295
|
Whether to commit the managed files by default.
|
|
289
296
|
|
|
290
297
|
---
|
|
291
298
|
|
|
292
|
-
##### `gitOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.gitOptions"
|
|
299
|
+
##### `gitOptions`<sup>Optional</sup> <a name="gitOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.gitOptions"></a>
|
|
293
300
|
|
|
294
301
|
```typescript
|
|
295
302
|
public readonly gitOptions: GitOptions;
|
|
296
303
|
```
|
|
297
304
|
|
|
298
|
-
- *Type:*
|
|
305
|
+
- *Type:* projen.GitOptions
|
|
299
306
|
|
|
300
307
|
Configuration options for git.
|
|
301
308
|
|
|
302
309
|
---
|
|
303
310
|
|
|
304
|
-
##### `logging`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.logging"
|
|
311
|
+
##### `logging`<sup>Optional</sup> <a name="logging" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.logging"></a>
|
|
305
312
|
|
|
306
313
|
```typescript
|
|
307
314
|
public readonly logging: LoggerOptions;
|
|
308
315
|
```
|
|
309
316
|
|
|
310
|
-
- *Type:*
|
|
317
|
+
- *Type:* projen.LoggerOptions
|
|
311
318
|
- *Default:* {}
|
|
312
319
|
|
|
313
320
|
Configure logging options such as verbosity.
|
|
314
321
|
|
|
315
322
|
---
|
|
316
323
|
|
|
317
|
-
##### `outdir`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.outdir"
|
|
324
|
+
##### `outdir`<sup>Optional</sup> <a name="outdir" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.outdir"></a>
|
|
318
325
|
|
|
319
326
|
```typescript
|
|
320
327
|
public readonly outdir: string;
|
|
321
328
|
```
|
|
322
329
|
|
|
323
|
-
- *Type:*
|
|
330
|
+
- *Type:* string
|
|
324
331
|
- *Default:* "."
|
|
325
332
|
|
|
326
333
|
The root directory of the project.
|
|
327
334
|
|
|
328
|
-
Relative to this directory, all files are synthesized.
|
|
335
|
+
Relative to this directory, all files are synthesized.
|
|
336
|
+
|
|
337
|
+
If this project has a parent, this directory is relative to the parent
|
|
338
|
+
directory and it cannot be the same as the parent or any of it's other
|
|
339
|
+
sub-projects.
|
|
329
340
|
|
|
330
341
|
---
|
|
331
342
|
|
|
332
|
-
##### `parent`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.parent"
|
|
343
|
+
##### `parent`<sup>Optional</sup> <a name="parent" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.parent"></a>
|
|
333
344
|
|
|
334
345
|
```typescript
|
|
335
346
|
public readonly parent: Project;
|
|
336
347
|
```
|
|
337
348
|
|
|
338
|
-
- *Type:*
|
|
349
|
+
- *Type:* projen.Project
|
|
339
350
|
|
|
340
351
|
The parent project, if this project is part of a bigger project.
|
|
341
352
|
|
|
342
353
|
---
|
|
343
354
|
|
|
344
|
-
##### `projenCommand`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenCommand"
|
|
355
|
+
##### `projenCommand`<sup>Optional</sup> <a name="projenCommand" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenCommand"></a>
|
|
345
356
|
|
|
346
357
|
```typescript
|
|
347
358
|
public readonly projenCommand: string;
|
|
348
359
|
```
|
|
349
360
|
|
|
350
|
-
- *Type:*
|
|
361
|
+
- *Type:* string
|
|
351
362
|
- *Default:* "npx projen"
|
|
352
363
|
|
|
353
364
|
The shell command to use in order to run the projen CLI.
|
|
@@ -356,134 +367,136 @@ Can be used to customize in special environments.
|
|
|
356
367
|
|
|
357
368
|
---
|
|
358
369
|
|
|
359
|
-
##### `projenrcJson`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcJson"
|
|
370
|
+
##### `projenrcJson`<sup>Optional</sup> <a name="projenrcJson" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcJson"></a>
|
|
360
371
|
|
|
361
372
|
```typescript
|
|
362
373
|
public readonly projenrcJson: boolean;
|
|
363
374
|
```
|
|
364
375
|
|
|
365
|
-
- *Type:*
|
|
376
|
+
- *Type:* boolean
|
|
366
377
|
- *Default:* false
|
|
367
378
|
|
|
368
379
|
Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
|
|
369
380
|
|
|
370
381
|
---
|
|
371
382
|
|
|
372
|
-
##### `projenrcJsonOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcJsonOptions"
|
|
383
|
+
##### `projenrcJsonOptions`<sup>Optional</sup> <a name="projenrcJsonOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcJsonOptions"></a>
|
|
373
384
|
|
|
374
385
|
```typescript
|
|
375
386
|
public readonly projenrcJsonOptions: ProjenrcOptions;
|
|
376
387
|
```
|
|
377
388
|
|
|
378
|
-
- *Type:*
|
|
389
|
+
- *Type:* projen.ProjenrcOptions
|
|
379
390
|
- *Default:* default options
|
|
380
391
|
|
|
381
392
|
Options for .projenrc.json.
|
|
382
393
|
|
|
383
394
|
---
|
|
384
395
|
|
|
385
|
-
##### `renovatebot`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.renovatebot"
|
|
396
|
+
##### `renovatebot`<sup>Optional</sup> <a name="renovatebot" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.renovatebot"></a>
|
|
386
397
|
|
|
387
398
|
```typescript
|
|
388
399
|
public readonly renovatebot: boolean;
|
|
389
400
|
```
|
|
390
401
|
|
|
391
|
-
- *Type:*
|
|
402
|
+
- *Type:* boolean
|
|
392
403
|
- *Default:* false
|
|
393
404
|
|
|
394
405
|
Use renovatebot to handle dependency upgrades.
|
|
395
406
|
|
|
396
407
|
---
|
|
397
408
|
|
|
398
|
-
##### `renovatebotOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.renovatebotOptions"
|
|
409
|
+
##### `renovatebotOptions`<sup>Optional</sup> <a name="renovatebotOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.renovatebotOptions"></a>
|
|
399
410
|
|
|
400
411
|
```typescript
|
|
401
412
|
public readonly renovatebotOptions: RenovatebotOptions;
|
|
402
413
|
```
|
|
403
414
|
|
|
404
|
-
- *Type:*
|
|
415
|
+
- *Type:* projen.RenovatebotOptions
|
|
405
416
|
- *Default:* default options
|
|
406
417
|
|
|
407
418
|
Options for renovatebot.
|
|
408
419
|
|
|
409
420
|
---
|
|
410
421
|
|
|
411
|
-
##### `autoApproveOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoApproveOptions"
|
|
422
|
+
##### `autoApproveOptions`<sup>Optional</sup> <a name="autoApproveOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoApproveOptions"></a>
|
|
412
423
|
|
|
413
424
|
```typescript
|
|
414
425
|
public readonly autoApproveOptions: AutoApproveOptions;
|
|
415
426
|
```
|
|
416
427
|
|
|
417
|
-
- *Type:*
|
|
428
|
+
- *Type:* projen.github.AutoApproveOptions
|
|
418
429
|
- *Default:* auto approve is disabled
|
|
419
430
|
|
|
420
431
|
Enable and configure the 'auto approve' workflow.
|
|
421
432
|
|
|
422
433
|
---
|
|
423
434
|
|
|
424
|
-
##### `autoMerge`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoMerge"
|
|
435
|
+
##### `autoMerge`<sup>Optional</sup> <a name="autoMerge" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoMerge"></a>
|
|
425
436
|
|
|
426
437
|
```typescript
|
|
427
438
|
public readonly autoMerge: boolean;
|
|
428
439
|
```
|
|
429
440
|
|
|
430
|
-
- *Type:*
|
|
441
|
+
- *Type:* boolean
|
|
431
442
|
- *Default:* true
|
|
432
443
|
|
|
433
444
|
Enable automatic merging on GitHub.
|
|
434
445
|
|
|
435
|
-
Has no effect if `github.mergify`
|
|
446
|
+
Has no effect if `github.mergify`
|
|
447
|
+
is set to false.
|
|
436
448
|
|
|
437
449
|
---
|
|
438
450
|
|
|
439
|
-
##### `autoMergeOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoMergeOptions"
|
|
451
|
+
##### `autoMergeOptions`<sup>Optional</sup> <a name="autoMergeOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoMergeOptions"></a>
|
|
440
452
|
|
|
441
453
|
```typescript
|
|
442
454
|
public readonly autoMergeOptions: AutoMergeOptions;
|
|
443
455
|
```
|
|
444
456
|
|
|
445
|
-
- *Type:*
|
|
457
|
+
- *Type:* projen.github.AutoMergeOptions
|
|
446
458
|
- *Default:* see defaults in `AutoMergeOptions`
|
|
447
459
|
|
|
448
460
|
Configure options for automatic merging on GitHub.
|
|
449
461
|
|
|
450
|
-
Has no effect if
|
|
462
|
+
Has no effect if
|
|
463
|
+
`github.mergify` or `autoMerge` is set to false.
|
|
451
464
|
|
|
452
465
|
---
|
|
453
466
|
|
|
454
|
-
##### `clobber`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.clobber"
|
|
467
|
+
##### `clobber`<sup>Optional</sup> <a name="clobber" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.clobber"></a>
|
|
455
468
|
|
|
456
469
|
```typescript
|
|
457
470
|
public readonly clobber: boolean;
|
|
458
471
|
```
|
|
459
472
|
|
|
460
|
-
- *Type:*
|
|
473
|
+
- *Type:* boolean
|
|
461
474
|
- *Default:* true, but false for subprojects
|
|
462
475
|
|
|
463
476
|
Add a `clobber` task which resets the repo to origin.
|
|
464
477
|
|
|
465
478
|
---
|
|
466
479
|
|
|
467
|
-
##### `devContainer`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.devContainer"
|
|
480
|
+
##### `devContainer`<sup>Optional</sup> <a name="devContainer" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.devContainer"></a>
|
|
468
481
|
|
|
469
482
|
```typescript
|
|
470
483
|
public readonly devContainer: boolean;
|
|
471
484
|
```
|
|
472
485
|
|
|
473
|
-
- *Type:*
|
|
486
|
+
- *Type:* boolean
|
|
474
487
|
- *Default:* false
|
|
475
488
|
|
|
476
489
|
Add a VSCode development environment (used for GitHub Codespaces).
|
|
477
490
|
|
|
478
491
|
---
|
|
479
492
|
|
|
480
|
-
##### `github`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.github"
|
|
493
|
+
##### `github`<sup>Optional</sup> <a name="github" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.github"></a>
|
|
481
494
|
|
|
482
495
|
```typescript
|
|
483
496
|
public readonly github: boolean;
|
|
484
497
|
```
|
|
485
498
|
|
|
486
|
-
- *Type:*
|
|
499
|
+
- *Type:* boolean
|
|
487
500
|
- *Default:* true
|
|
488
501
|
|
|
489
502
|
Enable GitHub integration.
|
|
@@ -492,33 +505,33 @@ Enabled by default for root projects. Disabled for non-root projects.
|
|
|
492
505
|
|
|
493
506
|
---
|
|
494
507
|
|
|
495
|
-
##### `githubOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.githubOptions"
|
|
508
|
+
##### `githubOptions`<sup>Optional</sup> <a name="githubOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.githubOptions"></a>
|
|
496
509
|
|
|
497
510
|
```typescript
|
|
498
511
|
public readonly githubOptions: GitHubOptions;
|
|
499
512
|
```
|
|
500
513
|
|
|
501
|
-
- *Type:*
|
|
514
|
+
- *Type:* projen.github.GitHubOptions
|
|
502
515
|
- *Default:* see GitHubOptions
|
|
503
516
|
|
|
504
517
|
Options for GitHub integration.
|
|
505
518
|
|
|
506
519
|
---
|
|
507
520
|
|
|
508
|
-
##### `gitpod`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.gitpod"
|
|
521
|
+
##### `gitpod`<sup>Optional</sup> <a name="gitpod" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.gitpod"></a>
|
|
509
522
|
|
|
510
523
|
```typescript
|
|
511
524
|
public readonly gitpod: boolean;
|
|
512
525
|
```
|
|
513
526
|
|
|
514
|
-
- *Type:*
|
|
527
|
+
- *Type:* boolean
|
|
515
528
|
- *Default:* false
|
|
516
529
|
|
|
517
530
|
Add a Gitpod development environment.
|
|
518
531
|
|
|
519
532
|
---
|
|
520
533
|
|
|
521
|
-
##### ~~`mergify`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.mergify"
|
|
534
|
+
##### ~~`mergify`~~<sup>Optional</sup> <a name="mergify" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.mergify"></a>
|
|
522
535
|
|
|
523
536
|
- *Deprecated:* use `githubOptions.mergify` instead
|
|
524
537
|
|
|
@@ -526,14 +539,14 @@ Add a Gitpod development environment.
|
|
|
526
539
|
public readonly mergify: boolean;
|
|
527
540
|
```
|
|
528
541
|
|
|
529
|
-
- *Type:*
|
|
542
|
+
- *Type:* boolean
|
|
530
543
|
- *Default:* true
|
|
531
544
|
|
|
532
545
|
Whether mergify should be enabled on this repository or not.
|
|
533
546
|
|
|
534
547
|
---
|
|
535
548
|
|
|
536
|
-
##### ~~`mergifyOptions`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.mergifyOptions"
|
|
549
|
+
##### ~~`mergifyOptions`~~<sup>Optional</sup> <a name="mergifyOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.mergifyOptions"></a>
|
|
537
550
|
|
|
538
551
|
- *Deprecated:* use `githubOptions.mergifyOptions` instead
|
|
539
552
|
|
|
@@ -541,14 +554,14 @@ Whether mergify should be enabled on this repository or not.
|
|
|
541
554
|
public readonly mergifyOptions: MergifyOptions;
|
|
542
555
|
```
|
|
543
556
|
|
|
544
|
-
- *Type:*
|
|
557
|
+
- *Type:* projen.github.MergifyOptions
|
|
545
558
|
- *Default:* default options
|
|
546
559
|
|
|
547
560
|
Options for mergify.
|
|
548
561
|
|
|
549
562
|
---
|
|
550
563
|
|
|
551
|
-
##### ~~`projectType`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projectType"
|
|
564
|
+
##### ~~`projectType`~~<sup>Optional</sup> <a name="projectType" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projectType"></a>
|
|
552
565
|
|
|
553
566
|
- *Deprecated:* no longer supported at the base project level
|
|
554
567
|
|
|
@@ -556,27 +569,27 @@ Options for mergify.
|
|
|
556
569
|
public readonly projectType: ProjectType;
|
|
557
570
|
```
|
|
558
571
|
|
|
559
|
-
- *Type:*
|
|
572
|
+
- *Type:* projen.ProjectType
|
|
560
573
|
- *Default:* ProjectType.UNKNOWN
|
|
561
574
|
|
|
562
575
|
Which type of project this is (library/app).
|
|
563
576
|
|
|
564
577
|
---
|
|
565
578
|
|
|
566
|
-
##### `projenCredentials`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenCredentials"
|
|
579
|
+
##### `projenCredentials`<sup>Optional</sup> <a name="projenCredentials" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenCredentials"></a>
|
|
567
580
|
|
|
568
581
|
```typescript
|
|
569
582
|
public readonly projenCredentials: GithubCredentials;
|
|
570
583
|
```
|
|
571
584
|
|
|
572
|
-
- *Type:*
|
|
585
|
+
- *Type:* projen.github.GithubCredentials
|
|
573
586
|
- *Default:* use a personal access token named PROJEN_GITHUB_TOKEN
|
|
574
587
|
|
|
575
588
|
Choose a method of providing GitHub API access for projen workflows.
|
|
576
589
|
|
|
577
590
|
---
|
|
578
591
|
|
|
579
|
-
##### ~~`projenTokenSecret`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenTokenSecret"
|
|
592
|
+
##### ~~`projenTokenSecret`~~<sup>Optional</sup> <a name="projenTokenSecret" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenTokenSecret"></a>
|
|
580
593
|
|
|
581
594
|
- *Deprecated:* use `projenCredentials`
|
|
582
595
|
|
|
@@ -584,35 +597,43 @@ Choose a method of providing GitHub API access for projen workflows.
|
|
|
584
597
|
public readonly projenTokenSecret: string;
|
|
585
598
|
```
|
|
586
599
|
|
|
587
|
-
- *Type:*
|
|
600
|
+
- *Type:* string
|
|
588
601
|
- *Default:* "PROJEN_GITHUB_TOKEN"
|
|
589
602
|
|
|
590
603
|
The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
|
|
591
604
|
|
|
592
|
-
This token needs to have the `repo`, `workflows`
|
|
605
|
+
This token needs to have the `repo`, `workflows`
|
|
606
|
+
and `packages` scope.
|
|
593
607
|
|
|
594
608
|
---
|
|
595
609
|
|
|
596
|
-
##### `readme`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.readme"
|
|
610
|
+
##### `readme`<sup>Optional</sup> <a name="readme" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.readme"></a>
|
|
597
611
|
|
|
598
612
|
```typescript
|
|
599
613
|
public readonly readme: SampleReadmeProps;
|
|
600
614
|
```
|
|
601
615
|
|
|
602
|
-
- *Type:*
|
|
616
|
+
- *Type:* projen.SampleReadmeProps
|
|
603
617
|
- *Default:* { filename: 'README.md', contents: '# replace this' }
|
|
604
618
|
|
|
605
619
|
The README setup.
|
|
606
620
|
|
|
607
621
|
---
|
|
608
622
|
|
|
609
|
-
|
|
623
|
+
*Example*
|
|
624
|
+
|
|
625
|
+
```typescript
|
|
626
|
+
"{ filename: 'readme.md', contents: '# title' }"
|
|
627
|
+
```
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
##### `stale`<sup>Optional</sup> <a name="stale" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.stale"></a>
|
|
610
631
|
|
|
611
632
|
```typescript
|
|
612
633
|
public readonly stale: boolean;
|
|
613
634
|
```
|
|
614
635
|
|
|
615
|
-
- *Type:*
|
|
636
|
+
- *Type:* boolean
|
|
616
637
|
- *Default:* false
|
|
617
638
|
|
|
618
639
|
Auto-close of stale issues and pull request.
|
|
@@ -621,13 +642,13 @@ See `staleOptions` for options.
|
|
|
621
642
|
|
|
622
643
|
---
|
|
623
644
|
|
|
624
|
-
##### `staleOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.staleOptions"
|
|
645
|
+
##### `staleOptions`<sup>Optional</sup> <a name="staleOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.staleOptions"></a>
|
|
625
646
|
|
|
626
647
|
```typescript
|
|
627
648
|
public readonly staleOptions: StaleOptions;
|
|
628
649
|
```
|
|
629
650
|
|
|
630
|
-
- *Type:*
|
|
651
|
+
- *Type:* projen.github.StaleOptions
|
|
631
652
|
- *Default:* see defaults in `StaleOptions`
|
|
632
653
|
|
|
633
654
|
Auto-close stale issues and pull requests.
|
|
@@ -636,13 +657,13 @@ To disable set `stale` to `false`.
|
|
|
636
657
|
|
|
637
658
|
---
|
|
638
659
|
|
|
639
|
-
##### `vscode`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.vscode"
|
|
660
|
+
##### `vscode`<sup>Optional</sup> <a name="vscode" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.vscode"></a>
|
|
640
661
|
|
|
641
662
|
```typescript
|
|
642
663
|
public readonly vscode: boolean;
|
|
643
664
|
```
|
|
644
665
|
|
|
645
|
-
- *Type:*
|
|
666
|
+
- *Type:* boolean
|
|
646
667
|
- *Default:* true
|
|
647
668
|
|
|
648
669
|
Enable VSCode integration.
|
|
@@ -651,141 +672,153 @@ Enabled by default for root projects. Disabled for non-root projects.
|
|
|
651
672
|
|
|
652
673
|
---
|
|
653
674
|
|
|
654
|
-
##### `allowLibraryDependencies`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.allowLibraryDependencies"
|
|
675
|
+
##### `allowLibraryDependencies`<sup>Optional</sup> <a name="allowLibraryDependencies" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.allowLibraryDependencies"></a>
|
|
655
676
|
|
|
656
677
|
```typescript
|
|
657
678
|
public readonly allowLibraryDependencies: boolean;
|
|
658
679
|
```
|
|
659
680
|
|
|
660
|
-
- *Type:*
|
|
681
|
+
- *Type:* boolean
|
|
661
682
|
- *Default:* true
|
|
662
683
|
|
|
663
684
|
Allow the project to include `peerDependencies` and `bundledDependencies`.
|
|
664
685
|
|
|
665
|
-
This is normally only allowed for libraries. For apps, there's no meaning
|
|
686
|
+
This is normally only allowed for libraries. For apps, there's no meaning
|
|
687
|
+
for specifying these.
|
|
666
688
|
|
|
667
689
|
---
|
|
668
690
|
|
|
669
|
-
##### `authorEmail`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.authorEmail"
|
|
691
|
+
##### `authorEmail`<sup>Optional</sup> <a name="authorEmail" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.authorEmail"></a>
|
|
670
692
|
|
|
671
693
|
```typescript
|
|
672
694
|
public readonly authorEmail: string;
|
|
673
695
|
```
|
|
674
696
|
|
|
675
|
-
- *Type:*
|
|
697
|
+
- *Type:* string
|
|
676
698
|
|
|
677
699
|
Author's e-mail.
|
|
678
700
|
|
|
679
701
|
---
|
|
680
702
|
|
|
681
|
-
##### `authorName`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.authorName"
|
|
703
|
+
##### `authorName`<sup>Optional</sup> <a name="authorName" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.authorName"></a>
|
|
682
704
|
|
|
683
705
|
```typescript
|
|
684
706
|
public readonly authorName: string;
|
|
685
707
|
```
|
|
686
708
|
|
|
687
|
-
- *Type:*
|
|
709
|
+
- *Type:* string
|
|
688
710
|
|
|
689
711
|
Author's name.
|
|
690
712
|
|
|
691
713
|
---
|
|
692
714
|
|
|
693
|
-
##### `authorOrganization`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.authorOrganization"
|
|
715
|
+
##### `authorOrganization`<sup>Optional</sup> <a name="authorOrganization" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.authorOrganization"></a>
|
|
694
716
|
|
|
695
717
|
```typescript
|
|
696
718
|
public readonly authorOrganization: boolean;
|
|
697
719
|
```
|
|
698
720
|
|
|
699
|
-
- *Type:*
|
|
721
|
+
- *Type:* boolean
|
|
700
722
|
|
|
701
723
|
Is the author an organization.
|
|
702
724
|
|
|
703
725
|
---
|
|
704
726
|
|
|
705
|
-
##### `authorUrl`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.authorUrl"
|
|
727
|
+
##### `authorUrl`<sup>Optional</sup> <a name="authorUrl" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.authorUrl"></a>
|
|
706
728
|
|
|
707
729
|
```typescript
|
|
708
730
|
public readonly authorUrl: string;
|
|
709
731
|
```
|
|
710
732
|
|
|
711
|
-
- *Type:*
|
|
733
|
+
- *Type:* string
|
|
712
734
|
|
|
713
735
|
Author's URL / Website.
|
|
714
736
|
|
|
715
737
|
---
|
|
716
738
|
|
|
717
|
-
##### `autoDetectBin`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoDetectBin"
|
|
739
|
+
##### `autoDetectBin`<sup>Optional</sup> <a name="autoDetectBin" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoDetectBin"></a>
|
|
718
740
|
|
|
719
741
|
```typescript
|
|
720
742
|
public readonly autoDetectBin: boolean;
|
|
721
743
|
```
|
|
722
744
|
|
|
723
|
-
- *Type:*
|
|
745
|
+
- *Type:* boolean
|
|
724
746
|
- *Default:* true
|
|
725
747
|
|
|
726
748
|
Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
|
|
727
749
|
|
|
728
750
|
---
|
|
729
751
|
|
|
730
|
-
##### `bin`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.bin"
|
|
752
|
+
##### `bin`<sup>Optional</sup> <a name="bin" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.bin"></a>
|
|
731
753
|
|
|
732
754
|
```typescript
|
|
733
755
|
public readonly bin: {[ key: string ]: string};
|
|
734
756
|
```
|
|
735
757
|
|
|
736
|
-
- *Type:* {[ key: string ]:
|
|
758
|
+
- *Type:* {[ key: string ]: string}
|
|
737
759
|
|
|
738
760
|
Binary programs vended with your module.
|
|
739
761
|
|
|
740
|
-
You can use this option to add/customize how binaries are represented in
|
|
762
|
+
You can use this option to add/customize how binaries are represented in
|
|
763
|
+
your `package.json`, but unless `autoDetectBin` is `false`, every
|
|
764
|
+
executable file under `bin` will automatically be added to this section.
|
|
741
765
|
|
|
742
766
|
---
|
|
743
767
|
|
|
744
|
-
##### `bugsEmail`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.bugsEmail"
|
|
768
|
+
##### `bugsEmail`<sup>Optional</sup> <a name="bugsEmail" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.bugsEmail"></a>
|
|
745
769
|
|
|
746
770
|
```typescript
|
|
747
771
|
public readonly bugsEmail: string;
|
|
748
772
|
```
|
|
749
773
|
|
|
750
|
-
- *Type:*
|
|
774
|
+
- *Type:* string
|
|
751
775
|
|
|
752
776
|
The email address to which issues should be reported.
|
|
753
777
|
|
|
754
778
|
---
|
|
755
779
|
|
|
756
|
-
##### `bugsUrl`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.bugsUrl"
|
|
780
|
+
##### `bugsUrl`<sup>Optional</sup> <a name="bugsUrl" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.bugsUrl"></a>
|
|
757
781
|
|
|
758
782
|
```typescript
|
|
759
783
|
public readonly bugsUrl: string;
|
|
760
784
|
```
|
|
761
785
|
|
|
762
|
-
- *Type:*
|
|
786
|
+
- *Type:* string
|
|
763
787
|
|
|
764
788
|
The url to your project's issue tracker.
|
|
765
789
|
|
|
766
790
|
---
|
|
767
791
|
|
|
768
|
-
##### `bundledDeps`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.bundledDeps"
|
|
792
|
+
##### `bundledDeps`<sup>Optional</sup> <a name="bundledDeps" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.bundledDeps"></a>
|
|
769
793
|
|
|
770
794
|
```typescript
|
|
771
795
|
public readonly bundledDeps: string[];
|
|
772
796
|
```
|
|
773
797
|
|
|
774
|
-
- *Type:*
|
|
798
|
+
- *Type:* string[]
|
|
775
799
|
|
|
776
800
|
List of dependencies to bundle into this module.
|
|
777
801
|
|
|
778
|
-
These modules will be
|
|
802
|
+
These modules will be
|
|
803
|
+
added both to the `dependencies` section and `bundledDependencies` section of
|
|
804
|
+
your `package.json`.
|
|
805
|
+
|
|
806
|
+
The recommendation is to only specify the module name here (e.g.
|
|
807
|
+
`express`). This will behave similar to `yarn add` or `npm install` in the
|
|
808
|
+
sense that it will add the module as a dependency to your `package.json`
|
|
809
|
+
file with the latest version (`^`). You can specify semver requirements in
|
|
810
|
+
the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
|
|
811
|
+
this will be what you `package.json` will eventually include.
|
|
779
812
|
|
|
780
813
|
---
|
|
781
814
|
|
|
782
|
-
##### `codeArtifactOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.codeArtifactOptions"
|
|
815
|
+
##### `codeArtifactOptions`<sup>Optional</sup> <a name="codeArtifactOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.codeArtifactOptions"></a>
|
|
783
816
|
|
|
784
817
|
```typescript
|
|
785
818
|
public readonly codeArtifactOptions: CodeArtifactOptions;
|
|
786
819
|
```
|
|
787
820
|
|
|
788
|
-
- *Type:*
|
|
821
|
+
- *Type:* projen.javascript.CodeArtifactOptions
|
|
789
822
|
- *Default:* undefined
|
|
790
823
|
|
|
791
824
|
Options for npm packages using AWS CodeArtifact.
|
|
@@ -794,57 +827,86 @@ This is required if publishing packages to, or installing scoped packages from A
|
|
|
794
827
|
|
|
795
828
|
---
|
|
796
829
|
|
|
797
|
-
##### `deps`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.deps"
|
|
830
|
+
##### `deps`<sup>Optional</sup> <a name="deps" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.deps"></a>
|
|
798
831
|
|
|
799
832
|
```typescript
|
|
800
833
|
public readonly deps: string[];
|
|
801
834
|
```
|
|
802
835
|
|
|
803
|
-
- *Type:*
|
|
836
|
+
- *Type:* string[]
|
|
804
837
|
- *Default:* []
|
|
805
838
|
|
|
806
839
|
Runtime dependencies of this module.
|
|
807
840
|
|
|
808
|
-
The recommendation is to only specify the module name here (e.g.
|
|
841
|
+
The recommendation is to only specify the module name here (e.g.
|
|
842
|
+
`express`). This will behave similar to `yarn add` or `npm install` in the
|
|
843
|
+
sense that it will add the module as a dependency to your `package.json`
|
|
844
|
+
file with the latest version (`^`). You can specify semver requirements in
|
|
845
|
+
the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
|
|
846
|
+
this will be what you `package.json` will eventually include.
|
|
809
847
|
|
|
810
848
|
---
|
|
811
849
|
|
|
812
|
-
|
|
850
|
+
*Example*
|
|
851
|
+
|
|
852
|
+
```typescript
|
|
853
|
+
[ 'express', 'lodash', 'foo@^2' ]
|
|
854
|
+
```
|
|
855
|
+
|
|
856
|
+
|
|
857
|
+
##### `description`<sup>Optional</sup> <a name="description" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.description"></a>
|
|
813
858
|
|
|
814
859
|
```typescript
|
|
815
860
|
public readonly description: string;
|
|
816
861
|
```
|
|
817
862
|
|
|
818
|
-
- *Type:*
|
|
863
|
+
- *Type:* string
|
|
819
864
|
|
|
820
865
|
The description is just a string that helps people understand the purpose of the package.
|
|
821
866
|
|
|
822
|
-
It can be used when searching for packages in a package manager as well.
|
|
867
|
+
It can be used when searching for packages in a package manager as well.
|
|
868
|
+
See https://classic.yarnpkg.com/en/docs/package-json/#toc-description
|
|
823
869
|
|
|
824
870
|
---
|
|
825
871
|
|
|
826
|
-
##### `devDeps`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.devDeps"
|
|
872
|
+
##### `devDeps`<sup>Optional</sup> <a name="devDeps" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.devDeps"></a>
|
|
827
873
|
|
|
828
874
|
```typescript
|
|
829
875
|
public readonly devDeps: string[];
|
|
830
876
|
```
|
|
831
877
|
|
|
832
|
-
- *Type:*
|
|
878
|
+
- *Type:* string[]
|
|
833
879
|
- *Default:* []
|
|
834
880
|
|
|
835
881
|
Build dependencies for this module.
|
|
836
882
|
|
|
837
|
-
These dependencies will only be
|
|
883
|
+
These dependencies will only be
|
|
884
|
+
available in your build environment but will not be fetched when this
|
|
885
|
+
module is consumed.
|
|
886
|
+
|
|
887
|
+
The recommendation is to only specify the module name here (e.g.
|
|
888
|
+
`express`). This will behave similar to `yarn add` or `npm install` in the
|
|
889
|
+
sense that it will add the module as a dependency to your `package.json`
|
|
890
|
+
file with the latest version (`^`). You can specify semver requirements in
|
|
891
|
+
the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
|
|
892
|
+
this will be what you `package.json` will eventually include.
|
|
838
893
|
|
|
839
894
|
---
|
|
840
895
|
|
|
841
|
-
|
|
896
|
+
*Example*
|
|
897
|
+
|
|
898
|
+
```typescript
|
|
899
|
+
[ 'typescript', '@types/express' ]
|
|
900
|
+
```
|
|
901
|
+
|
|
902
|
+
|
|
903
|
+
##### `entrypoint`<sup>Optional</sup> <a name="entrypoint" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.entrypoint"></a>
|
|
842
904
|
|
|
843
905
|
```typescript
|
|
844
906
|
public readonly entrypoint: string;
|
|
845
907
|
```
|
|
846
908
|
|
|
847
|
-
- *Type:*
|
|
909
|
+
- *Type:* string
|
|
848
910
|
- *Default:* "lib/index.js"
|
|
849
911
|
|
|
850
912
|
Module entrypoint (`main` in `package.json`).
|
|
@@ -853,98 +915,99 @@ Set to an empty string to not include `main` in your package.json
|
|
|
853
915
|
|
|
854
916
|
---
|
|
855
917
|
|
|
856
|
-
##### `homepage`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.homepage"
|
|
918
|
+
##### `homepage`<sup>Optional</sup> <a name="homepage" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.homepage"></a>
|
|
857
919
|
|
|
858
920
|
```typescript
|
|
859
921
|
public readonly homepage: string;
|
|
860
922
|
```
|
|
861
923
|
|
|
862
|
-
- *Type:*
|
|
924
|
+
- *Type:* string
|
|
863
925
|
|
|
864
926
|
Package's Homepage / Website.
|
|
865
927
|
|
|
866
928
|
---
|
|
867
929
|
|
|
868
|
-
##### `keywords`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.keywords"
|
|
930
|
+
##### `keywords`<sup>Optional</sup> <a name="keywords" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.keywords"></a>
|
|
869
931
|
|
|
870
932
|
```typescript
|
|
871
933
|
public readonly keywords: string[];
|
|
872
934
|
```
|
|
873
935
|
|
|
874
|
-
- *Type:*
|
|
936
|
+
- *Type:* string[]
|
|
875
937
|
|
|
876
938
|
Keywords to include in `package.json`.
|
|
877
939
|
|
|
878
940
|
---
|
|
879
941
|
|
|
880
|
-
##### `license`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.license"
|
|
942
|
+
##### `license`<sup>Optional</sup> <a name="license" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.license"></a>
|
|
881
943
|
|
|
882
944
|
```typescript
|
|
883
945
|
public readonly license: string;
|
|
884
946
|
```
|
|
885
947
|
|
|
886
|
-
- *Type:*
|
|
948
|
+
- *Type:* string
|
|
887
949
|
- *Default:* "Apache-2.0"
|
|
888
950
|
|
|
889
951
|
License's SPDX identifier.
|
|
890
952
|
|
|
891
|
-
See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses.
|
|
953
|
+
See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses.
|
|
954
|
+
Use the `licensed` option if you want to no license to be specified.
|
|
892
955
|
|
|
893
956
|
---
|
|
894
957
|
|
|
895
|
-
##### `licensed`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.licensed"
|
|
958
|
+
##### `licensed`<sup>Optional</sup> <a name="licensed" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.licensed"></a>
|
|
896
959
|
|
|
897
960
|
```typescript
|
|
898
961
|
public readonly licensed: boolean;
|
|
899
962
|
```
|
|
900
963
|
|
|
901
|
-
- *Type:*
|
|
964
|
+
- *Type:* boolean
|
|
902
965
|
- *Default:* true
|
|
903
966
|
|
|
904
967
|
Indicates if a license should be added.
|
|
905
968
|
|
|
906
969
|
---
|
|
907
970
|
|
|
908
|
-
##### `maxNodeVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.maxNodeVersion"
|
|
971
|
+
##### `maxNodeVersion`<sup>Optional</sup> <a name="maxNodeVersion" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.maxNodeVersion"></a>
|
|
909
972
|
|
|
910
973
|
```typescript
|
|
911
974
|
public readonly maxNodeVersion: string;
|
|
912
975
|
```
|
|
913
976
|
|
|
914
|
-
- *Type:*
|
|
977
|
+
- *Type:* string
|
|
915
978
|
- *Default:* no max
|
|
916
979
|
|
|
917
980
|
Minimum node.js version to require via `engines` (inclusive).
|
|
918
981
|
|
|
919
982
|
---
|
|
920
983
|
|
|
921
|
-
##### `minNodeVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.minNodeVersion"
|
|
984
|
+
##### `minNodeVersion`<sup>Optional</sup> <a name="minNodeVersion" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.minNodeVersion"></a>
|
|
922
985
|
|
|
923
986
|
```typescript
|
|
924
987
|
public readonly minNodeVersion: string;
|
|
925
988
|
```
|
|
926
989
|
|
|
927
|
-
- *Type:*
|
|
990
|
+
- *Type:* string
|
|
928
991
|
- *Default:* no "engines" specified
|
|
929
992
|
|
|
930
993
|
Minimum Node.js version to require via package.json `engines` (inclusive).
|
|
931
994
|
|
|
932
995
|
---
|
|
933
996
|
|
|
934
|
-
##### `npmAccess`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmAccess"
|
|
997
|
+
##### `npmAccess`<sup>Optional</sup> <a name="npmAccess" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmAccess"></a>
|
|
935
998
|
|
|
936
999
|
```typescript
|
|
937
1000
|
public readonly npmAccess: NpmAccess;
|
|
938
1001
|
```
|
|
939
1002
|
|
|
940
|
-
- *Type:*
|
|
1003
|
+
- *Type:* projen.javascript.NpmAccess
|
|
941
1004
|
- *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
942
1005
|
|
|
943
1006
|
Access level of the npm package.
|
|
944
1007
|
|
|
945
1008
|
---
|
|
946
1009
|
|
|
947
|
-
##### ~~`npmRegistry`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmRegistry"
|
|
1010
|
+
##### ~~`npmRegistry`~~<sup>Optional</sup> <a name="npmRegistry" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmRegistry"></a>
|
|
948
1011
|
|
|
949
1012
|
- *Deprecated:* use `npmRegistryUrl` instead
|
|
950
1013
|
|
|
@@ -952,7 +1015,7 @@ Access level of the npm package.
|
|
|
952
1015
|
public readonly npmRegistry: string;
|
|
953
1016
|
```
|
|
954
1017
|
|
|
955
|
-
- *Type:*
|
|
1018
|
+
- *Type:* string
|
|
956
1019
|
|
|
957
1020
|
The host name of the npm registry to publish to.
|
|
958
1021
|
|
|
@@ -960,13 +1023,13 @@ Cannot be set together with `npmRegistryUrl`.
|
|
|
960
1023
|
|
|
961
1024
|
---
|
|
962
1025
|
|
|
963
|
-
##### `npmRegistryUrl`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmRegistryUrl"
|
|
1026
|
+
##### `npmRegistryUrl`<sup>Optional</sup> <a name="npmRegistryUrl" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmRegistryUrl"></a>
|
|
964
1027
|
|
|
965
1028
|
```typescript
|
|
966
1029
|
public readonly npmRegistryUrl: string;
|
|
967
1030
|
```
|
|
968
1031
|
|
|
969
|
-
- *Type:*
|
|
1032
|
+
- *Type:* string
|
|
970
1033
|
- *Default:* "https://registry.npmjs.org"
|
|
971
1034
|
|
|
972
1035
|
The base URL of the npm package registry.
|
|
@@ -975,92 +1038,104 @@ Must be a URL (e.g. start with "https://" or "http://")
|
|
|
975
1038
|
|
|
976
1039
|
---
|
|
977
1040
|
|
|
978
|
-
##### `npmTokenSecret`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmTokenSecret"
|
|
1041
|
+
##### `npmTokenSecret`<sup>Optional</sup> <a name="npmTokenSecret" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmTokenSecret"></a>
|
|
979
1042
|
|
|
980
1043
|
```typescript
|
|
981
1044
|
public readonly npmTokenSecret: string;
|
|
982
1045
|
```
|
|
983
1046
|
|
|
984
|
-
- *Type:*
|
|
1047
|
+
- *Type:* string
|
|
985
1048
|
- *Default:* "NPM_TOKEN"
|
|
986
1049
|
|
|
987
1050
|
GitHub secret which contains the NPM token to use when publishing packages.
|
|
988
1051
|
|
|
989
1052
|
---
|
|
990
1053
|
|
|
991
|
-
##### `packageManager`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.packageManager"
|
|
1054
|
+
##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.packageManager"></a>
|
|
992
1055
|
|
|
993
1056
|
```typescript
|
|
994
1057
|
public readonly packageManager: NodePackageManager;
|
|
995
1058
|
```
|
|
996
1059
|
|
|
997
|
-
- *Type:*
|
|
1060
|
+
- *Type:* projen.javascript.NodePackageManager
|
|
998
1061
|
- *Default:* NodePackageManager.YARN
|
|
999
1062
|
|
|
1000
1063
|
The Node Package Manager used to execute scripts.
|
|
1001
1064
|
|
|
1002
1065
|
---
|
|
1003
1066
|
|
|
1004
|
-
##### `packageName`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.packageName"
|
|
1067
|
+
##### `packageName`<sup>Optional</sup> <a name="packageName" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.packageName"></a>
|
|
1005
1068
|
|
|
1006
1069
|
```typescript
|
|
1007
1070
|
public readonly packageName: string;
|
|
1008
1071
|
```
|
|
1009
1072
|
|
|
1010
|
-
- *Type:*
|
|
1073
|
+
- *Type:* string
|
|
1011
1074
|
- *Default:* defaults to project name
|
|
1012
1075
|
|
|
1013
1076
|
The "name" in package.json.
|
|
1014
1077
|
|
|
1015
1078
|
---
|
|
1016
1079
|
|
|
1017
|
-
##### `peerDependencyOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.peerDependencyOptions"
|
|
1080
|
+
##### `peerDependencyOptions`<sup>Optional</sup> <a name="peerDependencyOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.peerDependencyOptions"></a>
|
|
1018
1081
|
|
|
1019
1082
|
```typescript
|
|
1020
1083
|
public readonly peerDependencyOptions: PeerDependencyOptions;
|
|
1021
1084
|
```
|
|
1022
1085
|
|
|
1023
|
-
- *Type:*
|
|
1086
|
+
- *Type:* projen.javascript.PeerDependencyOptions
|
|
1024
1087
|
|
|
1025
1088
|
Options for `peerDeps`.
|
|
1026
1089
|
|
|
1027
1090
|
---
|
|
1028
1091
|
|
|
1029
|
-
##### `peerDeps`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.peerDeps"
|
|
1092
|
+
##### `peerDeps`<sup>Optional</sup> <a name="peerDeps" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.peerDeps"></a>
|
|
1030
1093
|
|
|
1031
1094
|
```typescript
|
|
1032
1095
|
public readonly peerDeps: string[];
|
|
1033
1096
|
```
|
|
1034
1097
|
|
|
1035
|
-
- *Type:*
|
|
1098
|
+
- *Type:* string[]
|
|
1036
1099
|
- *Default:* []
|
|
1037
1100
|
|
|
1038
1101
|
Peer dependencies for this module.
|
|
1039
1102
|
|
|
1040
|
-
Dependencies listed here are required to
|
|
1103
|
+
Dependencies listed here are required to
|
|
1104
|
+
be installed (and satisfied) by the _consumer_ of this library. Using peer
|
|
1105
|
+
dependencies allows you to ensure that only a single module of a certain
|
|
1106
|
+
library exists in the `node_modules` tree of your consumers.
|
|
1107
|
+
|
|
1108
|
+
Note that prior to npm@7, peer dependencies are _not_ automatically
|
|
1109
|
+
installed, which means that adding peer dependencies to a library will be a
|
|
1110
|
+
breaking change for your customers.
|
|
1111
|
+
|
|
1112
|
+
Unless `peerDependencyOptions.pinnedDevDependency` is disabled (it is
|
|
1113
|
+
enabled by default), projen will automatically add a dev dependency with a
|
|
1114
|
+
pinned version for each peer dependency. This will ensure that you build &
|
|
1115
|
+
test your module against the lowest peer version required.
|
|
1041
1116
|
|
|
1042
1117
|
---
|
|
1043
1118
|
|
|
1044
|
-
##### `pnpmVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.pnpmVersion"
|
|
1119
|
+
##### `pnpmVersion`<sup>Optional</sup> <a name="pnpmVersion" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.pnpmVersion"></a>
|
|
1045
1120
|
|
|
1046
1121
|
```typescript
|
|
1047
1122
|
public readonly pnpmVersion: string;
|
|
1048
1123
|
```
|
|
1049
1124
|
|
|
1050
|
-
- *Type:*
|
|
1125
|
+
- *Type:* string
|
|
1051
1126
|
- *Default:* "7"
|
|
1052
1127
|
|
|
1053
1128
|
The version of PNPM to use if using PNPM as a package manager.
|
|
1054
1129
|
|
|
1055
1130
|
---
|
|
1056
1131
|
|
|
1057
|
-
##### `repository`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.repository"
|
|
1132
|
+
##### `repository`<sup>Optional</sup> <a name="repository" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.repository"></a>
|
|
1058
1133
|
|
|
1059
1134
|
```typescript
|
|
1060
1135
|
public readonly repository: string;
|
|
1061
1136
|
```
|
|
1062
1137
|
|
|
1063
|
-
- *Type:*
|
|
1138
|
+
- *Type:* string
|
|
1064
1139
|
|
|
1065
1140
|
The repository is the location where the actual code for your package lives.
|
|
1066
1141
|
|
|
@@ -1068,186 +1143,198 @@ See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
|
|
|
1068
1143
|
|
|
1069
1144
|
---
|
|
1070
1145
|
|
|
1071
|
-
##### `repositoryDirectory`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.repositoryDirectory"
|
|
1146
|
+
##### `repositoryDirectory`<sup>Optional</sup> <a name="repositoryDirectory" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.repositoryDirectory"></a>
|
|
1072
1147
|
|
|
1073
1148
|
```typescript
|
|
1074
1149
|
public readonly repositoryDirectory: string;
|
|
1075
1150
|
```
|
|
1076
1151
|
|
|
1077
|
-
- *Type:*
|
|
1152
|
+
- *Type:* string
|
|
1078
1153
|
|
|
1079
1154
|
If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives.
|
|
1080
1155
|
|
|
1081
1156
|
---
|
|
1082
1157
|
|
|
1083
|
-
##### `scopedPackagesOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.scopedPackagesOptions"
|
|
1158
|
+
##### `scopedPackagesOptions`<sup>Optional</sup> <a name="scopedPackagesOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.scopedPackagesOptions"></a>
|
|
1084
1159
|
|
|
1085
1160
|
```typescript
|
|
1086
1161
|
public readonly scopedPackagesOptions: ScopedPackagesOptions[];
|
|
1087
1162
|
```
|
|
1088
1163
|
|
|
1089
|
-
- *Type:*
|
|
1164
|
+
- *Type:* projen.javascript.ScopedPackagesOptions[]
|
|
1090
1165
|
- *Default:* fetch all scoped packages from the public npm registry
|
|
1091
1166
|
|
|
1092
1167
|
Options for privately hosted scoped packages.
|
|
1093
1168
|
|
|
1094
1169
|
---
|
|
1095
1170
|
|
|
1096
|
-
##### `scripts`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.scripts"
|
|
1171
|
+
##### `scripts`<sup>Optional</sup> <a name="scripts" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.scripts"></a>
|
|
1097
1172
|
|
|
1098
1173
|
```typescript
|
|
1099
1174
|
public readonly scripts: {[ key: string ]: string};
|
|
1100
1175
|
```
|
|
1101
1176
|
|
|
1102
|
-
- *Type:* {[ key: string ]:
|
|
1177
|
+
- *Type:* {[ key: string ]: string}
|
|
1103
1178
|
- *Default:* {}
|
|
1104
1179
|
|
|
1105
1180
|
npm scripts to include.
|
|
1106
1181
|
|
|
1107
|
-
If a script has the same name as a standard script,
|
|
1182
|
+
If a script has the same name as a standard script,
|
|
1183
|
+
the standard script will be overwritten.
|
|
1108
1184
|
|
|
1109
1185
|
---
|
|
1110
1186
|
|
|
1111
|
-
##### `stability`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.stability"
|
|
1187
|
+
##### `stability`<sup>Optional</sup> <a name="stability" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.stability"></a>
|
|
1112
1188
|
|
|
1113
1189
|
```typescript
|
|
1114
1190
|
public readonly stability: string;
|
|
1115
1191
|
```
|
|
1116
1192
|
|
|
1117
|
-
- *Type:*
|
|
1193
|
+
- *Type:* string
|
|
1118
1194
|
|
|
1119
1195
|
Package's Stability.
|
|
1120
1196
|
|
|
1121
1197
|
---
|
|
1122
1198
|
|
|
1123
|
-
##### `jsiiReleaseVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.jsiiReleaseVersion"
|
|
1199
|
+
##### `jsiiReleaseVersion`<sup>Optional</sup> <a name="jsiiReleaseVersion" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.jsiiReleaseVersion"></a>
|
|
1124
1200
|
|
|
1125
1201
|
```typescript
|
|
1126
1202
|
public readonly jsiiReleaseVersion: string;
|
|
1127
1203
|
```
|
|
1128
1204
|
|
|
1129
|
-
- *Type:*
|
|
1205
|
+
- *Type:* string
|
|
1130
1206
|
- *Default:* "latest"
|
|
1131
1207
|
|
|
1132
1208
|
Version requirement of `publib` which is used to publish modules to npm.
|
|
1133
1209
|
|
|
1134
1210
|
---
|
|
1135
1211
|
|
|
1136
|
-
##### `majorVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.majorVersion"
|
|
1212
|
+
##### `majorVersion`<sup>Optional</sup> <a name="majorVersion" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.majorVersion"></a>
|
|
1137
1213
|
|
|
1138
1214
|
```typescript
|
|
1139
1215
|
public readonly majorVersion: number;
|
|
1140
1216
|
```
|
|
1141
1217
|
|
|
1142
|
-
- *Type:*
|
|
1218
|
+
- *Type:* number
|
|
1143
1219
|
- *Default:* Major version is not enforced.
|
|
1144
1220
|
|
|
1145
1221
|
Major version to release from the default branch.
|
|
1146
1222
|
|
|
1147
|
-
If this is specified, we bump the latest version of this major version line.
|
|
1223
|
+
If this is specified, we bump the latest version of this major version line.
|
|
1224
|
+
If not specified, we bump the global latest version.
|
|
1148
1225
|
|
|
1149
1226
|
---
|
|
1150
1227
|
|
|
1151
|
-
##### `minMajorVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.minMajorVersion"
|
|
1228
|
+
##### `minMajorVersion`<sup>Optional</sup> <a name="minMajorVersion" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.minMajorVersion"></a>
|
|
1152
1229
|
|
|
1153
1230
|
```typescript
|
|
1154
1231
|
public readonly minMajorVersion: number;
|
|
1155
1232
|
```
|
|
1156
1233
|
|
|
1157
|
-
- *Type:*
|
|
1234
|
+
- *Type:* number
|
|
1158
1235
|
- *Default:* No minimum version is being enforced
|
|
1159
1236
|
|
|
1160
1237
|
Minimal Major version to release.
|
|
1161
1238
|
|
|
1162
|
-
This can be useful to set to 1, as breaking changes before the 1.x major
|
|
1239
|
+
This can be useful to set to 1, as breaking changes before the 1.x major
|
|
1240
|
+
release are not incrementing the major version number.
|
|
1241
|
+
|
|
1242
|
+
Can not be set together with `majorVersion`.
|
|
1163
1243
|
|
|
1164
1244
|
---
|
|
1165
1245
|
|
|
1166
|
-
##### `npmDistTag`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmDistTag"
|
|
1246
|
+
##### `npmDistTag`<sup>Optional</sup> <a name="npmDistTag" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmDistTag"></a>
|
|
1167
1247
|
|
|
1168
1248
|
```typescript
|
|
1169
1249
|
public readonly npmDistTag: string;
|
|
1170
1250
|
```
|
|
1171
1251
|
|
|
1172
|
-
- *Type:*
|
|
1252
|
+
- *Type:* string
|
|
1173
1253
|
- *Default:* "latest"
|
|
1174
1254
|
|
|
1175
1255
|
The npmDistTag to use when publishing from the default branch.
|
|
1176
1256
|
|
|
1177
|
-
To set the npm dist-tag for release branches, set the `npmDistTag` property
|
|
1257
|
+
To set the npm dist-tag for release branches, set the `npmDistTag` property
|
|
1258
|
+
for each branch.
|
|
1178
1259
|
|
|
1179
1260
|
---
|
|
1180
1261
|
|
|
1181
|
-
##### `postBuildSteps`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.postBuildSteps"
|
|
1262
|
+
##### `postBuildSteps`<sup>Optional</sup> <a name="postBuildSteps" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.postBuildSteps"></a>
|
|
1182
1263
|
|
|
1183
1264
|
```typescript
|
|
1184
1265
|
public readonly postBuildSteps: JobStep[];
|
|
1185
1266
|
```
|
|
1186
1267
|
|
|
1187
|
-
- *Type:*
|
|
1268
|
+
- *Type:* projen.github.workflows.JobStep[]
|
|
1188
1269
|
- *Default:* []
|
|
1189
1270
|
|
|
1190
1271
|
Steps to execute after build as part of the release workflow.
|
|
1191
1272
|
|
|
1192
1273
|
---
|
|
1193
1274
|
|
|
1194
|
-
##### `prerelease`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.prerelease"
|
|
1275
|
+
##### `prerelease`<sup>Optional</sup> <a name="prerelease" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.prerelease"></a>
|
|
1195
1276
|
|
|
1196
1277
|
```typescript
|
|
1197
1278
|
public readonly prerelease: string;
|
|
1198
1279
|
```
|
|
1199
1280
|
|
|
1200
|
-
- *Type:*
|
|
1281
|
+
- *Type:* string
|
|
1201
1282
|
- *Default:* normal semantic versions
|
|
1202
1283
|
|
|
1203
1284
|
Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
|
|
1204
1285
|
|
|
1205
1286
|
---
|
|
1206
1287
|
|
|
1207
|
-
##### `publishDryRun`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.publishDryRun"
|
|
1288
|
+
##### `publishDryRun`<sup>Optional</sup> <a name="publishDryRun" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.publishDryRun"></a>
|
|
1208
1289
|
|
|
1209
1290
|
```typescript
|
|
1210
1291
|
public readonly publishDryRun: boolean;
|
|
1211
1292
|
```
|
|
1212
1293
|
|
|
1213
|
-
- *Type:*
|
|
1294
|
+
- *Type:* boolean
|
|
1214
1295
|
- *Default:* false
|
|
1215
1296
|
|
|
1216
1297
|
Instead of actually publishing to package managers, just print the publishing command.
|
|
1217
1298
|
|
|
1218
1299
|
---
|
|
1219
1300
|
|
|
1220
|
-
##### `publishTasks`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.publishTasks"
|
|
1301
|
+
##### `publishTasks`<sup>Optional</sup> <a name="publishTasks" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.publishTasks"></a>
|
|
1221
1302
|
|
|
1222
1303
|
```typescript
|
|
1223
1304
|
public readonly publishTasks: boolean;
|
|
1224
1305
|
```
|
|
1225
1306
|
|
|
1226
|
-
- *Type:*
|
|
1307
|
+
- *Type:* boolean
|
|
1227
1308
|
- *Default:* false
|
|
1228
1309
|
|
|
1229
1310
|
Define publishing tasks that can be executed manually as well as workflows.
|
|
1230
1311
|
|
|
1231
|
-
Normally, publishing only happens within automated workflows. Enable this
|
|
1312
|
+
Normally, publishing only happens within automated workflows. Enable this
|
|
1313
|
+
in order to create a publishing task for each publishing activity.
|
|
1232
1314
|
|
|
1233
1315
|
---
|
|
1234
1316
|
|
|
1235
|
-
##### `releaseBranches`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseBranches"
|
|
1317
|
+
##### `releaseBranches`<sup>Optional</sup> <a name="releaseBranches" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseBranches"></a>
|
|
1236
1318
|
|
|
1237
1319
|
```typescript
|
|
1238
1320
|
public readonly releaseBranches: {[ key: string ]: BranchOptions};
|
|
1239
1321
|
```
|
|
1240
1322
|
|
|
1241
|
-
- *Type:* {[ key: string ]:
|
|
1323
|
+
- *Type:* {[ key: string ]: projen.release.BranchOptions}
|
|
1242
1324
|
- *Default:* no additional branches are used for release. you can use `addBranch()` to add additional branches.
|
|
1243
1325
|
|
|
1244
1326
|
Defines additional release branches.
|
|
1245
1327
|
|
|
1246
|
-
A workflow will be created for each
|
|
1328
|
+
A workflow will be created for each
|
|
1329
|
+
release branch which will publish releases from commits in this branch.
|
|
1330
|
+
Each release branch _must_ be assigned a major version number which is used
|
|
1331
|
+
to enforce that versions published from that branch always use that major
|
|
1332
|
+
version. If multiple branches are used, the `majorVersion` field must also
|
|
1333
|
+
be provided for the default branch.
|
|
1247
1334
|
|
|
1248
1335
|
---
|
|
1249
1336
|
|
|
1250
|
-
##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseEveryCommit"
|
|
1337
|
+
##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseEveryCommit"></a>
|
|
1251
1338
|
|
|
1252
1339
|
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
|
|
1253
1340
|
|
|
@@ -1255,33 +1342,33 @@ A workflow will be created for each release branch which will publish releases f
|
|
|
1255
1342
|
public readonly releaseEveryCommit: boolean;
|
|
1256
1343
|
```
|
|
1257
1344
|
|
|
1258
|
-
- *Type:*
|
|
1345
|
+
- *Type:* boolean
|
|
1259
1346
|
- *Default:* true
|
|
1260
1347
|
|
|
1261
1348
|
Automatically release new versions every commit to one of branches in `releaseBranches`.
|
|
1262
1349
|
|
|
1263
1350
|
---
|
|
1264
1351
|
|
|
1265
|
-
##### `releaseFailureIssue`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseFailureIssue"
|
|
1352
|
+
##### `releaseFailureIssue`<sup>Optional</sup> <a name="releaseFailureIssue" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseFailureIssue"></a>
|
|
1266
1353
|
|
|
1267
1354
|
```typescript
|
|
1268
1355
|
public readonly releaseFailureIssue: boolean;
|
|
1269
1356
|
```
|
|
1270
1357
|
|
|
1271
|
-
- *Type:*
|
|
1358
|
+
- *Type:* boolean
|
|
1272
1359
|
- *Default:* false
|
|
1273
1360
|
|
|
1274
1361
|
Create a github issue on every failed publishing task.
|
|
1275
1362
|
|
|
1276
1363
|
---
|
|
1277
1364
|
|
|
1278
|
-
##### `releaseFailureIssueLabel`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseFailureIssueLabel"
|
|
1365
|
+
##### `releaseFailureIssueLabel`<sup>Optional</sup> <a name="releaseFailureIssueLabel" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseFailureIssueLabel"></a>
|
|
1279
1366
|
|
|
1280
1367
|
```typescript
|
|
1281
1368
|
public readonly releaseFailureIssueLabel: string;
|
|
1282
1369
|
```
|
|
1283
1370
|
|
|
1284
|
-
- *Type:*
|
|
1371
|
+
- *Type:* string
|
|
1285
1372
|
- *Default:* "failed-release"
|
|
1286
1373
|
|
|
1287
1374
|
The label to apply to issues indicating publish failures.
|
|
@@ -1290,7 +1377,7 @@ Only applies if `releaseFailureIssue` is true.
|
|
|
1290
1377
|
|
|
1291
1378
|
---
|
|
1292
1379
|
|
|
1293
|
-
##### ~~`releaseSchedule`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseSchedule"
|
|
1380
|
+
##### ~~`releaseSchedule`~~<sup>Optional</sup> <a name="releaseSchedule" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseSchedule"></a>
|
|
1294
1381
|
|
|
1295
1382
|
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
|
|
1296
1383
|
|
|
@@ -1298,73 +1385,76 @@ Only applies if `releaseFailureIssue` is true.
|
|
|
1298
1385
|
public readonly releaseSchedule: string;
|
|
1299
1386
|
```
|
|
1300
1387
|
|
|
1301
|
-
- *Type:*
|
|
1388
|
+
- *Type:* string
|
|
1302
1389
|
- *Default:* no scheduled releases
|
|
1303
1390
|
|
|
1304
1391
|
CRON schedule to trigger new releases.
|
|
1305
1392
|
|
|
1306
1393
|
---
|
|
1307
1394
|
|
|
1308
|
-
##### `releaseTagPrefix`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseTagPrefix"
|
|
1395
|
+
##### `releaseTagPrefix`<sup>Optional</sup> <a name="releaseTagPrefix" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseTagPrefix"></a>
|
|
1309
1396
|
|
|
1310
1397
|
```typescript
|
|
1311
1398
|
public readonly releaseTagPrefix: string;
|
|
1312
1399
|
```
|
|
1313
1400
|
|
|
1314
|
-
- *Type:*
|
|
1401
|
+
- *Type:* string
|
|
1315
1402
|
- *Default:* "v"
|
|
1316
1403
|
|
|
1317
1404
|
Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
|
|
1318
1405
|
|
|
1319
|
-
Note: this prefix is used to detect the latest tagged version
|
|
1406
|
+
Note: this prefix is used to detect the latest tagged version
|
|
1407
|
+
when bumping, so if you change this on a project with an existing version
|
|
1408
|
+
history, you may need to manually tag your latest release
|
|
1409
|
+
with the new prefix.
|
|
1320
1410
|
|
|
1321
1411
|
---
|
|
1322
1412
|
|
|
1323
|
-
##### `releaseTrigger`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseTrigger"
|
|
1413
|
+
##### `releaseTrigger`<sup>Optional</sup> <a name="releaseTrigger" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseTrigger"></a>
|
|
1324
1414
|
|
|
1325
1415
|
```typescript
|
|
1326
1416
|
public readonly releaseTrigger: ReleaseTrigger;
|
|
1327
1417
|
```
|
|
1328
1418
|
|
|
1329
|
-
- *Type:*
|
|
1419
|
+
- *Type:* projen.release.ReleaseTrigger
|
|
1330
1420
|
- *Default:* Continuous releases (`ReleaseTrigger.continuous()`)
|
|
1331
1421
|
|
|
1332
1422
|
The release trigger to use.
|
|
1333
1423
|
|
|
1334
1424
|
---
|
|
1335
1425
|
|
|
1336
|
-
##### `releaseWorkflowName`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseWorkflowName"
|
|
1426
|
+
##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseWorkflowName"></a>
|
|
1337
1427
|
|
|
1338
1428
|
```typescript
|
|
1339
1429
|
public readonly releaseWorkflowName: string;
|
|
1340
1430
|
```
|
|
1341
1431
|
|
|
1342
|
-
- *Type:*
|
|
1432
|
+
- *Type:* string
|
|
1343
1433
|
- *Default:* "Release"
|
|
1344
1434
|
|
|
1345
1435
|
The name of the default release workflow.
|
|
1346
1436
|
|
|
1347
1437
|
---
|
|
1348
1438
|
|
|
1349
|
-
##### `releaseWorkflowSetupSteps`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseWorkflowSetupSteps"
|
|
1439
|
+
##### `releaseWorkflowSetupSteps`<sup>Optional</sup> <a name="releaseWorkflowSetupSteps" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseWorkflowSetupSteps"></a>
|
|
1350
1440
|
|
|
1351
1441
|
```typescript
|
|
1352
1442
|
public readonly releaseWorkflowSetupSteps: JobStep[];
|
|
1353
1443
|
```
|
|
1354
1444
|
|
|
1355
|
-
- *Type:*
|
|
1445
|
+
- *Type:* projen.github.workflows.JobStep[]
|
|
1356
1446
|
|
|
1357
1447
|
A set of workflow steps to execute in order to setup the workflow container.
|
|
1358
1448
|
|
|
1359
1449
|
---
|
|
1360
1450
|
|
|
1361
|
-
##### `versionrcOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.versionrcOptions"
|
|
1451
|
+
##### `versionrcOptions`<sup>Optional</sup> <a name="versionrcOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.versionrcOptions"></a>
|
|
1362
1452
|
|
|
1363
1453
|
```typescript
|
|
1364
1454
|
public readonly versionrcOptions: {[ key: string ]: any};
|
|
1365
1455
|
```
|
|
1366
1456
|
|
|
1367
|
-
- *Type:* {[ key: string ]:
|
|
1457
|
+
- *Type:* {[ key: string ]: any}
|
|
1368
1458
|
- *Default:* standard configuration applicable for GitHub repositories
|
|
1369
1459
|
|
|
1370
1460
|
Custom configuration used when creating changelog with standard-version package.
|
|
@@ -1373,65 +1463,65 @@ Given values either append to default configuration or overwrite values in it.
|
|
|
1373
1463
|
|
|
1374
1464
|
---
|
|
1375
1465
|
|
|
1376
|
-
##### `workflowContainerImage`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowContainerImage"
|
|
1466
|
+
##### `workflowContainerImage`<sup>Optional</sup> <a name="workflowContainerImage" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowContainerImage"></a>
|
|
1377
1467
|
|
|
1378
1468
|
```typescript
|
|
1379
1469
|
public readonly workflowContainerImage: string;
|
|
1380
1470
|
```
|
|
1381
1471
|
|
|
1382
|
-
- *Type:*
|
|
1472
|
+
- *Type:* string
|
|
1383
1473
|
- *Default:* default image
|
|
1384
1474
|
|
|
1385
1475
|
Container image to use for GitHub workflows.
|
|
1386
1476
|
|
|
1387
1477
|
---
|
|
1388
1478
|
|
|
1389
|
-
##### `workflowRunsOn`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowRunsOn"
|
|
1479
|
+
##### `workflowRunsOn`<sup>Optional</sup> <a name="workflowRunsOn" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowRunsOn"></a>
|
|
1390
1480
|
|
|
1391
1481
|
```typescript
|
|
1392
1482
|
public readonly workflowRunsOn: string[];
|
|
1393
1483
|
```
|
|
1394
1484
|
|
|
1395
|
-
- *Type:*
|
|
1485
|
+
- *Type:* string[]
|
|
1396
1486
|
- *Default:* ["ubuntu-latest"]
|
|
1397
1487
|
|
|
1398
1488
|
Github Runner selection labels.
|
|
1399
1489
|
|
|
1400
1490
|
---
|
|
1401
1491
|
|
|
1402
|
-
##### `defaultReleaseBranch`<sup>Required</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.defaultReleaseBranch"
|
|
1492
|
+
##### `defaultReleaseBranch`<sup>Required</sup> <a name="defaultReleaseBranch" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.defaultReleaseBranch"></a>
|
|
1403
1493
|
|
|
1404
1494
|
```typescript
|
|
1405
1495
|
public readonly defaultReleaseBranch: string;
|
|
1406
1496
|
```
|
|
1407
1497
|
|
|
1408
|
-
- *Type:*
|
|
1498
|
+
- *Type:* string
|
|
1409
1499
|
- *Default:* "main"
|
|
1410
1500
|
|
|
1411
1501
|
The name of the main release branch.
|
|
1412
1502
|
|
|
1413
1503
|
---
|
|
1414
1504
|
|
|
1415
|
-
##### `artifactsDirectory`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.artifactsDirectory"
|
|
1505
|
+
##### `artifactsDirectory`<sup>Optional</sup> <a name="artifactsDirectory" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.artifactsDirectory"></a>
|
|
1416
1506
|
|
|
1417
1507
|
```typescript
|
|
1418
1508
|
public readonly artifactsDirectory: string;
|
|
1419
1509
|
```
|
|
1420
1510
|
|
|
1421
|
-
- *Type:*
|
|
1511
|
+
- *Type:* string
|
|
1422
1512
|
- *Default:* "dist"
|
|
1423
1513
|
|
|
1424
1514
|
A directory which will contain build artifacts.
|
|
1425
1515
|
|
|
1426
1516
|
---
|
|
1427
1517
|
|
|
1428
|
-
##### `autoApproveUpgrades`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoApproveUpgrades"
|
|
1518
|
+
##### `autoApproveUpgrades`<sup>Optional</sup> <a name="autoApproveUpgrades" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.autoApproveUpgrades"></a>
|
|
1429
1519
|
|
|
1430
1520
|
```typescript
|
|
1431
1521
|
public readonly autoApproveUpgrades: boolean;
|
|
1432
1522
|
```
|
|
1433
1523
|
|
|
1434
|
-
- *Type:*
|
|
1524
|
+
- *Type:* boolean
|
|
1435
1525
|
- *Default:* true
|
|
1436
1526
|
|
|
1437
1527
|
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
|
|
@@ -1440,103 +1530,103 @@ Throw if set to true but `autoApproveOptions` are not defined.
|
|
|
1440
1530
|
|
|
1441
1531
|
---
|
|
1442
1532
|
|
|
1443
|
-
##### `buildWorkflow`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.buildWorkflow"
|
|
1533
|
+
##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.buildWorkflow"></a>
|
|
1444
1534
|
|
|
1445
1535
|
```typescript
|
|
1446
1536
|
public readonly buildWorkflow: boolean;
|
|
1447
1537
|
```
|
|
1448
1538
|
|
|
1449
|
-
- *Type:*
|
|
1539
|
+
- *Type:* boolean
|
|
1450
1540
|
- *Default:* true if not a subproject
|
|
1451
1541
|
|
|
1452
1542
|
Define a GitHub workflow for building PRs.
|
|
1453
1543
|
|
|
1454
1544
|
---
|
|
1455
1545
|
|
|
1456
|
-
##### `buildWorkflowTriggers`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.buildWorkflowTriggers"
|
|
1546
|
+
##### `buildWorkflowTriggers`<sup>Optional</sup> <a name="buildWorkflowTriggers" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.buildWorkflowTriggers"></a>
|
|
1457
1547
|
|
|
1458
1548
|
```typescript
|
|
1459
1549
|
public readonly buildWorkflowTriggers: Triggers;
|
|
1460
1550
|
```
|
|
1461
1551
|
|
|
1462
|
-
- *Type:*
|
|
1552
|
+
- *Type:* projen.github.workflows.Triggers
|
|
1463
1553
|
- *Default:* "{ pullRequest: {}, workflowDispatch: {} }"
|
|
1464
1554
|
|
|
1465
1555
|
Build workflow triggers.
|
|
1466
1556
|
|
|
1467
1557
|
---
|
|
1468
1558
|
|
|
1469
|
-
##### `bundlerOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.bundlerOptions"
|
|
1559
|
+
##### `bundlerOptions`<sup>Optional</sup> <a name="bundlerOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.bundlerOptions"></a>
|
|
1470
1560
|
|
|
1471
1561
|
```typescript
|
|
1472
1562
|
public readonly bundlerOptions: BundlerOptions;
|
|
1473
1563
|
```
|
|
1474
1564
|
|
|
1475
|
-
- *Type:*
|
|
1565
|
+
- *Type:* projen.javascript.BundlerOptions
|
|
1476
1566
|
|
|
1477
1567
|
Options for `Bundler`.
|
|
1478
1568
|
|
|
1479
1569
|
---
|
|
1480
1570
|
|
|
1481
|
-
##### `codeCov`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.codeCov"
|
|
1571
|
+
##### `codeCov`<sup>Optional</sup> <a name="codeCov" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.codeCov"></a>
|
|
1482
1572
|
|
|
1483
1573
|
```typescript
|
|
1484
1574
|
public readonly codeCov: boolean;
|
|
1485
1575
|
```
|
|
1486
1576
|
|
|
1487
|
-
- *Type:*
|
|
1577
|
+
- *Type:* boolean
|
|
1488
1578
|
- *Default:* false
|
|
1489
1579
|
|
|
1490
1580
|
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with @codeCovTokenSecret.
|
|
1491
1581
|
|
|
1492
1582
|
---
|
|
1493
1583
|
|
|
1494
|
-
##### `codeCovTokenSecret`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.codeCovTokenSecret"
|
|
1584
|
+
##### `codeCovTokenSecret`<sup>Optional</sup> <a name="codeCovTokenSecret" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.codeCovTokenSecret"></a>
|
|
1495
1585
|
|
|
1496
1586
|
```typescript
|
|
1497
1587
|
public readonly codeCovTokenSecret: string;
|
|
1498
1588
|
```
|
|
1499
1589
|
|
|
1500
|
-
- *Type:*
|
|
1590
|
+
- *Type:* string
|
|
1501
1591
|
- *Default:* if this option is not specified, only public repositories are supported
|
|
1502
1592
|
|
|
1503
1593
|
Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
|
|
1504
1594
|
|
|
1505
1595
|
---
|
|
1506
1596
|
|
|
1507
|
-
##### `copyrightOwner`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.copyrightOwner"
|
|
1597
|
+
##### `copyrightOwner`<sup>Optional</sup> <a name="copyrightOwner" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.copyrightOwner"></a>
|
|
1508
1598
|
|
|
1509
1599
|
```typescript
|
|
1510
1600
|
public readonly copyrightOwner: string;
|
|
1511
1601
|
```
|
|
1512
1602
|
|
|
1513
|
-
- *Type:*
|
|
1603
|
+
- *Type:* string
|
|
1514
1604
|
- *Default:* defaults to the value of authorName or "" if `authorName` is undefined.
|
|
1515
1605
|
|
|
1516
1606
|
License copyright owner.
|
|
1517
1607
|
|
|
1518
1608
|
---
|
|
1519
1609
|
|
|
1520
|
-
##### `copyrightPeriod`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.copyrightPeriod"
|
|
1610
|
+
##### `copyrightPeriod`<sup>Optional</sup> <a name="copyrightPeriod" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.copyrightPeriod"></a>
|
|
1521
1611
|
|
|
1522
1612
|
```typescript
|
|
1523
1613
|
public readonly copyrightPeriod: string;
|
|
1524
1614
|
```
|
|
1525
1615
|
|
|
1526
|
-
- *Type:*
|
|
1616
|
+
- *Type:* string
|
|
1527
1617
|
- *Default:* current year
|
|
1528
1618
|
|
|
1529
1619
|
The copyright years to put in the LICENSE file.
|
|
1530
1620
|
|
|
1531
1621
|
---
|
|
1532
1622
|
|
|
1533
|
-
##### `dependabot`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.dependabot"
|
|
1623
|
+
##### `dependabot`<sup>Optional</sup> <a name="dependabot" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.dependabot"></a>
|
|
1534
1624
|
|
|
1535
1625
|
```typescript
|
|
1536
1626
|
public readonly dependabot: boolean;
|
|
1537
1627
|
```
|
|
1538
1628
|
|
|
1539
|
-
- *Type:*
|
|
1629
|
+
- *Type:* boolean
|
|
1540
1630
|
- *Default:* false
|
|
1541
1631
|
|
|
1542
1632
|
Use dependabot to handle dependency upgrades.
|
|
@@ -1545,26 +1635,26 @@ Cannot be used in conjunction with `depsUpgrade`.
|
|
|
1545
1635
|
|
|
1546
1636
|
---
|
|
1547
1637
|
|
|
1548
|
-
##### `dependabotOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.dependabotOptions"
|
|
1638
|
+
##### `dependabotOptions`<sup>Optional</sup> <a name="dependabotOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.dependabotOptions"></a>
|
|
1549
1639
|
|
|
1550
1640
|
```typescript
|
|
1551
1641
|
public readonly dependabotOptions: DependabotOptions;
|
|
1552
1642
|
```
|
|
1553
1643
|
|
|
1554
|
-
- *Type:*
|
|
1644
|
+
- *Type:* projen.github.DependabotOptions
|
|
1555
1645
|
- *Default:* default options
|
|
1556
1646
|
|
|
1557
1647
|
Options for dependabot.
|
|
1558
1648
|
|
|
1559
1649
|
---
|
|
1560
1650
|
|
|
1561
|
-
##### `depsUpgrade`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.depsUpgrade"
|
|
1651
|
+
##### `depsUpgrade`<sup>Optional</sup> <a name="depsUpgrade" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.depsUpgrade"></a>
|
|
1562
1652
|
|
|
1563
1653
|
```typescript
|
|
1564
1654
|
public readonly depsUpgrade: boolean;
|
|
1565
1655
|
```
|
|
1566
1656
|
|
|
1567
|
-
- *Type:*
|
|
1657
|
+
- *Type:* boolean
|
|
1568
1658
|
- *Default:* true
|
|
1569
1659
|
|
|
1570
1660
|
Use github workflows to handle dependency upgrades.
|
|
@@ -1573,73 +1663,77 @@ Cannot be used in conjunction with `dependabot`.
|
|
|
1573
1663
|
|
|
1574
1664
|
---
|
|
1575
1665
|
|
|
1576
|
-
##### `depsUpgradeOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.depsUpgradeOptions"
|
|
1666
|
+
##### `depsUpgradeOptions`<sup>Optional</sup> <a name="depsUpgradeOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.depsUpgradeOptions"></a>
|
|
1577
1667
|
|
|
1578
1668
|
```typescript
|
|
1579
1669
|
public readonly depsUpgradeOptions: UpgradeDependenciesOptions;
|
|
1580
1670
|
```
|
|
1581
1671
|
|
|
1582
|
-
- *Type:*
|
|
1672
|
+
- *Type:* projen.javascript.UpgradeDependenciesOptions
|
|
1583
1673
|
- *Default:* default options
|
|
1584
1674
|
|
|
1585
1675
|
Options for `UpgradeDependencies`.
|
|
1586
1676
|
|
|
1587
1677
|
---
|
|
1588
1678
|
|
|
1589
|
-
##### `gitignore`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.gitignore"
|
|
1679
|
+
##### `gitignore`<sup>Optional</sup> <a name="gitignore" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.gitignore"></a>
|
|
1590
1680
|
|
|
1591
1681
|
```typescript
|
|
1592
1682
|
public readonly gitignore: string[];
|
|
1593
1683
|
```
|
|
1594
1684
|
|
|
1595
|
-
- *Type:*
|
|
1685
|
+
- *Type:* string[]
|
|
1596
1686
|
|
|
1597
1687
|
Additional entries to .gitignore.
|
|
1598
1688
|
|
|
1599
1689
|
---
|
|
1600
1690
|
|
|
1601
|
-
##### `jest`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.jest"
|
|
1691
|
+
##### `jest`<sup>Optional</sup> <a name="jest" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.jest"></a>
|
|
1602
1692
|
|
|
1603
1693
|
```typescript
|
|
1604
1694
|
public readonly jest: boolean;
|
|
1605
1695
|
```
|
|
1606
1696
|
|
|
1607
|
-
- *Type:*
|
|
1697
|
+
- *Type:* boolean
|
|
1608
1698
|
- *Default:* true
|
|
1609
1699
|
|
|
1610
1700
|
Setup jest unit tests.
|
|
1611
1701
|
|
|
1612
1702
|
---
|
|
1613
1703
|
|
|
1614
|
-
##### `jestOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.jestOptions"
|
|
1704
|
+
##### `jestOptions`<sup>Optional</sup> <a name="jestOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.jestOptions"></a>
|
|
1615
1705
|
|
|
1616
1706
|
```typescript
|
|
1617
1707
|
public readonly jestOptions: JestOptions;
|
|
1618
1708
|
```
|
|
1619
1709
|
|
|
1620
|
-
- *Type:*
|
|
1710
|
+
- *Type:* projen.javascript.JestOptions
|
|
1621
1711
|
- *Default:* default options
|
|
1622
1712
|
|
|
1623
1713
|
Jest options.
|
|
1624
1714
|
|
|
1625
1715
|
---
|
|
1626
1716
|
|
|
1627
|
-
##### `mutableBuild`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.mutableBuild"
|
|
1717
|
+
##### `mutableBuild`<sup>Optional</sup> <a name="mutableBuild" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.mutableBuild"></a>
|
|
1628
1718
|
|
|
1629
1719
|
```typescript
|
|
1630
1720
|
public readonly mutableBuild: boolean;
|
|
1631
1721
|
```
|
|
1632
1722
|
|
|
1633
|
-
- *Type:*
|
|
1723
|
+
- *Type:* boolean
|
|
1634
1724
|
- *Default:* true
|
|
1635
1725
|
|
|
1636
1726
|
Automatically update files modified during builds to pull-request branches.
|
|
1637
1727
|
|
|
1638
|
-
This means
|
|
1728
|
+
This means
|
|
1729
|
+
that any files synthesized by projen or e.g. test snapshots will always be up-to-date
|
|
1730
|
+
before a PR is merged.
|
|
1731
|
+
|
|
1732
|
+
Implies that PR builds do not have anti-tamper checks.
|
|
1639
1733
|
|
|
1640
1734
|
---
|
|
1641
1735
|
|
|
1642
|
-
##### ~~`npmignore`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmignore"
|
|
1736
|
+
##### ~~`npmignore`~~<sup>Optional</sup> <a name="npmignore" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmignore"></a>
|
|
1643
1737
|
|
|
1644
1738
|
- *Deprecated:* - use `project.addPackageIgnore`
|
|
1645
1739
|
|
|
@@ -1647,169 +1741,169 @@ This means that any files synthesized by projen or e.g. test snapshots will alwa
|
|
|
1647
1741
|
public readonly npmignore: string[];
|
|
1648
1742
|
```
|
|
1649
1743
|
|
|
1650
|
-
- *Type:*
|
|
1744
|
+
- *Type:* string[]
|
|
1651
1745
|
|
|
1652
1746
|
Additional entries to .npmignore.
|
|
1653
1747
|
|
|
1654
1748
|
---
|
|
1655
1749
|
|
|
1656
|
-
##### `npmignoreEnabled`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmignoreEnabled"
|
|
1750
|
+
##### `npmignoreEnabled`<sup>Optional</sup> <a name="npmignoreEnabled" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.npmignoreEnabled"></a>
|
|
1657
1751
|
|
|
1658
1752
|
```typescript
|
|
1659
1753
|
public readonly npmignoreEnabled: boolean;
|
|
1660
1754
|
```
|
|
1661
1755
|
|
|
1662
|
-
- *Type:*
|
|
1756
|
+
- *Type:* boolean
|
|
1663
1757
|
- *Default:* true
|
|
1664
1758
|
|
|
1665
1759
|
Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
|
|
1666
1760
|
|
|
1667
1761
|
---
|
|
1668
1762
|
|
|
1669
|
-
##### `package`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.package"
|
|
1763
|
+
##### `package`<sup>Optional</sup> <a name="package" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.package"></a>
|
|
1670
1764
|
|
|
1671
1765
|
```typescript
|
|
1672
1766
|
public readonly package: boolean;
|
|
1673
1767
|
```
|
|
1674
1768
|
|
|
1675
|
-
- *Type:*
|
|
1769
|
+
- *Type:* boolean
|
|
1676
1770
|
- *Default:* true
|
|
1677
1771
|
|
|
1678
1772
|
Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
|
|
1679
1773
|
|
|
1680
1774
|
---
|
|
1681
1775
|
|
|
1682
|
-
##### `prettier`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.prettier"
|
|
1776
|
+
##### `prettier`<sup>Optional</sup> <a name="prettier" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.prettier"></a>
|
|
1683
1777
|
|
|
1684
1778
|
```typescript
|
|
1685
1779
|
public readonly prettier: boolean;
|
|
1686
1780
|
```
|
|
1687
1781
|
|
|
1688
|
-
- *Type:*
|
|
1782
|
+
- *Type:* boolean
|
|
1689
1783
|
- *Default:* false
|
|
1690
1784
|
|
|
1691
1785
|
Setup prettier.
|
|
1692
1786
|
|
|
1693
1787
|
---
|
|
1694
1788
|
|
|
1695
|
-
##### `prettierOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.prettierOptions"
|
|
1789
|
+
##### `prettierOptions`<sup>Optional</sup> <a name="prettierOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.prettierOptions"></a>
|
|
1696
1790
|
|
|
1697
1791
|
```typescript
|
|
1698
1792
|
public readonly prettierOptions: PrettierOptions;
|
|
1699
1793
|
```
|
|
1700
1794
|
|
|
1701
|
-
- *Type:*
|
|
1795
|
+
- *Type:* projen.javascript.PrettierOptions
|
|
1702
1796
|
- *Default:* default options
|
|
1703
1797
|
|
|
1704
1798
|
Prettier options.
|
|
1705
1799
|
|
|
1706
1800
|
---
|
|
1707
1801
|
|
|
1708
|
-
##### `projenDevDependency`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenDevDependency"
|
|
1802
|
+
##### `projenDevDependency`<sup>Optional</sup> <a name="projenDevDependency" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenDevDependency"></a>
|
|
1709
1803
|
|
|
1710
1804
|
```typescript
|
|
1711
1805
|
public readonly projenDevDependency: boolean;
|
|
1712
1806
|
```
|
|
1713
1807
|
|
|
1714
|
-
- *Type:*
|
|
1808
|
+
- *Type:* boolean
|
|
1715
1809
|
- *Default:* true
|
|
1716
1810
|
|
|
1717
1811
|
Indicates of "projen" should be installed as a devDependency.
|
|
1718
1812
|
|
|
1719
1813
|
---
|
|
1720
1814
|
|
|
1721
|
-
##### `projenrcJs`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcJs"
|
|
1815
|
+
##### `projenrcJs`<sup>Optional</sup> <a name="projenrcJs" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcJs"></a>
|
|
1722
1816
|
|
|
1723
1817
|
```typescript
|
|
1724
1818
|
public readonly projenrcJs: boolean;
|
|
1725
1819
|
```
|
|
1726
1820
|
|
|
1727
|
-
- *Type:*
|
|
1821
|
+
- *Type:* boolean
|
|
1728
1822
|
- *Default:* true if projenrcJson is false
|
|
1729
1823
|
|
|
1730
1824
|
Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
|
|
1731
1825
|
|
|
1732
1826
|
---
|
|
1733
1827
|
|
|
1734
|
-
##### `projenrcJsOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcJsOptions"
|
|
1828
|
+
##### `projenrcJsOptions`<sup>Optional</sup> <a name="projenrcJsOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcJsOptions"></a>
|
|
1735
1829
|
|
|
1736
1830
|
```typescript
|
|
1737
1831
|
public readonly projenrcJsOptions: ProjenrcOptions;
|
|
1738
1832
|
```
|
|
1739
1833
|
|
|
1740
|
-
- *Type:*
|
|
1834
|
+
- *Type:* projen.javascript.ProjenrcOptions
|
|
1741
1835
|
- *Default:* default options
|
|
1742
1836
|
|
|
1743
1837
|
Options for .projenrc.js.
|
|
1744
1838
|
|
|
1745
1839
|
---
|
|
1746
1840
|
|
|
1747
|
-
##### `projenVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenVersion"
|
|
1841
|
+
##### `projenVersion`<sup>Optional</sup> <a name="projenVersion" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenVersion"></a>
|
|
1748
1842
|
|
|
1749
1843
|
```typescript
|
|
1750
1844
|
public readonly projenVersion: string;
|
|
1751
1845
|
```
|
|
1752
1846
|
|
|
1753
|
-
- *Type:*
|
|
1847
|
+
- *Type:* string
|
|
1754
1848
|
- *Default:* Defaults to the latest version.
|
|
1755
1849
|
|
|
1756
1850
|
Version of projen to install.
|
|
1757
1851
|
|
|
1758
1852
|
---
|
|
1759
1853
|
|
|
1760
|
-
##### `pullRequestTemplate`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.pullRequestTemplate"
|
|
1854
|
+
##### `pullRequestTemplate`<sup>Optional</sup> <a name="pullRequestTemplate" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.pullRequestTemplate"></a>
|
|
1761
1855
|
|
|
1762
1856
|
```typescript
|
|
1763
1857
|
public readonly pullRequestTemplate: boolean;
|
|
1764
1858
|
```
|
|
1765
1859
|
|
|
1766
|
-
- *Type:*
|
|
1860
|
+
- *Type:* boolean
|
|
1767
1861
|
- *Default:* true
|
|
1768
1862
|
|
|
1769
1863
|
Include a GitHub pull request template.
|
|
1770
1864
|
|
|
1771
1865
|
---
|
|
1772
1866
|
|
|
1773
|
-
##### `pullRequestTemplateContents`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.pullRequestTemplateContents"
|
|
1867
|
+
##### `pullRequestTemplateContents`<sup>Optional</sup> <a name="pullRequestTemplateContents" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.pullRequestTemplateContents"></a>
|
|
1774
1868
|
|
|
1775
1869
|
```typescript
|
|
1776
1870
|
public readonly pullRequestTemplateContents: string[];
|
|
1777
1871
|
```
|
|
1778
1872
|
|
|
1779
|
-
- *Type:*
|
|
1873
|
+
- *Type:* string[]
|
|
1780
1874
|
- *Default:* default content
|
|
1781
1875
|
|
|
1782
1876
|
The contents of the pull request template.
|
|
1783
1877
|
|
|
1784
1878
|
---
|
|
1785
1879
|
|
|
1786
|
-
##### `release`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.release"
|
|
1880
|
+
##### `release`<sup>Optional</sup> <a name="release" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.release"></a>
|
|
1787
1881
|
|
|
1788
1882
|
```typescript
|
|
1789
1883
|
public readonly release: boolean;
|
|
1790
1884
|
```
|
|
1791
1885
|
|
|
1792
|
-
- *Type:*
|
|
1886
|
+
- *Type:* boolean
|
|
1793
1887
|
- *Default:* true (false for subprojects)
|
|
1794
1888
|
|
|
1795
1889
|
Add release management to this project.
|
|
1796
1890
|
|
|
1797
1891
|
---
|
|
1798
1892
|
|
|
1799
|
-
##### `releaseToNpm`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseToNpm"
|
|
1893
|
+
##### `releaseToNpm`<sup>Optional</sup> <a name="releaseToNpm" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseToNpm"></a>
|
|
1800
1894
|
|
|
1801
1895
|
```typescript
|
|
1802
1896
|
public readonly releaseToNpm: boolean;
|
|
1803
1897
|
```
|
|
1804
1898
|
|
|
1805
|
-
- *Type:*
|
|
1899
|
+
- *Type:* boolean
|
|
1806
1900
|
- *Default:* false
|
|
1807
1901
|
|
|
1808
1902
|
Automatically release to npm when new versions are introduced.
|
|
1809
1903
|
|
|
1810
1904
|
---
|
|
1811
1905
|
|
|
1812
|
-
##### ~~`releaseWorkflow`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseWorkflow"
|
|
1906
|
+
##### ~~`releaseWorkflow`~~<sup>Optional</sup> <a name="releaseWorkflow" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.releaseWorkflow"></a>
|
|
1813
1907
|
|
|
1814
1908
|
- *Deprecated:* see `release`.
|
|
1815
1909
|
|
|
@@ -1817,370 +1911,376 @@ Automatically release to npm when new versions are introduced.
|
|
|
1817
1911
|
public readonly releaseWorkflow: boolean;
|
|
1818
1912
|
```
|
|
1819
1913
|
|
|
1820
|
-
- *Type:*
|
|
1914
|
+
- *Type:* boolean
|
|
1821
1915
|
- *Default:* true if not a subproject
|
|
1822
1916
|
|
|
1823
1917
|
DEPRECATED: renamed to `release`.
|
|
1824
1918
|
|
|
1825
1919
|
---
|
|
1826
1920
|
|
|
1827
|
-
##### `workflowBootstrapSteps`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowBootstrapSteps"
|
|
1921
|
+
##### `workflowBootstrapSteps`<sup>Optional</sup> <a name="workflowBootstrapSteps" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowBootstrapSteps"></a>
|
|
1828
1922
|
|
|
1829
1923
|
```typescript
|
|
1830
1924
|
public readonly workflowBootstrapSteps: JobStep[];
|
|
1831
1925
|
```
|
|
1832
1926
|
|
|
1833
|
-
- *Type:*
|
|
1927
|
+
- *Type:* projen.github.workflows.JobStep[]
|
|
1834
1928
|
- *Default:* "yarn install --frozen-lockfile && yarn projen"
|
|
1835
1929
|
|
|
1836
1930
|
Workflow steps to use in order to bootstrap this repo.
|
|
1837
1931
|
|
|
1838
1932
|
---
|
|
1839
1933
|
|
|
1840
|
-
##### `workflowGitIdentity`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowGitIdentity"
|
|
1934
|
+
##### `workflowGitIdentity`<sup>Optional</sup> <a name="workflowGitIdentity" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowGitIdentity"></a>
|
|
1841
1935
|
|
|
1842
1936
|
```typescript
|
|
1843
1937
|
public readonly workflowGitIdentity: GitIdentity;
|
|
1844
1938
|
```
|
|
1845
1939
|
|
|
1846
|
-
- *Type:*
|
|
1940
|
+
- *Type:* projen.github.GitIdentity
|
|
1847
1941
|
- *Default:* GitHub Actions
|
|
1848
1942
|
|
|
1849
1943
|
The git identity to use in workflows.
|
|
1850
1944
|
|
|
1851
1945
|
---
|
|
1852
1946
|
|
|
1853
|
-
##### `workflowNodeVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowNodeVersion"
|
|
1947
|
+
##### `workflowNodeVersion`<sup>Optional</sup> <a name="workflowNodeVersion" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.workflowNodeVersion"></a>
|
|
1854
1948
|
|
|
1855
1949
|
```typescript
|
|
1856
1950
|
public readonly workflowNodeVersion: string;
|
|
1857
1951
|
```
|
|
1858
1952
|
|
|
1859
|
-
- *Type:*
|
|
1953
|
+
- *Type:* string
|
|
1860
1954
|
- *Default:* same as `minNodeVersion`
|
|
1861
1955
|
|
|
1862
1956
|
The node version to use in GitHub workflows.
|
|
1863
1957
|
|
|
1864
1958
|
---
|
|
1865
1959
|
|
|
1866
|
-
##### `disableTsconfig`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.disableTsconfig"
|
|
1960
|
+
##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.disableTsconfig"></a>
|
|
1867
1961
|
|
|
1868
1962
|
```typescript
|
|
1869
1963
|
public readonly disableTsconfig: boolean;
|
|
1870
1964
|
```
|
|
1871
1965
|
|
|
1872
|
-
- *Type:*
|
|
1966
|
+
- *Type:* boolean
|
|
1873
1967
|
- *Default:* false
|
|
1874
1968
|
|
|
1875
1969
|
Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
|
|
1876
1970
|
|
|
1877
1971
|
---
|
|
1878
1972
|
|
|
1879
|
-
##### `docgen`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.docgen"
|
|
1973
|
+
##### `docgen`<sup>Optional</sup> <a name="docgen" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.docgen"></a>
|
|
1880
1974
|
|
|
1881
1975
|
```typescript
|
|
1882
1976
|
public readonly docgen: boolean;
|
|
1883
1977
|
```
|
|
1884
1978
|
|
|
1885
|
-
- *Type:*
|
|
1979
|
+
- *Type:* boolean
|
|
1886
1980
|
- *Default:* false
|
|
1887
1981
|
|
|
1888
1982
|
Docgen by Typedoc.
|
|
1889
1983
|
|
|
1890
1984
|
---
|
|
1891
1985
|
|
|
1892
|
-
##### `docsDirectory`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.docsDirectory"
|
|
1986
|
+
##### `docsDirectory`<sup>Optional</sup> <a name="docsDirectory" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.docsDirectory"></a>
|
|
1893
1987
|
|
|
1894
1988
|
```typescript
|
|
1895
1989
|
public readonly docsDirectory: string;
|
|
1896
1990
|
```
|
|
1897
1991
|
|
|
1898
|
-
- *Type:*
|
|
1992
|
+
- *Type:* string
|
|
1899
1993
|
- *Default:* "docs"
|
|
1900
1994
|
|
|
1901
1995
|
Docs directory.
|
|
1902
1996
|
|
|
1903
1997
|
---
|
|
1904
1998
|
|
|
1905
|
-
##### `entrypointTypes`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.entrypointTypes"
|
|
1999
|
+
##### `entrypointTypes`<sup>Optional</sup> <a name="entrypointTypes" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.entrypointTypes"></a>
|
|
1906
2000
|
|
|
1907
2001
|
```typescript
|
|
1908
2002
|
public readonly entrypointTypes: string;
|
|
1909
2003
|
```
|
|
1910
2004
|
|
|
1911
|
-
- *Type:*
|
|
2005
|
+
- *Type:* string
|
|
1912
2006
|
- *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
|
|
1913
2007
|
|
|
1914
2008
|
The .d.ts file that includes the type declarations for this module.
|
|
1915
2009
|
|
|
1916
2010
|
---
|
|
1917
2011
|
|
|
1918
|
-
##### `eslint`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.eslint"
|
|
2012
|
+
##### `eslint`<sup>Optional</sup> <a name="eslint" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.eslint"></a>
|
|
1919
2013
|
|
|
1920
2014
|
```typescript
|
|
1921
2015
|
public readonly eslint: boolean;
|
|
1922
2016
|
```
|
|
1923
2017
|
|
|
1924
|
-
- *Type:*
|
|
2018
|
+
- *Type:* boolean
|
|
1925
2019
|
- *Default:* true
|
|
1926
2020
|
|
|
1927
2021
|
Setup eslint.
|
|
1928
2022
|
|
|
1929
2023
|
---
|
|
1930
2024
|
|
|
1931
|
-
##### `eslintOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.eslintOptions"
|
|
2025
|
+
##### `eslintOptions`<sup>Optional</sup> <a name="eslintOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.eslintOptions"></a>
|
|
1932
2026
|
|
|
1933
2027
|
```typescript
|
|
1934
2028
|
public readonly eslintOptions: EslintOptions;
|
|
1935
2029
|
```
|
|
1936
2030
|
|
|
1937
|
-
- *Type:*
|
|
2031
|
+
- *Type:* projen.javascript.EslintOptions
|
|
1938
2032
|
- *Default:* opinionated default options
|
|
1939
2033
|
|
|
1940
2034
|
Eslint options.
|
|
1941
2035
|
|
|
1942
2036
|
---
|
|
1943
2037
|
|
|
1944
|
-
##### `libdir`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.libdir"
|
|
2038
|
+
##### `libdir`<sup>Optional</sup> <a name="libdir" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.libdir"></a>
|
|
1945
2039
|
|
|
1946
2040
|
```typescript
|
|
1947
2041
|
public readonly libdir: string;
|
|
1948
2042
|
```
|
|
1949
2043
|
|
|
1950
|
-
- *Type:*
|
|
2044
|
+
- *Type:* string
|
|
1951
2045
|
- *Default:* "lib"
|
|
1952
2046
|
|
|
1953
2047
|
Typescript artifacts output directory.
|
|
1954
2048
|
|
|
1955
2049
|
---
|
|
1956
2050
|
|
|
1957
|
-
##### `projenrcTs`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcTs"
|
|
2051
|
+
##### `projenrcTs`<sup>Optional</sup> <a name="projenrcTs" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcTs"></a>
|
|
1958
2052
|
|
|
1959
2053
|
```typescript
|
|
1960
2054
|
public readonly projenrcTs: boolean;
|
|
1961
2055
|
```
|
|
1962
2056
|
|
|
1963
|
-
- *Type:*
|
|
2057
|
+
- *Type:* boolean
|
|
1964
2058
|
- *Default:* false
|
|
1965
2059
|
|
|
1966
2060
|
Use TypeScript for your projenrc file (`.projenrc.ts`).
|
|
1967
2061
|
|
|
1968
2062
|
---
|
|
1969
2063
|
|
|
1970
|
-
##### `projenrcTsOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcTsOptions"
|
|
2064
|
+
##### `projenrcTsOptions`<sup>Optional</sup> <a name="projenrcTsOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.projenrcTsOptions"></a>
|
|
1971
2065
|
|
|
1972
2066
|
```typescript
|
|
1973
2067
|
public readonly projenrcTsOptions: ProjenrcOptions;
|
|
1974
2068
|
```
|
|
1975
2069
|
|
|
1976
|
-
- *Type:*
|
|
2070
|
+
- *Type:* projen.typescript.ProjenrcOptions
|
|
1977
2071
|
|
|
1978
2072
|
Options for .projenrc.ts.
|
|
1979
2073
|
|
|
1980
2074
|
---
|
|
1981
2075
|
|
|
1982
|
-
##### `sampleCode`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.sampleCode"
|
|
2076
|
+
##### `sampleCode`<sup>Optional</sup> <a name="sampleCode" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.sampleCode"></a>
|
|
1983
2077
|
|
|
1984
2078
|
```typescript
|
|
1985
2079
|
public readonly sampleCode: boolean;
|
|
1986
2080
|
```
|
|
1987
2081
|
|
|
1988
|
-
- *Type:*
|
|
2082
|
+
- *Type:* boolean
|
|
1989
2083
|
- *Default:* true
|
|
1990
2084
|
|
|
1991
2085
|
Generate one-time sample in `src/` and `test/` if there are no files there.
|
|
1992
2086
|
|
|
1993
2087
|
---
|
|
1994
2088
|
|
|
1995
|
-
##### `srcdir`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.srcdir"
|
|
2089
|
+
##### `srcdir`<sup>Optional</sup> <a name="srcdir" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.srcdir"></a>
|
|
1996
2090
|
|
|
1997
2091
|
```typescript
|
|
1998
2092
|
public readonly srcdir: string;
|
|
1999
2093
|
```
|
|
2000
2094
|
|
|
2001
|
-
- *Type:*
|
|
2095
|
+
- *Type:* string
|
|
2002
2096
|
- *Default:* "src"
|
|
2003
2097
|
|
|
2004
2098
|
Typescript sources directory.
|
|
2005
2099
|
|
|
2006
2100
|
---
|
|
2007
2101
|
|
|
2008
|
-
##### `testdir`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.testdir"
|
|
2102
|
+
##### `testdir`<sup>Optional</sup> <a name="testdir" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.testdir"></a>
|
|
2009
2103
|
|
|
2010
2104
|
```typescript
|
|
2011
2105
|
public readonly testdir: string;
|
|
2012
2106
|
```
|
|
2013
2107
|
|
|
2014
|
-
- *Type:*
|
|
2108
|
+
- *Type:* string
|
|
2015
2109
|
- *Default:* "test"
|
|
2016
2110
|
|
|
2017
2111
|
Jest tests directory. Tests files should be named `xxx.test.ts`.
|
|
2018
2112
|
|
|
2019
|
-
If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`),
|
|
2113
|
+
If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`),
|
|
2114
|
+
then tests are going to be compiled into `lib/` and executed as javascript.
|
|
2115
|
+
If the test directory is outside of `src`, then we configure jest to
|
|
2116
|
+
compile the code in-memory.
|
|
2020
2117
|
|
|
2021
2118
|
---
|
|
2022
2119
|
|
|
2023
|
-
##### `tsconfig`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.tsconfig"
|
|
2120
|
+
##### `tsconfig`<sup>Optional</sup> <a name="tsconfig" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.tsconfig"></a>
|
|
2024
2121
|
|
|
2025
2122
|
```typescript
|
|
2026
2123
|
public readonly tsconfig: TypescriptConfigOptions;
|
|
2027
2124
|
```
|
|
2028
2125
|
|
|
2029
|
-
- *Type:*
|
|
2126
|
+
- *Type:* projen.javascript.TypescriptConfigOptions
|
|
2030
2127
|
- *Default:* default options
|
|
2031
2128
|
|
|
2032
2129
|
Custom TSConfig.
|
|
2033
2130
|
|
|
2034
2131
|
---
|
|
2035
2132
|
|
|
2036
|
-
##### `tsconfigDev`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.tsconfigDev"
|
|
2133
|
+
##### `tsconfigDev`<sup>Optional</sup> <a name="tsconfigDev" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.tsconfigDev"></a>
|
|
2037
2134
|
|
|
2038
2135
|
```typescript
|
|
2039
2136
|
public readonly tsconfigDev: TypescriptConfigOptions;
|
|
2040
2137
|
```
|
|
2041
2138
|
|
|
2042
|
-
- *Type:*
|
|
2139
|
+
- *Type:* projen.javascript.TypescriptConfigOptions
|
|
2043
2140
|
- *Default:* use the production tsconfig options
|
|
2044
2141
|
|
|
2045
2142
|
Custom tsconfig options for the development tsconfig.json file (used for testing).
|
|
2046
2143
|
|
|
2047
2144
|
---
|
|
2048
2145
|
|
|
2049
|
-
##### `tsconfigDevFile`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.tsconfigDevFile"
|
|
2146
|
+
##### `tsconfigDevFile`<sup>Optional</sup> <a name="tsconfigDevFile" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.tsconfigDevFile"></a>
|
|
2050
2147
|
|
|
2051
2148
|
```typescript
|
|
2052
2149
|
public readonly tsconfigDevFile: string;
|
|
2053
2150
|
```
|
|
2054
2151
|
|
|
2055
|
-
- *Type:*
|
|
2152
|
+
- *Type:* string
|
|
2056
2153
|
- *Default:* "tsconfig.dev.json"
|
|
2057
2154
|
|
|
2058
2155
|
The name of the development tsconfig.json file.
|
|
2059
2156
|
|
|
2060
2157
|
---
|
|
2061
2158
|
|
|
2062
|
-
##### `typescriptVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.typescriptVersion"
|
|
2159
|
+
##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.typescriptVersion"></a>
|
|
2063
2160
|
|
|
2064
2161
|
```typescript
|
|
2065
2162
|
public readonly typescriptVersion: string;
|
|
2066
2163
|
```
|
|
2067
2164
|
|
|
2068
|
-
- *Type:*
|
|
2165
|
+
- *Type:* string
|
|
2069
2166
|
- *Default:* "latest"
|
|
2070
2167
|
|
|
2071
2168
|
TypeScript version to use.
|
|
2072
2169
|
|
|
2073
|
-
NOTE: Typescript is not semantically versioned and should remain on the
|
|
2170
|
+
NOTE: Typescript is not semantically versioned and should remain on the
|
|
2171
|
+
same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).
|
|
2074
2172
|
|
|
2075
2173
|
---
|
|
2076
2174
|
|
|
2077
|
-
##### `buildCommand`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.buildCommand"
|
|
2175
|
+
##### `buildCommand`<sup>Optional</sup> <a name="buildCommand" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.buildCommand"></a>
|
|
2078
2176
|
|
|
2079
2177
|
```typescript
|
|
2080
2178
|
public readonly buildCommand: string;
|
|
2081
2179
|
```
|
|
2082
2180
|
|
|
2083
|
-
- *Type:*
|
|
2181
|
+
- *Type:* string
|
|
2084
2182
|
- *Default:* no build command
|
|
2085
2183
|
|
|
2086
2184
|
A command to execute before synthesis.
|
|
2087
2185
|
|
|
2088
|
-
This command will be called when
|
|
2186
|
+
This command will be called when
|
|
2187
|
+
running `cdk synth` or when `cdk watch` identifies a change in your source
|
|
2188
|
+
code before redeployment.
|
|
2089
2189
|
|
|
2090
2190
|
---
|
|
2091
2191
|
|
|
2092
|
-
##### `cdkout`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkout"
|
|
2192
|
+
##### `cdkout`<sup>Optional</sup> <a name="cdkout" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkout"></a>
|
|
2093
2193
|
|
|
2094
2194
|
```typescript
|
|
2095
2195
|
public readonly cdkout: string;
|
|
2096
2196
|
```
|
|
2097
2197
|
|
|
2098
|
-
- *Type:*
|
|
2198
|
+
- *Type:* string
|
|
2099
2199
|
- *Default:* "cdk.out"
|
|
2100
2200
|
|
|
2101
2201
|
cdk.out directory.
|
|
2102
2202
|
|
|
2103
2203
|
---
|
|
2104
2204
|
|
|
2105
|
-
##### `context`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.context"
|
|
2205
|
+
##### `context`<sup>Optional</sup> <a name="context" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.context"></a>
|
|
2106
2206
|
|
|
2107
2207
|
```typescript
|
|
2108
2208
|
public readonly context: {[ key: string ]: any};
|
|
2109
2209
|
```
|
|
2110
2210
|
|
|
2111
|
-
- *Type:* {[ key: string ]:
|
|
2211
|
+
- *Type:* {[ key: string ]: any}
|
|
2112
2212
|
- *Default:* no additional context
|
|
2113
2213
|
|
|
2114
2214
|
Additional context to include in `cdk.json`.
|
|
2115
2215
|
|
|
2116
2216
|
---
|
|
2117
2217
|
|
|
2118
|
-
##### `featureFlags`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.featureFlags"
|
|
2218
|
+
##### `featureFlags`<sup>Optional</sup> <a name="featureFlags" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.featureFlags"></a>
|
|
2119
2219
|
|
|
2120
2220
|
```typescript
|
|
2121
2221
|
public readonly featureFlags: boolean;
|
|
2122
2222
|
```
|
|
2123
2223
|
|
|
2124
|
-
- *Type:*
|
|
2224
|
+
- *Type:* boolean
|
|
2125
2225
|
- *Default:* true
|
|
2126
2226
|
|
|
2127
2227
|
Include all feature flags in cdk.json.
|
|
2128
2228
|
|
|
2129
2229
|
---
|
|
2130
2230
|
|
|
2131
|
-
##### `requireApproval`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.requireApproval"
|
|
2231
|
+
##### `requireApproval`<sup>Optional</sup> <a name="requireApproval" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.requireApproval"></a>
|
|
2132
2232
|
|
|
2133
2233
|
```typescript
|
|
2134
2234
|
public readonly requireApproval: ApprovalLevel;
|
|
2135
2235
|
```
|
|
2136
2236
|
|
|
2137
|
-
- *Type:*
|
|
2237
|
+
- *Type:* projen.awscdk.ApprovalLevel
|
|
2138
2238
|
- *Default:* ApprovalLevel.BROADENING
|
|
2139
2239
|
|
|
2140
2240
|
To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.
|
|
2141
2241
|
|
|
2142
2242
|
---
|
|
2143
2243
|
|
|
2144
|
-
##### `watchExcludes`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.watchExcludes"
|
|
2244
|
+
##### `watchExcludes`<sup>Optional</sup> <a name="watchExcludes" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.watchExcludes"></a>
|
|
2145
2245
|
|
|
2146
2246
|
```typescript
|
|
2147
2247
|
public readonly watchExcludes: string[];
|
|
2148
2248
|
```
|
|
2149
2249
|
|
|
2150
|
-
- *Type:*
|
|
2250
|
+
- *Type:* string[]
|
|
2151
2251
|
- *Default:* []
|
|
2152
2252
|
|
|
2153
2253
|
Glob patterns to exclude from `cdk watch`.
|
|
2154
2254
|
|
|
2155
2255
|
---
|
|
2156
2256
|
|
|
2157
|
-
##### `watchIncludes`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.watchIncludes"
|
|
2257
|
+
##### `watchIncludes`<sup>Optional</sup> <a name="watchIncludes" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.watchIncludes"></a>
|
|
2158
2258
|
|
|
2159
2259
|
```typescript
|
|
2160
2260
|
public readonly watchIncludes: string[];
|
|
2161
2261
|
```
|
|
2162
2262
|
|
|
2163
|
-
- *Type:*
|
|
2263
|
+
- *Type:* string[]
|
|
2164
2264
|
- *Default:* []
|
|
2165
2265
|
|
|
2166
2266
|
Glob patterns to include in `cdk watch`.
|
|
2167
2267
|
|
|
2168
2268
|
---
|
|
2169
2269
|
|
|
2170
|
-
##### `cdkVersion`<sup>Required</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkVersion"
|
|
2270
|
+
##### `cdkVersion`<sup>Required</sup> <a name="cdkVersion" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkVersion"></a>
|
|
2171
2271
|
|
|
2172
2272
|
```typescript
|
|
2173
2273
|
public readonly cdkVersion: string;
|
|
2174
2274
|
```
|
|
2175
2275
|
|
|
2176
|
-
- *Type:*
|
|
2276
|
+
- *Type:* string
|
|
2177
2277
|
- *Default:* "2.1.0"
|
|
2178
2278
|
|
|
2179
2279
|
Minimum version of the AWS CDK to depend on.
|
|
2180
2280
|
|
|
2181
2281
|
---
|
|
2182
2282
|
|
|
2183
|
-
##### ~~`cdkAssert`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkAssert"
|
|
2283
|
+
##### ~~`cdkAssert`~~<sup>Optional</sup> <a name="cdkAssert" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkAssert"></a>
|
|
2184
2284
|
|
|
2185
2285
|
- *Deprecated:* The
|
|
2186
2286
|
|
|
@@ -2188,7 +2288,7 @@ Minimum version of the AWS CDK to depend on.
|
|
|
2188
2288
|
public readonly cdkAssert: boolean;
|
|
2189
2289
|
```
|
|
2190
2290
|
|
|
2191
|
-
- *Type:*
|
|
2291
|
+
- *Type:* boolean
|
|
2192
2292
|
- *Default:* will be included by default for AWS CDK >= 1.0.0 < 2.0.0
|
|
2193
2293
|
|
|
2194
2294
|
Warning: NodeJS only.
|
|
@@ -2197,22 +2297,23 @@ Install the @aws-cdk/assert library?
|
|
|
2197
2297
|
|
|
2198
2298
|
---
|
|
2199
2299
|
|
|
2200
|
-
##### `cdkAssertions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkAssertions"
|
|
2300
|
+
##### `cdkAssertions`<sup>Optional</sup> <a name="cdkAssertions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkAssertions"></a>
|
|
2201
2301
|
|
|
2202
2302
|
```typescript
|
|
2203
2303
|
public readonly cdkAssertions: boolean;
|
|
2204
2304
|
```
|
|
2205
2305
|
|
|
2206
|
-
- *Type:*
|
|
2306
|
+
- *Type:* boolean
|
|
2207
2307
|
- *Default:* will be included by default for AWS CDK >= 1.111.0 < 2.0.0
|
|
2208
2308
|
|
|
2209
2309
|
Install the assertions library?
|
|
2210
2310
|
|
|
2211
|
-
Only needed for CDK 1.x. If using CDK 2.x then
|
|
2311
|
+
Only needed for CDK 1.x. If using CDK 2.x then
|
|
2312
|
+
assertions is already included in 'aws-cdk-lib'
|
|
2212
2313
|
|
|
2213
2314
|
---
|
|
2214
2315
|
|
|
2215
|
-
##### ~~`cdkDependencies`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkDependencies"
|
|
2316
|
+
##### ~~`cdkDependencies`~~<sup>Optional</sup> <a name="cdkDependencies" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkDependencies"></a>
|
|
2216
2317
|
|
|
2217
2318
|
- *Deprecated:* For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library)
|
|
2218
2319
|
|
|
@@ -2220,13 +2321,13 @@ Only needed for CDK 1.x. If using CDK 2.x then assertions is already included in
|
|
|
2220
2321
|
public readonly cdkDependencies: string[];
|
|
2221
2322
|
```
|
|
2222
2323
|
|
|
2223
|
-
- *Type:*
|
|
2324
|
+
- *Type:* string[]
|
|
2224
2325
|
|
|
2225
2326
|
Which AWS CDKv1 modules this project requires.
|
|
2226
2327
|
|
|
2227
2328
|
---
|
|
2228
2329
|
|
|
2229
|
-
##### ~~`cdkDependenciesAsDeps`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkDependenciesAsDeps"
|
|
2330
|
+
##### ~~`cdkDependenciesAsDeps`~~<sup>Optional</sup> <a name="cdkDependenciesAsDeps" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkDependenciesAsDeps"></a>
|
|
2230
2331
|
|
|
2231
2332
|
- *Deprecated:* Not supported in CDK v2.
|
|
2232
2333
|
|
|
@@ -2234,16 +2335,21 @@ Which AWS CDKv1 modules this project requires.
|
|
|
2234
2335
|
public readonly cdkDependenciesAsDeps: boolean;
|
|
2235
2336
|
```
|
|
2236
2337
|
|
|
2237
|
-
- *Type:*
|
|
2338
|
+
- *Type:* boolean
|
|
2238
2339
|
- *Default:* true
|
|
2239
2340
|
|
|
2240
2341
|
If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`).
|
|
2241
2342
|
|
|
2242
|
-
This is to ensure that downstream consumers actually have your CDK dependencies installed
|
|
2343
|
+
This is to ensure that downstream consumers actually have your CDK dependencies installed
|
|
2344
|
+
when using npm < 7 or yarn, where peer dependencies are not automatically installed.
|
|
2345
|
+
If this is disabled, `cdkDependencies` will be added to `devDependencies` to ensure
|
|
2346
|
+
they are present during development.
|
|
2347
|
+
|
|
2348
|
+
Note: this setting only applies to construct library projects
|
|
2243
2349
|
|
|
2244
2350
|
---
|
|
2245
2351
|
|
|
2246
|
-
##### ~~`cdkTestDependencies`~~<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkTestDependencies"
|
|
2352
|
+
##### ~~`cdkTestDependencies`~~<sup>Optional</sup> <a name="cdkTestDependencies" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkTestDependencies"></a>
|
|
2247
2353
|
|
|
2248
2354
|
- *Deprecated:* For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead
|
|
2249
2355
|
|
|
@@ -2251,159 +2357,160 @@ This is to ensure that downstream consumers actually have your CDK dependencies
|
|
|
2251
2357
|
public readonly cdkTestDependencies: string[];
|
|
2252
2358
|
```
|
|
2253
2359
|
|
|
2254
|
-
- *Type:*
|
|
2360
|
+
- *Type:* string[]
|
|
2255
2361
|
|
|
2256
2362
|
AWS CDK modules required for testing.
|
|
2257
2363
|
|
|
2258
2364
|
---
|
|
2259
2365
|
|
|
2260
|
-
##### `cdkVersionPinning`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkVersionPinning"
|
|
2366
|
+
##### `cdkVersionPinning`<sup>Optional</sup> <a name="cdkVersionPinning" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.cdkVersionPinning"></a>
|
|
2261
2367
|
|
|
2262
2368
|
```typescript
|
|
2263
2369
|
public readonly cdkVersionPinning: boolean;
|
|
2264
2370
|
```
|
|
2265
2371
|
|
|
2266
|
-
- *Type:*
|
|
2372
|
+
- *Type:* boolean
|
|
2267
2373
|
|
|
2268
2374
|
Use pinned version instead of caret version for CDK.
|
|
2269
2375
|
|
|
2270
|
-
You can use this to prevent mixed versions for your CDK dependencies and to prevent auto-updates.
|
|
2376
|
+
You can use this to prevent mixed versions for your CDK dependencies and to prevent auto-updates.
|
|
2377
|
+
If you use experimental features this will let you define the moment you include breaking changes.
|
|
2271
2378
|
|
|
2272
2379
|
---
|
|
2273
2380
|
|
|
2274
|
-
##### `constructsVersion`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.constructsVersion"
|
|
2381
|
+
##### `constructsVersion`<sup>Optional</sup> <a name="constructsVersion" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.constructsVersion"></a>
|
|
2275
2382
|
|
|
2276
2383
|
```typescript
|
|
2277
2384
|
public readonly constructsVersion: string;
|
|
2278
2385
|
```
|
|
2279
2386
|
|
|
2280
|
-
- *Type:*
|
|
2387
|
+
- *Type:* string
|
|
2281
2388
|
- *Default:* for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
|
|
2282
2389
|
|
|
2283
2390
|
Minimum version of the `constructs` library to depend on.
|
|
2284
2391
|
|
|
2285
2392
|
---
|
|
2286
2393
|
|
|
2287
|
-
##### `appEntrypoint`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.appEntrypoint"
|
|
2394
|
+
##### `appEntrypoint`<sup>Optional</sup> <a name="appEntrypoint" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.appEntrypoint"></a>
|
|
2288
2395
|
|
|
2289
2396
|
```typescript
|
|
2290
2397
|
public readonly appEntrypoint: string;
|
|
2291
2398
|
```
|
|
2292
2399
|
|
|
2293
|
-
- *Type:*
|
|
2400
|
+
- *Type:* string
|
|
2294
2401
|
- *Default:* "main.ts"
|
|
2295
2402
|
|
|
2296
2403
|
The CDK app's entrypoint (relative to the source directory, which is "src" by default).
|
|
2297
2404
|
|
|
2298
2405
|
---
|
|
2299
2406
|
|
|
2300
|
-
##### `edgeLambdaAutoDiscover`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.edgeLambdaAutoDiscover"
|
|
2407
|
+
##### `edgeLambdaAutoDiscover`<sup>Optional</sup> <a name="edgeLambdaAutoDiscover" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.edgeLambdaAutoDiscover"></a>
|
|
2301
2408
|
|
|
2302
2409
|
```typescript
|
|
2303
2410
|
public readonly edgeLambdaAutoDiscover: boolean;
|
|
2304
2411
|
```
|
|
2305
2412
|
|
|
2306
|
-
- *Type:*
|
|
2413
|
+
- *Type:* boolean
|
|
2307
2414
|
- *Default:* true
|
|
2308
2415
|
|
|
2309
2416
|
Automatically adds an `cloudfront.experimental.EdgeFunction` for each `.edge-lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project.
|
|
2310
2417
|
|
|
2311
2418
|
---
|
|
2312
2419
|
|
|
2313
|
-
##### `integrationTestAutoDiscover`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.integrationTestAutoDiscover"
|
|
2420
|
+
##### `integrationTestAutoDiscover`<sup>Optional</sup> <a name="integrationTestAutoDiscover" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.integrationTestAutoDiscover"></a>
|
|
2314
2421
|
|
|
2315
2422
|
```typescript
|
|
2316
2423
|
public readonly integrationTestAutoDiscover: boolean;
|
|
2317
2424
|
```
|
|
2318
2425
|
|
|
2319
|
-
- *Type:*
|
|
2426
|
+
- *Type:* boolean
|
|
2320
2427
|
- *Default:* true
|
|
2321
2428
|
|
|
2322
2429
|
Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory.
|
|
2323
2430
|
|
|
2324
2431
|
---
|
|
2325
2432
|
|
|
2326
|
-
##### `lambdaAutoDiscover`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.lambdaAutoDiscover"
|
|
2433
|
+
##### `lambdaAutoDiscover`<sup>Optional</sup> <a name="lambdaAutoDiscover" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.lambdaAutoDiscover"></a>
|
|
2327
2434
|
|
|
2328
2435
|
```typescript
|
|
2329
2436
|
public readonly lambdaAutoDiscover: boolean;
|
|
2330
2437
|
```
|
|
2331
2438
|
|
|
2332
|
-
- *Type:*
|
|
2439
|
+
- *Type:* boolean
|
|
2333
2440
|
- *Default:* true
|
|
2334
2441
|
|
|
2335
2442
|
Automatically adds an `awscdk.LambdaFunction` for each `.lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project.
|
|
2336
2443
|
|
|
2337
2444
|
---
|
|
2338
2445
|
|
|
2339
|
-
##### `lambdaExtensionAutoDiscover`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.lambdaExtensionAutoDiscover"
|
|
2446
|
+
##### `lambdaExtensionAutoDiscover`<sup>Optional</sup> <a name="lambdaExtensionAutoDiscover" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.lambdaExtensionAutoDiscover"></a>
|
|
2340
2447
|
|
|
2341
2448
|
```typescript
|
|
2342
2449
|
public readonly lambdaExtensionAutoDiscover: boolean;
|
|
2343
2450
|
```
|
|
2344
2451
|
|
|
2345
|
-
- *Type:*
|
|
2452
|
+
- *Type:* boolean
|
|
2346
2453
|
- *Default:* true
|
|
2347
2454
|
|
|
2348
2455
|
Automatically adds an `awscdk.LambdaExtension` for each `.lambda-extension.ts` entrypoint in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project.
|
|
2349
2456
|
|
|
2350
2457
|
---
|
|
2351
2458
|
|
|
2352
|
-
##### `lambdaOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.lambdaOptions"
|
|
2459
|
+
##### `lambdaOptions`<sup>Optional</sup> <a name="lambdaOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.lambdaOptions"></a>
|
|
2353
2460
|
|
|
2354
2461
|
```typescript
|
|
2355
2462
|
public readonly lambdaOptions: LambdaFunctionCommonOptions;
|
|
2356
2463
|
```
|
|
2357
2464
|
|
|
2358
|
-
- *Type:*
|
|
2465
|
+
- *Type:* projen.awscdk.LambdaFunctionCommonOptions
|
|
2359
2466
|
- *Default:* default options
|
|
2360
2467
|
|
|
2361
2468
|
Common options for all AWS Lambda functions.
|
|
2362
2469
|
|
|
2363
2470
|
---
|
|
2364
2471
|
|
|
2365
|
-
##### `checkActiveDeployment`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.checkActiveDeployment"
|
|
2472
|
+
##### `checkActiveDeployment`<sup>Optional</sup> <a name="checkActiveDeployment" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.checkActiveDeployment"></a>
|
|
2366
2473
|
|
|
2367
2474
|
```typescript
|
|
2368
2475
|
public readonly checkActiveDeployment: boolean;
|
|
2369
2476
|
```
|
|
2370
2477
|
|
|
2371
|
-
- *Type:*
|
|
2478
|
+
- *Type:* boolean
|
|
2372
2479
|
- *Default:* false
|
|
2373
2480
|
|
|
2374
2481
|
Whether to check and skip the deployment for environments that have active deployment of the same commit.
|
|
2375
2482
|
|
|
2376
2483
|
---
|
|
2377
2484
|
|
|
2378
|
-
##### `deployOptions`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.deployOptions"
|
|
2485
|
+
##### `deployOptions`<sup>Optional</sup> <a name="deployOptions" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.deployOptions"></a>
|
|
2379
2486
|
|
|
2380
2487
|
```typescript
|
|
2381
2488
|
public readonly deployOptions: DeployOptions;
|
|
2382
2489
|
```
|
|
2383
2490
|
|
|
2384
|
-
- *Type:*
|
|
2491
|
+
- *Type:* <a href="#deployable-awscdk-app-ts.DeployOptions">DeployOptions</a>
|
|
2385
2492
|
- *Default:* "config with empty list of environments"
|
|
2386
2493
|
|
|
2387
2494
|
Deployment options.
|
|
2388
2495
|
|
|
2389
2496
|
---
|
|
2390
2497
|
|
|
2391
|
-
##### `generateNvmrc`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.generateNvmrc"
|
|
2498
|
+
##### `generateNvmrc`<sup>Optional</sup> <a name="generateNvmrc" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions.property.generateNvmrc"></a>
|
|
2392
2499
|
|
|
2393
2500
|
```typescript
|
|
2394
2501
|
public readonly generateNvmrc: boolean;
|
|
2395
2502
|
```
|
|
2396
2503
|
|
|
2397
|
-
- *Type:*
|
|
2504
|
+
- *Type:* boolean
|
|
2398
2505
|
- *Default:* true
|
|
2399
2506
|
|
|
2400
2507
|
Whether to generate nvmrc file for the node version of the project if set to true, and no "workflowNodeVersion" is specified will use version 14.18.1.
|
|
2401
2508
|
|
|
2402
2509
|
---
|
|
2403
2510
|
|
|
2404
|
-
### DeployOptions <a name="deployable-awscdk-app-ts.DeployOptions"
|
|
2511
|
+
### DeployOptions <a name="DeployOptions" id="deployable-awscdk-app-ts.DeployOptions"></a>
|
|
2405
2512
|
|
|
2406
|
-
#### Initializer <a name="
|
|
2513
|
+
#### Initializer <a name="Initializer" id="deployable-awscdk-app-ts.DeployOptions.Initializer"></a>
|
|
2407
2514
|
|
|
2408
2515
|
```typescript
|
|
2409
2516
|
import { DeployOptions } from 'deployable-awscdk-app-ts'
|
|
@@ -2411,36 +2518,36 @@ import { DeployOptions } from 'deployable-awscdk-app-ts'
|
|
|
2411
2518
|
const deployOptions: DeployOptions = { ... }
|
|
2412
2519
|
```
|
|
2413
2520
|
|
|
2414
|
-
#### Properties <a name="Properties" id="
|
|
2521
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
2415
2522
|
|
|
2416
2523
|
| **Name** | **Type** | **Description** |
|
|
2417
2524
|
| --- | --- | --- |
|
|
2418
|
-
|
|
|
2419
|
-
|
|
|
2420
|
-
|
|
|
2421
|
-
|
|
|
2525
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployOptions.property.environments">environments</a></code> | <code><a href="#deployable-awscdk-app-ts.EnvironmentOptions">EnvironmentOptions</a>[]</code> | Environment settings to deploy to. |
|
|
2526
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployOptions.property.npmConfigEnvironment">npmConfigEnvironment</a></code> | <code>string</code> | npm config name to set as the environment name This might be useful in deployment process. |
|
|
2527
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployOptions.property.stackPattern">stackPattern</a></code> | <code>string</code> | Regex for stacks to be deployed. |
|
|
2528
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployOptions.property.taskToRunPreInstall">taskToRunPreInstall</a></code> | <code>string</code> | task name to run prior to installation in deploy job of workflow if not provided will not add to workflow. |
|
|
2422
2529
|
|
|
2423
2530
|
---
|
|
2424
2531
|
|
|
2425
|
-
##### `environments`<sup>Required</sup> <a name="deployable-awscdk-app-ts.DeployOptions.property.environments"
|
|
2532
|
+
##### `environments`<sup>Required</sup> <a name="environments" id="deployable-awscdk-app-ts.DeployOptions.property.environments"></a>
|
|
2426
2533
|
|
|
2427
2534
|
```typescript
|
|
2428
2535
|
public readonly environments: EnvironmentOptions[];
|
|
2429
2536
|
```
|
|
2430
2537
|
|
|
2431
|
-
- *Type:*
|
|
2538
|
+
- *Type:* <a href="#deployable-awscdk-app-ts.EnvironmentOptions">EnvironmentOptions</a>[]
|
|
2432
2539
|
|
|
2433
2540
|
Environment settings to deploy to.
|
|
2434
2541
|
|
|
2435
2542
|
---
|
|
2436
2543
|
|
|
2437
|
-
##### `npmConfigEnvironment`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployOptions.property.npmConfigEnvironment"
|
|
2544
|
+
##### `npmConfigEnvironment`<sup>Optional</sup> <a name="npmConfigEnvironment" id="deployable-awscdk-app-ts.DeployOptions.property.npmConfigEnvironment"></a>
|
|
2438
2545
|
|
|
2439
2546
|
```typescript
|
|
2440
2547
|
public readonly npmConfigEnvironment: string;
|
|
2441
2548
|
```
|
|
2442
2549
|
|
|
2443
|
-
- *Type:*
|
|
2550
|
+
- *Type:* string
|
|
2444
2551
|
- *Default:* undefined
|
|
2445
2552
|
|
|
2446
2553
|
npm config name to set as the environment name This might be useful in deployment process.
|
|
@@ -2449,13 +2556,13 @@ if not provided will not set
|
|
|
2449
2556
|
|
|
2450
2557
|
---
|
|
2451
2558
|
|
|
2452
|
-
##### `stackPattern`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployOptions.property.stackPattern"
|
|
2559
|
+
##### `stackPattern`<sup>Optional</sup> <a name="stackPattern" id="deployable-awscdk-app-ts.DeployOptions.property.stackPattern"></a>
|
|
2453
2560
|
|
|
2454
2561
|
```typescript
|
|
2455
2562
|
public readonly stackPattern: string;
|
|
2456
2563
|
```
|
|
2457
2564
|
|
|
2458
|
-
- *Type:*
|
|
2565
|
+
- *Type:* string
|
|
2459
2566
|
- *Default:* undefined
|
|
2460
2567
|
|
|
2461
2568
|
Regex for stacks to be deployed.
|
|
@@ -2464,22 +2571,22 @@ if not provided matches all of the stacks in the CDK App.
|
|
|
2464
2571
|
|
|
2465
2572
|
---
|
|
2466
2573
|
|
|
2467
|
-
##### `taskToRunPreInstall`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.DeployOptions.property.taskToRunPreInstall"
|
|
2574
|
+
##### `taskToRunPreInstall`<sup>Optional</sup> <a name="taskToRunPreInstall" id="deployable-awscdk-app-ts.DeployOptions.property.taskToRunPreInstall"></a>
|
|
2468
2575
|
|
|
2469
2576
|
```typescript
|
|
2470
2577
|
public readonly taskToRunPreInstall: string;
|
|
2471
2578
|
```
|
|
2472
2579
|
|
|
2473
|
-
- *Type:*
|
|
2580
|
+
- *Type:* string
|
|
2474
2581
|
- *Default:* undefined
|
|
2475
2582
|
|
|
2476
2583
|
task name to run prior to installation in deploy job of workflow if not provided will not add to workflow.
|
|
2477
2584
|
|
|
2478
2585
|
---
|
|
2479
2586
|
|
|
2480
|
-
### EnvironmentOptions <a name="deployable-awscdk-app-ts.EnvironmentOptions"
|
|
2587
|
+
### EnvironmentOptions <a name="EnvironmentOptions" id="deployable-awscdk-app-ts.EnvironmentOptions"></a>
|
|
2481
2588
|
|
|
2482
|
-
#### Initializer <a name="
|
|
2589
|
+
#### Initializer <a name="Initializer" id="deployable-awscdk-app-ts.EnvironmentOptions.Initializer"></a>
|
|
2483
2590
|
|
|
2484
2591
|
```typescript
|
|
2485
2592
|
import { EnvironmentOptions } from 'deployable-awscdk-app-ts'
|
|
@@ -2487,70 +2594,84 @@ import { EnvironmentOptions } from 'deployable-awscdk-app-ts'
|
|
|
2487
2594
|
const environmentOptions: EnvironmentOptions = { ... }
|
|
2488
2595
|
```
|
|
2489
2596
|
|
|
2490
|
-
#### Properties <a name="Properties" id="
|
|
2597
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
2491
2598
|
|
|
2492
2599
|
| **Name** | **Type** | **Description** |
|
|
2493
2600
|
| --- | --- | --- |
|
|
2494
|
-
|
|
|
2495
|
-
|
|
|
2496
|
-
|
|
|
2497
|
-
|
|
|
2601
|
+
| <code><a href="#deployable-awscdk-app-ts.EnvironmentOptions.property.awsCredentials">awsCredentials</a></code> | <code><a href="#deployable-awscdk-app-ts.AWSCredentials">AWSCredentials</a></code> | AWS credential details for deployment. |
|
|
2602
|
+
| <code><a href="#deployable-awscdk-app-ts.EnvironmentOptions.property.name">name</a></code> | <code>string</code> | Environment name to deploy to. |
|
|
2603
|
+
| <code><a href="#deployable-awscdk-app-ts.EnvironmentOptions.property.postDeployWorkflowScript">postDeployWorkflowScript</a></code> | <code>string</code> | The script/task to run after deployment of the environment in the workflow If not present, the workflow will not execute that. |
|
|
2604
|
+
| <code><a href="#deployable-awscdk-app-ts.EnvironmentOptions.property.preDeployWorkflowScript">preDeployWorkflowScript</a></code> | <code>string</code> | The script/task to run before deployment of the environment in the workflow If not present, the workflow will not execute that. |
|
|
2498
2605
|
|
|
2499
2606
|
---
|
|
2500
2607
|
|
|
2501
|
-
##### `awsCredentials`<sup>Required</sup> <a name="deployable-awscdk-app-ts.EnvironmentOptions.property.awsCredentials"
|
|
2608
|
+
##### `awsCredentials`<sup>Required</sup> <a name="awsCredentials" id="deployable-awscdk-app-ts.EnvironmentOptions.property.awsCredentials"></a>
|
|
2502
2609
|
|
|
2503
2610
|
```typescript
|
|
2504
2611
|
public readonly awsCredentials: AWSCredentials;
|
|
2505
2612
|
```
|
|
2506
2613
|
|
|
2507
|
-
- *Type:*
|
|
2614
|
+
- *Type:* <a href="#deployable-awscdk-app-ts.AWSCredentials">AWSCredentials</a>
|
|
2508
2615
|
|
|
2509
2616
|
AWS credential details for deployment.
|
|
2510
2617
|
|
|
2511
2618
|
---
|
|
2512
2619
|
|
|
2513
|
-
##### `name`<sup>Required</sup> <a name="deployable-awscdk-app-ts.EnvironmentOptions.property.name"
|
|
2620
|
+
##### `name`<sup>Required</sup> <a name="name" id="deployable-awscdk-app-ts.EnvironmentOptions.property.name"></a>
|
|
2514
2621
|
|
|
2515
2622
|
```typescript
|
|
2516
2623
|
public readonly name: string;
|
|
2517
2624
|
```
|
|
2518
2625
|
|
|
2519
|
-
- *Type:*
|
|
2626
|
+
- *Type:* string
|
|
2520
2627
|
|
|
2521
2628
|
Environment name to deploy to.
|
|
2522
2629
|
|
|
2523
2630
|
---
|
|
2524
2631
|
|
|
2525
|
-
##### `postDeployWorkflowScript`<sup>Optional</sup> <a name="deployable-awscdk-app-ts.EnvironmentOptions.property.postDeployWorkflowScript"
|
|
2632
|
+
##### `postDeployWorkflowScript`<sup>Optional</sup> <a name="postDeployWorkflowScript" id="deployable-awscdk-app-ts.EnvironmentOptions.property.postDeployWorkflowScript"></a>
|
|
2526
2633
|
|
|
2527
2634
|
```typescript
|
|
2528
2635
|
public readonly postDeployWorkflowScript: string;
|
|
2529
2636
|
```
|
|
2530
2637
|
|
|
2531
|
-
- *Type:*
|
|
2638
|
+
- *Type:* string
|
|
2532
2639
|
|
|
2533
2640
|
The script/task to run after deployment of the environment in the workflow If not present, the workflow will not execute that.
|
|
2534
2641
|
|
|
2535
2642
|
---
|
|
2536
2643
|
|
|
2537
|
-
|
|
2644
|
+
*Example*
|
|
2645
|
+
|
|
2646
|
+
```typescript
|
|
2647
|
+
"post:deploy"
|
|
2648
|
+
```
|
|
2649
|
+
|
|
2650
|
+
|
|
2651
|
+
##### `preDeployWorkflowScript`<sup>Optional</sup> <a name="preDeployWorkflowScript" id="deployable-awscdk-app-ts.EnvironmentOptions.property.preDeployWorkflowScript"></a>
|
|
2538
2652
|
|
|
2539
2653
|
```typescript
|
|
2540
2654
|
public readonly preDeployWorkflowScript: string;
|
|
2541
2655
|
```
|
|
2542
2656
|
|
|
2543
|
-
- *Type:*
|
|
2657
|
+
- *Type:* string
|
|
2544
2658
|
|
|
2545
2659
|
The script/task to run before deployment of the environment in the workflow If not present, the workflow will not execute that.
|
|
2546
2660
|
|
|
2547
2661
|
---
|
|
2548
2662
|
|
|
2549
|
-
|
|
2663
|
+
*Example*
|
|
2664
|
+
|
|
2665
|
+
```typescript
|
|
2666
|
+
"pre:deploy"
|
|
2667
|
+
```
|
|
2668
|
+
|
|
2669
|
+
|
|
2670
|
+
## Classes <a name="Classes" id="Classes"></a>
|
|
2550
2671
|
|
|
2551
|
-
### DeployableAwsCdkTypeScriptApp <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp"
|
|
2672
|
+
### DeployableAwsCdkTypeScriptApp <a name="DeployableAwsCdkTypeScriptApp" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp"></a>
|
|
2552
2673
|
|
|
2553
|
-
#### Initializers <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.Initializer"
|
|
2674
|
+
#### Initializers <a name="Initializers" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.Initializer"></a>
|
|
2554
2675
|
|
|
2555
2676
|
```typescript
|
|
2556
2677
|
import { DeployableAwsCdkTypeScriptApp } from 'deployable-awscdk-app-ts'
|
|
@@ -2560,63 +2681,1449 @@ new DeployableAwsCdkTypeScriptApp(options: DeployableAwsCdkTypeScriptAppOptions)
|
|
|
2560
2681
|
|
|
2561
2682
|
| **Name** | **Type** | **Description** |
|
|
2562
2683
|
| --- | --- | --- |
|
|
2563
|
-
|
|
|
2684
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.Initializer.parameter.options">options</a></code> | <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions">DeployableAwsCdkTypeScriptAppOptions</a></code> | *No description.* |
|
|
2564
2685
|
|
|
2565
2686
|
---
|
|
2566
2687
|
|
|
2567
|
-
##### `options`<sup>Required</sup> <a name="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.parameter.options"
|
|
2688
|
+
##### `options`<sup>Required</sup> <a name="options" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.Initializer.parameter.options"></a>
|
|
2568
2689
|
|
|
2569
|
-
- *Type:*
|
|
2690
|
+
- *Type:* <a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions">DeployableAwsCdkTypeScriptAppOptions</a>
|
|
2570
2691
|
|
|
2571
2692
|
---
|
|
2572
2693
|
|
|
2573
|
-
#### Methods <a name="Methods" id="
|
|
2694
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
2574
2695
|
|
|
2575
2696
|
| **Name** | **Description** |
|
|
2576
2697
|
| --- | --- |
|
|
2577
|
-
|
|
|
2578
|
-
|
|
|
2698
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
|
|
2699
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
|
|
2700
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addPackageIgnore">addPackageIgnore</a></code> | Exclude these files from the bundled package. |
|
|
2701
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addTask">addTask</a></code> | Adds a new task to this project. |
|
|
2702
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
|
|
2703
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
|
|
2704
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.postSynthesize">postSynthesize</a></code> | Called after all components are synthesized. |
|
|
2705
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.preSynthesize">preSynthesize</a></code> | Called before all components are synthesized. |
|
|
2706
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.removeTask">removeTask</a></code> | Removes a task from a project. |
|
|
2707
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.runTaskCommand">runTaskCommand</a></code> | Returns the shell command to execute in order to run a task. |
|
|
2708
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.synth">synth</a></code> | Synthesize all project files into `outdir`. |
|
|
2709
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.tryFindFile">tryFindFile</a></code> | Finds a file at the specified relative path within this project and all its subprojects. |
|
|
2710
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.tryFindJsonFile">tryFindJsonFile</a></code> | Finds a json file by name. |
|
|
2711
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.tryFindObjectFile">tryFindObjectFile</a></code> | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
|
|
2712
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.tryRemoveFile">tryRemoveFile</a></code> | Finds a file at the specified relative path within this project and removes it. |
|
|
2713
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addBins">addBins</a></code> | *No description.* |
|
|
2714
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addBundledDeps">addBundledDeps</a></code> | Defines bundled dependencies. |
|
|
2715
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addCompileCommand">addCompileCommand</a></code> | DEPRECATED. |
|
|
2716
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addDeps">addDeps</a></code> | Defines normal dependencies. |
|
|
2717
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addDevDeps">addDevDeps</a></code> | Defines development/test dependencies. |
|
|
2718
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addFields">addFields</a></code> | Directly set fields in `package.json`. |
|
|
2719
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addKeywords">addKeywords</a></code> | Adds keywords to package.json (deduplicated). |
|
|
2720
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addPeerDeps">addPeerDeps</a></code> | Defines peer dependencies. |
|
|
2721
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addTestCommand">addTestCommand</a></code> | DEPRECATED. |
|
|
2722
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.hasScript">hasScript</a></code> | Indicates if a script by the name name is defined. |
|
|
2723
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
|
|
2724
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.renderWorkflowSetup">renderWorkflowSetup</a></code> | Returns the set of workflow steps which should be executed to bootstrap a workflow. |
|
|
2725
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
|
|
2726
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addCdkDependency">addCdkDependency</a></code> | Adds an AWS CDK module dependencies. |
|
|
2727
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addEnvironments">addEnvironments</a></code> | *No description.* |
|
|
2579
2728
|
|
|
2580
2729
|
---
|
|
2581
2730
|
|
|
2582
|
-
##### `
|
|
2731
|
+
##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addExcludeFromCleanup"></a>
|
|
2583
2732
|
|
|
2584
2733
|
```typescript
|
|
2585
|
-
public
|
|
2734
|
+
public addExcludeFromCleanup(globs: string): void
|
|
2586
2735
|
```
|
|
2587
2736
|
|
|
2588
|
-
|
|
2737
|
+
Exclude the matching files from pre-synth cleanup.
|
|
2738
|
+
|
|
2739
|
+
Can be used when, for example, some
|
|
2740
|
+
source files include the projen marker and we don't want them to be erased during synth.
|
|
2741
|
+
|
|
2742
|
+
###### `globs`<sup>Required</sup> <a name="globs" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addExcludeFromCleanup.parameter.globs"></a>
|
|
2589
2743
|
|
|
2590
|
-
- *Type:*
|
|
2744
|
+
- *Type:* string
|
|
2745
|
+
|
|
2746
|
+
The glob patterns to match.
|
|
2591
2747
|
|
|
2592
2748
|
---
|
|
2593
2749
|
|
|
2594
|
-
##### `
|
|
2750
|
+
##### `addGitIgnore` <a name="addGitIgnore" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addGitIgnore"></a>
|
|
2595
2751
|
|
|
2596
2752
|
```typescript
|
|
2597
|
-
public
|
|
2753
|
+
public addGitIgnore(pattern: string): void
|
|
2598
2754
|
```
|
|
2599
2755
|
|
|
2756
|
+
Adds a .gitignore pattern.
|
|
2600
2757
|
|
|
2601
|
-
|
|
2758
|
+
###### `pattern`<sup>Required</sup> <a name="pattern" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addGitIgnore.parameter.pattern"></a>
|
|
2602
2759
|
|
|
2603
|
-
|
|
2604
|
-
|
|
2605
|
-
|
|
2760
|
+
- *Type:* string
|
|
2761
|
+
|
|
2762
|
+
The glob pattern to ignore.
|
|
2606
2763
|
|
|
2607
2764
|
---
|
|
2608
2765
|
|
|
2609
|
-
##### `
|
|
2766
|
+
##### `addPackageIgnore` <a name="addPackageIgnore" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addPackageIgnore"></a>
|
|
2610
2767
|
|
|
2611
2768
|
```typescript
|
|
2612
|
-
public
|
|
2769
|
+
public addPackageIgnore(pattern: string): void
|
|
2613
2770
|
```
|
|
2614
2771
|
|
|
2615
|
-
|
|
2772
|
+
Exclude these files from the bundled package.
|
|
2616
2773
|
|
|
2617
|
-
|
|
2774
|
+
Implemented by project types based on the
|
|
2775
|
+
packaging mechanism. For example, `NodeProject` delegates this to `.npmignore`.
|
|
2776
|
+
|
|
2777
|
+
###### `pattern`<sup>Required</sup> <a name="pattern" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addPackageIgnore.parameter.pattern"></a>
|
|
2778
|
+
|
|
2779
|
+
- *Type:* string
|
|
2780
|
+
|
|
2781
|
+
---
|
|
2782
|
+
|
|
2783
|
+
##### `addTask` <a name="addTask" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addTask"></a>
|
|
2784
|
+
|
|
2785
|
+
```typescript
|
|
2786
|
+
public addTask(name: string, props?: TaskOptions): Task
|
|
2787
|
+
```
|
|
2788
|
+
|
|
2789
|
+
Adds a new task to this project.
|
|
2790
|
+
|
|
2791
|
+
This will fail if the project already has
|
|
2792
|
+
a task with this name.
|
|
2793
|
+
|
|
2794
|
+
###### `name`<sup>Required</sup> <a name="name" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addTask.parameter.name"></a>
|
|
2795
|
+
|
|
2796
|
+
- *Type:* string
|
|
2797
|
+
|
|
2798
|
+
The task name to add.
|
|
2799
|
+
|
|
2800
|
+
---
|
|
2801
|
+
|
|
2802
|
+
###### `props`<sup>Optional</sup> <a name="props" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addTask.parameter.props"></a>
|
|
2803
|
+
|
|
2804
|
+
- *Type:* projen.TaskOptions
|
|
2805
|
+
|
|
2806
|
+
Task properties.
|
|
2807
|
+
|
|
2808
|
+
---
|
|
2809
|
+
|
|
2810
|
+
##### ~~`addTip`~~ <a name="addTip" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addTip"></a>
|
|
2811
|
+
|
|
2812
|
+
```typescript
|
|
2813
|
+
public addTip(message: string): void
|
|
2814
|
+
```
|
|
2815
|
+
|
|
2816
|
+
Prints a "tip" message during synthesis.
|
|
2817
|
+
|
|
2818
|
+
###### `message`<sup>Required</sup> <a name="message" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addTip.parameter.message"></a>
|
|
2819
|
+
|
|
2820
|
+
- *Type:* string
|
|
2821
|
+
|
|
2822
|
+
The message.
|
|
2823
|
+
|
|
2824
|
+
---
|
|
2825
|
+
|
|
2826
|
+
##### `annotateGenerated` <a name="annotateGenerated" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.annotateGenerated"></a>
|
|
2827
|
+
|
|
2828
|
+
```typescript
|
|
2829
|
+
public annotateGenerated(glob: string): void
|
|
2830
|
+
```
|
|
2831
|
+
|
|
2832
|
+
Marks the provided file(s) as being generated.
|
|
2833
|
+
|
|
2834
|
+
This is achieved using the
|
|
2835
|
+
github-linguist attributes. Generated files do not count against the
|
|
2836
|
+
repository statistics and language breakdown.
|
|
2837
|
+
|
|
2838
|
+
> [https://github.com/github/linguist/blob/master/docs/overrides.md](https://github.com/github/linguist/blob/master/docs/overrides.md)
|
|
2839
|
+
|
|
2840
|
+
###### `glob`<sup>Required</sup> <a name="glob" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.annotateGenerated.parameter.glob"></a>
|
|
2841
|
+
|
|
2842
|
+
- *Type:* string
|
|
2843
|
+
|
|
2844
|
+
the glob pattern to match (could be a file path).
|
|
2845
|
+
|
|
2846
|
+
---
|
|
2847
|
+
|
|
2848
|
+
##### `postSynthesize` <a name="postSynthesize" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.postSynthesize"></a>
|
|
2849
|
+
|
|
2850
|
+
```typescript
|
|
2851
|
+
public postSynthesize(): void
|
|
2852
|
+
```
|
|
2853
|
+
|
|
2854
|
+
Called after all components are synthesized.
|
|
2855
|
+
|
|
2856
|
+
Order is *not* guaranteed.
|
|
2857
|
+
|
|
2858
|
+
##### `preSynthesize` <a name="preSynthesize" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.preSynthesize"></a>
|
|
2859
|
+
|
|
2860
|
+
```typescript
|
|
2861
|
+
public preSynthesize(): void
|
|
2862
|
+
```
|
|
2863
|
+
|
|
2864
|
+
Called before all components are synthesized.
|
|
2865
|
+
|
|
2866
|
+
##### `removeTask` <a name="removeTask" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.removeTask"></a>
|
|
2867
|
+
|
|
2868
|
+
```typescript
|
|
2869
|
+
public removeTask(name: string): Task
|
|
2870
|
+
```
|
|
2871
|
+
|
|
2872
|
+
Removes a task from a project.
|
|
2873
|
+
|
|
2874
|
+
###### `name`<sup>Required</sup> <a name="name" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.removeTask.parameter.name"></a>
|
|
2875
|
+
|
|
2876
|
+
- *Type:* string
|
|
2877
|
+
|
|
2878
|
+
The name of the task to remove.
|
|
2879
|
+
|
|
2880
|
+
---
|
|
2881
|
+
|
|
2882
|
+
##### `runTaskCommand` <a name="runTaskCommand" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.runTaskCommand"></a>
|
|
2883
|
+
|
|
2884
|
+
```typescript
|
|
2885
|
+
public runTaskCommand(task: Task): string
|
|
2886
|
+
```
|
|
2887
|
+
|
|
2888
|
+
Returns the shell command to execute in order to run a task.
|
|
2889
|
+
|
|
2890
|
+
This will
|
|
2891
|
+
typically be `npx projen TASK`.
|
|
2892
|
+
|
|
2893
|
+
###### `task`<sup>Required</sup> <a name="task" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.runTaskCommand.parameter.task"></a>
|
|
2894
|
+
|
|
2895
|
+
- *Type:* projen.Task
|
|
2896
|
+
|
|
2897
|
+
The task for which the command is required.
|
|
2898
|
+
|
|
2899
|
+
---
|
|
2900
|
+
|
|
2901
|
+
##### `synth` <a name="synth" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.synth"></a>
|
|
2902
|
+
|
|
2903
|
+
```typescript
|
|
2904
|
+
public synth(): void
|
|
2905
|
+
```
|
|
2906
|
+
|
|
2907
|
+
Synthesize all project files into `outdir`.
|
|
2908
|
+
|
|
2909
|
+
1. Call "this.preSynthesize()"
|
|
2910
|
+
2. Delete all generated files
|
|
2911
|
+
3. Synthesize all sub-projects
|
|
2912
|
+
4. Synthesize all components of this project
|
|
2913
|
+
5. Call "postSynthesize()" for all components of this project
|
|
2914
|
+
6. Call "this.postSynthesize()"
|
|
2915
|
+
|
|
2916
|
+
##### `tryFindFile` <a name="tryFindFile" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.tryFindFile"></a>
|
|
2917
|
+
|
|
2918
|
+
```typescript
|
|
2919
|
+
public tryFindFile(filePath: string): FileBase
|
|
2920
|
+
```
|
|
2921
|
+
|
|
2922
|
+
Finds a file at the specified relative path within this project and all its subprojects.
|
|
2923
|
+
|
|
2924
|
+
###### `filePath`<sup>Required</sup> <a name="filePath" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.tryFindFile.parameter.filePath"></a>
|
|
2925
|
+
|
|
2926
|
+
- *Type:* string
|
|
2927
|
+
|
|
2928
|
+
The file path.
|
|
2929
|
+
|
|
2930
|
+
If this path is relative, it will be resolved
|
|
2931
|
+
from the root of _this_ project.
|
|
2932
|
+
|
|
2933
|
+
---
|
|
2934
|
+
|
|
2935
|
+
##### ~~`tryFindJsonFile`~~ <a name="tryFindJsonFile" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.tryFindJsonFile"></a>
|
|
2936
|
+
|
|
2937
|
+
```typescript
|
|
2938
|
+
public tryFindJsonFile(filePath: string): JsonFile
|
|
2939
|
+
```
|
|
2940
|
+
|
|
2941
|
+
Finds a json file by name.
|
|
2942
|
+
|
|
2943
|
+
###### `filePath`<sup>Required</sup> <a name="filePath" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.tryFindJsonFile.parameter.filePath"></a>
|
|
2944
|
+
|
|
2945
|
+
- *Type:* string
|
|
2946
|
+
|
|
2947
|
+
The file path.
|
|
2948
|
+
|
|
2949
|
+
---
|
|
2950
|
+
|
|
2951
|
+
##### `tryFindObjectFile` <a name="tryFindObjectFile" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.tryFindObjectFile"></a>
|
|
2952
|
+
|
|
2953
|
+
```typescript
|
|
2954
|
+
public tryFindObjectFile(filePath: string): ObjectFile
|
|
2955
|
+
```
|
|
2956
|
+
|
|
2957
|
+
Finds an object file (like JsonFile, YamlFile, etc.) by name.
|
|
2958
|
+
|
|
2959
|
+
###### `filePath`<sup>Required</sup> <a name="filePath" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.tryFindObjectFile.parameter.filePath"></a>
|
|
2960
|
+
|
|
2961
|
+
- *Type:* string
|
|
2962
|
+
|
|
2963
|
+
The file path.
|
|
2964
|
+
|
|
2965
|
+
---
|
|
2966
|
+
|
|
2967
|
+
##### `tryRemoveFile` <a name="tryRemoveFile" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.tryRemoveFile"></a>
|
|
2968
|
+
|
|
2969
|
+
```typescript
|
|
2970
|
+
public tryRemoveFile(filePath: string): FileBase
|
|
2971
|
+
```
|
|
2972
|
+
|
|
2973
|
+
Finds a file at the specified relative path within this project and removes it.
|
|
2974
|
+
|
|
2975
|
+
###### `filePath`<sup>Required</sup> <a name="filePath" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.tryRemoveFile.parameter.filePath"></a>
|
|
2976
|
+
|
|
2977
|
+
- *Type:* string
|
|
2978
|
+
|
|
2979
|
+
The file path.
|
|
2980
|
+
|
|
2981
|
+
If this path is relative, it will be
|
|
2982
|
+
resolved from the root of _this_ project.
|
|
2983
|
+
|
|
2984
|
+
---
|
|
2985
|
+
|
|
2986
|
+
##### `addBins` <a name="addBins" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addBins"></a>
|
|
2987
|
+
|
|
2988
|
+
```typescript
|
|
2989
|
+
public addBins(bins: {[ key: string ]: string}): void
|
|
2990
|
+
```
|
|
2991
|
+
|
|
2992
|
+
###### `bins`<sup>Required</sup> <a name="bins" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addBins.parameter.bins"></a>
|
|
2993
|
+
|
|
2994
|
+
- *Type:* {[ key: string ]: string}
|
|
2995
|
+
|
|
2996
|
+
---
|
|
2997
|
+
|
|
2998
|
+
##### `addBundledDeps` <a name="addBundledDeps" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addBundledDeps"></a>
|
|
2999
|
+
|
|
3000
|
+
```typescript
|
|
3001
|
+
public addBundledDeps(deps: string): void
|
|
3002
|
+
```
|
|
3003
|
+
|
|
3004
|
+
Defines bundled dependencies.
|
|
3005
|
+
|
|
3006
|
+
Bundled dependencies will be added as normal dependencies as well as to the
|
|
3007
|
+
`bundledDependencies` section of your `package.json`.
|
|
3008
|
+
|
|
3009
|
+
###### `deps`<sup>Required</sup> <a name="deps" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addBundledDeps.parameter.deps"></a>
|
|
3010
|
+
|
|
3011
|
+
- *Type:* string
|
|
3012
|
+
|
|
3013
|
+
Names modules to install.
|
|
3014
|
+
|
|
3015
|
+
By default, the the dependency will
|
|
3016
|
+
be installed in the next `npx projen` run and the version will be recorded
|
|
3017
|
+
in your `package.json` file. You can upgrade manually or using `yarn
|
|
3018
|
+
add/upgrade`. If you wish to specify a version range use this syntax:
|
|
3019
|
+
`module@^7`.
|
|
3020
|
+
|
|
3021
|
+
---
|
|
3022
|
+
|
|
3023
|
+
##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addCompileCommand"></a>
|
|
3024
|
+
|
|
3025
|
+
```typescript
|
|
3026
|
+
public addCompileCommand(commands: string): void
|
|
3027
|
+
```
|
|
3028
|
+
|
|
3029
|
+
DEPRECATED.
|
|
3030
|
+
|
|
3031
|
+
###### `commands`<sup>Required</sup> <a name="commands" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addCompileCommand.parameter.commands"></a>
|
|
3032
|
+
|
|
3033
|
+
- *Type:* string
|
|
3034
|
+
|
|
3035
|
+
---
|
|
3036
|
+
|
|
3037
|
+
##### `addDeps` <a name="addDeps" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addDeps"></a>
|
|
3038
|
+
|
|
3039
|
+
```typescript
|
|
3040
|
+
public addDeps(deps: string): void
|
|
3041
|
+
```
|
|
3042
|
+
|
|
3043
|
+
Defines normal dependencies.
|
|
3044
|
+
|
|
3045
|
+
###### `deps`<sup>Required</sup> <a name="deps" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addDeps.parameter.deps"></a>
|
|
3046
|
+
|
|
3047
|
+
- *Type:* string
|
|
3048
|
+
|
|
3049
|
+
Names modules to install.
|
|
3050
|
+
|
|
3051
|
+
By default, the the dependency will
|
|
3052
|
+
be installed in the next `npx projen` run and the version will be recorded
|
|
3053
|
+
in your `package.json` file. You can upgrade manually or using `yarn
|
|
3054
|
+
add/upgrade`. If you wish to specify a version range use this syntax:
|
|
3055
|
+
`module@^7`.
|
|
3056
|
+
|
|
3057
|
+
---
|
|
3058
|
+
|
|
3059
|
+
##### `addDevDeps` <a name="addDevDeps" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addDevDeps"></a>
|
|
3060
|
+
|
|
3061
|
+
```typescript
|
|
3062
|
+
public addDevDeps(deps: string): void
|
|
3063
|
+
```
|
|
3064
|
+
|
|
3065
|
+
Defines development/test dependencies.
|
|
3066
|
+
|
|
3067
|
+
###### `deps`<sup>Required</sup> <a name="deps" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addDevDeps.parameter.deps"></a>
|
|
3068
|
+
|
|
3069
|
+
- *Type:* string
|
|
3070
|
+
|
|
3071
|
+
Names modules to install.
|
|
3072
|
+
|
|
3073
|
+
By default, the the dependency will
|
|
3074
|
+
be installed in the next `npx projen` run and the version will be recorded
|
|
3075
|
+
in your `package.json` file. You can upgrade manually or using `yarn
|
|
3076
|
+
add/upgrade`. If you wish to specify a version range use this syntax:
|
|
3077
|
+
`module@^7`.
|
|
3078
|
+
|
|
3079
|
+
---
|
|
3080
|
+
|
|
3081
|
+
##### `addFields` <a name="addFields" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addFields"></a>
|
|
3082
|
+
|
|
3083
|
+
```typescript
|
|
3084
|
+
public addFields(fields: {[ key: string ]: any}): void
|
|
3085
|
+
```
|
|
3086
|
+
|
|
3087
|
+
Directly set fields in `package.json`.
|
|
3088
|
+
|
|
3089
|
+
###### `fields`<sup>Required</sup> <a name="fields" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addFields.parameter.fields"></a>
|
|
3090
|
+
|
|
3091
|
+
- *Type:* {[ key: string ]: any}
|
|
3092
|
+
|
|
3093
|
+
The fields to set.
|
|
3094
|
+
|
|
3095
|
+
---
|
|
3096
|
+
|
|
3097
|
+
##### `addKeywords` <a name="addKeywords" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addKeywords"></a>
|
|
3098
|
+
|
|
3099
|
+
```typescript
|
|
3100
|
+
public addKeywords(keywords: string): void
|
|
3101
|
+
```
|
|
3102
|
+
|
|
3103
|
+
Adds keywords to package.json (deduplicated).
|
|
3104
|
+
|
|
3105
|
+
###### `keywords`<sup>Required</sup> <a name="keywords" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addKeywords.parameter.keywords"></a>
|
|
3106
|
+
|
|
3107
|
+
- *Type:* string
|
|
3108
|
+
|
|
3109
|
+
The keywords to add.
|
|
3110
|
+
|
|
3111
|
+
---
|
|
3112
|
+
|
|
3113
|
+
##### `addPeerDeps` <a name="addPeerDeps" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addPeerDeps"></a>
|
|
3114
|
+
|
|
3115
|
+
```typescript
|
|
3116
|
+
public addPeerDeps(deps: string): void
|
|
3117
|
+
```
|
|
3118
|
+
|
|
3119
|
+
Defines peer dependencies.
|
|
3120
|
+
|
|
3121
|
+
When adding peer dependencies, a devDependency will also be added on the
|
|
3122
|
+
pinned version of the declared peer. This will ensure that you are testing
|
|
3123
|
+
your code against the minimum version required from your consumers.
|
|
3124
|
+
|
|
3125
|
+
###### `deps`<sup>Required</sup> <a name="deps" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addPeerDeps.parameter.deps"></a>
|
|
3126
|
+
|
|
3127
|
+
- *Type:* string
|
|
3128
|
+
|
|
3129
|
+
Names modules to install.
|
|
3130
|
+
|
|
3131
|
+
By default, the the dependency will
|
|
3132
|
+
be installed in the next `npx projen` run and the version will be recorded
|
|
3133
|
+
in your `package.json` file. You can upgrade manually or using `yarn
|
|
3134
|
+
add/upgrade`. If you wish to specify a version range use this syntax:
|
|
3135
|
+
`module@^7`.
|
|
2618
3136
|
|
|
2619
3137
|
---
|
|
2620
3138
|
|
|
3139
|
+
##### ~~`addTestCommand`~~ <a name="addTestCommand" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addTestCommand"></a>
|
|
3140
|
+
|
|
3141
|
+
```typescript
|
|
3142
|
+
public addTestCommand(commands: string): void
|
|
3143
|
+
```
|
|
3144
|
+
|
|
3145
|
+
DEPRECATED.
|
|
3146
|
+
|
|
3147
|
+
###### `commands`<sup>Required</sup> <a name="commands" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addTestCommand.parameter.commands"></a>
|
|
3148
|
+
|
|
3149
|
+
- *Type:* string
|
|
3150
|
+
|
|
3151
|
+
---
|
|
3152
|
+
|
|
3153
|
+
##### `hasScript` <a name="hasScript" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.hasScript"></a>
|
|
3154
|
+
|
|
3155
|
+
```typescript
|
|
3156
|
+
public hasScript(name: string): boolean
|
|
3157
|
+
```
|
|
3158
|
+
|
|
3159
|
+
Indicates if a script by the name name is defined.
|
|
3160
|
+
|
|
3161
|
+
###### `name`<sup>Required</sup> <a name="name" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.hasScript.parameter.name"></a>
|
|
3162
|
+
|
|
3163
|
+
- *Type:* string
|
|
3164
|
+
|
|
3165
|
+
The name of the script.
|
|
3166
|
+
|
|
3167
|
+
---
|
|
3168
|
+
|
|
3169
|
+
##### `removeScript` <a name="removeScript" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.removeScript"></a>
|
|
3170
|
+
|
|
3171
|
+
```typescript
|
|
3172
|
+
public removeScript(name: string): void
|
|
3173
|
+
```
|
|
3174
|
+
|
|
3175
|
+
Removes the npm script (always successful).
|
|
3176
|
+
|
|
3177
|
+
###### `name`<sup>Required</sup> <a name="name" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.removeScript.parameter.name"></a>
|
|
3178
|
+
|
|
3179
|
+
- *Type:* string
|
|
3180
|
+
|
|
3181
|
+
The name of the script.
|
|
3182
|
+
|
|
3183
|
+
---
|
|
3184
|
+
|
|
3185
|
+
##### `renderWorkflowSetup` <a name="renderWorkflowSetup" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.renderWorkflowSetup"></a>
|
|
3186
|
+
|
|
3187
|
+
```typescript
|
|
3188
|
+
public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[]
|
|
3189
|
+
```
|
|
3190
|
+
|
|
3191
|
+
Returns the set of workflow steps which should be executed to bootstrap a workflow.
|
|
3192
|
+
|
|
3193
|
+
###### `options`<sup>Optional</sup> <a name="options" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.renderWorkflowSetup.parameter.options"></a>
|
|
3194
|
+
|
|
3195
|
+
- *Type:* projen.javascript.RenderWorkflowSetupOptions
|
|
3196
|
+
|
|
3197
|
+
Options.
|
|
3198
|
+
|
|
3199
|
+
---
|
|
3200
|
+
|
|
3201
|
+
##### `setScript` <a name="setScript" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.setScript"></a>
|
|
3202
|
+
|
|
3203
|
+
```typescript
|
|
3204
|
+
public setScript(name: string, command: string): void
|
|
3205
|
+
```
|
|
3206
|
+
|
|
3207
|
+
Replaces the contents of an npm package.json script.
|
|
3208
|
+
|
|
3209
|
+
###### `name`<sup>Required</sup> <a name="name" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.setScript.parameter.name"></a>
|
|
3210
|
+
|
|
3211
|
+
- *Type:* string
|
|
3212
|
+
|
|
3213
|
+
The script name.
|
|
3214
|
+
|
|
3215
|
+
---
|
|
3216
|
+
|
|
3217
|
+
###### `command`<sup>Required</sup> <a name="command" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.setScript.parameter.command"></a>
|
|
3218
|
+
|
|
3219
|
+
- *Type:* string
|
|
3220
|
+
|
|
3221
|
+
The command to execute.
|
|
3222
|
+
|
|
3223
|
+
---
|
|
3224
|
+
|
|
3225
|
+
##### `addCdkDependency` <a name="addCdkDependency" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addCdkDependency"></a>
|
|
3226
|
+
|
|
3227
|
+
```typescript
|
|
3228
|
+
public addCdkDependency(modules: string): void
|
|
3229
|
+
```
|
|
3230
|
+
|
|
3231
|
+
Adds an AWS CDK module dependencies.
|
|
3232
|
+
|
|
3233
|
+
###### `modules`<sup>Required</sup> <a name="modules" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addCdkDependency.parameter.modules"></a>
|
|
3234
|
+
|
|
3235
|
+
- *Type:* string
|
|
3236
|
+
|
|
3237
|
+
The list of modules to depend on.
|
|
3238
|
+
|
|
3239
|
+
---
|
|
3240
|
+
|
|
3241
|
+
##### `addEnvironments` <a name="addEnvironments" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addEnvironments"></a>
|
|
3242
|
+
|
|
3243
|
+
```typescript
|
|
3244
|
+
public addEnvironments(items: EnvironmentOptions): void
|
|
3245
|
+
```
|
|
3246
|
+
|
|
3247
|
+
###### `items`<sup>Required</sup> <a name="items" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.addEnvironments.parameter.items"></a>
|
|
3248
|
+
|
|
3249
|
+
- *Type:* <a href="#deployable-awscdk-app-ts.EnvironmentOptions">EnvironmentOptions</a>
|
|
3250
|
+
|
|
3251
|
+
---
|
|
3252
|
+
|
|
3253
|
+
|
|
3254
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
3255
|
+
|
|
3256
|
+
| **Name** | **Type** | **Description** |
|
|
3257
|
+
| --- | --- | --- |
|
|
3258
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.buildTask">buildTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
3259
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
|
3260
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.compileTask">compileTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
3261
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.components">components</a></code> | <code>projen.Component[]</code> | Returns all the components within this project. |
|
|
3262
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.deps">deps</a></code> | <code>projen.Dependencies</code> | Project dependencies. |
|
|
3263
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.ejected">ejected</a></code> | <code>boolean</code> | Whether or not the project is being ejected. |
|
|
3264
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.files">files</a></code> | <code>projen.FileBase[]</code> | All files in this project. |
|
|
3265
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.gitattributes">gitattributes</a></code> | <code>projen.GitAttributesFile</code> | The .gitattributes file for this repository. |
|
|
3266
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.gitignore">gitignore</a></code> | <code>projen.IgnoreFile</code> | .gitignore. |
|
|
3267
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.logger">logger</a></code> | <code>projen.Logger</code> | Logging utilities. |
|
|
3268
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.name">name</a></code> | <code>string</code> | Project name. |
|
|
3269
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.outdir">outdir</a></code> | <code>string</code> | Absolute output directory of this project. |
|
|
3270
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.packageTask">packageTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
3271
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.postCompileTask">postCompileTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
3272
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.preCompileTask">preCompileTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
3273
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.projectBuild">projectBuild</a></code> | <code>projen.ProjectBuild</code> | Manages the build process of the project. |
|
|
3274
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.projenCommand">projenCommand</a></code> | <code>string</code> | The command to use in order to run the projen CLI. |
|
|
3275
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.root">root</a></code> | <code>projen.Project</code> | The root project. |
|
|
3276
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.tasks">tasks</a></code> | <code>projen.Tasks</code> | Project tasks. |
|
|
3277
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.testTask">testTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
3278
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
|
|
3279
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.initProject">initProject</a></code> | <code>projen.InitProject</code> | The options used when this project is bootstrapped via `projen new`. |
|
|
3280
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.parent">parent</a></code> | <code>projen.Project</code> | A parent project. |
|
|
3281
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | *No description.* |
|
|
3282
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.autoApprove">autoApprove</a></code> | <code>projen.github.AutoApprove</code> | Auto approve set up for this project. |
|
|
3283
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.devContainer">devContainer</a></code> | <code>projen.vscode.DevContainer</code> | Access for .devcontainer.json (used for GitHub Codespaces). |
|
|
3284
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.github">github</a></code> | <code>projen.github.GitHub</code> | Access all github components. |
|
|
3285
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.gitpod">gitpod</a></code> | <code>projen.Gitpod</code> | Access for Gitpod. |
|
|
3286
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.vscode">vscode</a></code> | <code>projen.vscode.VsCode</code> | Access all VSCode components. |
|
|
3287
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | *No description.* |
|
|
3288
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | The build output directory. |
|
|
3289
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.artifactsJavascriptDirectory">artifactsJavascriptDirectory</a></code> | <code>string</code> | The location of the npm tarball after build (`${artifactsDirectory}/js`). |
|
|
3290
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.bundler">bundler</a></code> | <code>projen.javascript.Bundler</code> | *No description.* |
|
|
3291
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.entrypoint">entrypoint</a></code> | <code>string</code> | *No description.* |
|
|
3292
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.manifest">manifest</a></code> | <code>any</code> | *No description.* |
|
|
3293
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.package">package</a></code> | <code>projen.javascript.NodePackage</code> | API for managing the node package. |
|
|
3294
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
|
|
3295
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.runScriptCommand">runScriptCommand</a></code> | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). |
|
|
3296
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
|
|
3297
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
|
|
3298
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
|
|
3299
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
|
|
3300
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version required by this package. |
|
|
3301
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | Minimum node.js version required by this package. |
|
|
3302
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
|
|
3303
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
|
|
3304
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
|
|
3305
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.release">release</a></code> | <code>projen.release.Release</code> | Release management. |
|
|
3306
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
|
|
3307
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
|
|
3308
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.libdir">libdir</a></code> | <code>string</code> | The directory in which compiled .js files reside. |
|
|
3309
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.srcdir">srcdir</a></code> | <code>string</code> | The directory in which the .ts sources reside. |
|
|
3310
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.testdir">testdir</a></code> | <code>string</code> | The directory in which tests reside. |
|
|
3311
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfig</code> | A typescript configuration file which covers all files (sources, tests, projen). |
|
|
3312
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.watchTask">watchTask</a></code> | <code>projen.Task</code> | The "watch" task. |
|
|
3313
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.docgen">docgen</a></code> | <code>boolean</code> | *No description.* |
|
|
3314
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.eslint">eslint</a></code> | <code>projen.javascript.Eslint</code> | *No description.* |
|
|
3315
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
|
|
3316
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.tsconfigEslint">tsconfigEslint</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
|
|
3317
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.appEntrypoint">appEntrypoint</a></code> | <code>string</code> | The CDK app entrypoint. |
|
|
3318
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.cdkConfig">cdkConfig</a></code> | <code>projen.awscdk.CdkConfig</code> | cdk.json configuration. |
|
|
3319
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.cdkDeps">cdkDeps</a></code> | <code>projen.awscdk.AwsCdkDeps</code> | *No description.* |
|
|
3320
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.cdkTasks">cdkTasks</a></code> | <code>projen.awscdk.CdkTasks</code> | Common CDK tasks. |
|
|
3321
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.cdkVersion">cdkVersion</a></code> | <code>string</code> | The CDK version this app is using. |
|
|
3322
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.deployWorkflowTask">deployWorkflowTask</a></code> | <code>projen.Task</code> | Task to deploy your app. |
|
|
3323
|
+
|
|
3324
|
+
---
|
|
3325
|
+
|
|
3326
|
+
##### `buildTask`<sup>Required</sup> <a name="buildTask" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.buildTask"></a>
|
|
3327
|
+
|
|
3328
|
+
```typescript
|
|
3329
|
+
public readonly buildTask: Task;
|
|
3330
|
+
```
|
|
3331
|
+
|
|
3332
|
+
- *Type:* projen.Task
|
|
3333
|
+
|
|
3334
|
+
---
|
|
3335
|
+
|
|
3336
|
+
##### `commitGenerated`<sup>Required</sup> <a name="commitGenerated" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.commitGenerated"></a>
|
|
3337
|
+
|
|
3338
|
+
```typescript
|
|
3339
|
+
public readonly commitGenerated: boolean;
|
|
3340
|
+
```
|
|
3341
|
+
|
|
3342
|
+
- *Type:* boolean
|
|
3343
|
+
|
|
3344
|
+
Whether to commit the managed files by default.
|
|
3345
|
+
|
|
3346
|
+
---
|
|
3347
|
+
|
|
3348
|
+
##### `compileTask`<sup>Required</sup> <a name="compileTask" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.compileTask"></a>
|
|
3349
|
+
|
|
3350
|
+
```typescript
|
|
3351
|
+
public readonly compileTask: Task;
|
|
3352
|
+
```
|
|
3353
|
+
|
|
3354
|
+
- *Type:* projen.Task
|
|
3355
|
+
|
|
3356
|
+
---
|
|
3357
|
+
|
|
3358
|
+
##### `components`<sup>Required</sup> <a name="components" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.components"></a>
|
|
3359
|
+
|
|
3360
|
+
```typescript
|
|
3361
|
+
public readonly components: Component[];
|
|
3362
|
+
```
|
|
3363
|
+
|
|
3364
|
+
- *Type:* projen.Component[]
|
|
3365
|
+
|
|
3366
|
+
Returns all the components within this project.
|
|
3367
|
+
|
|
3368
|
+
---
|
|
3369
|
+
|
|
3370
|
+
##### `deps`<sup>Required</sup> <a name="deps" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.deps"></a>
|
|
3371
|
+
|
|
3372
|
+
```typescript
|
|
3373
|
+
public readonly deps: Dependencies;
|
|
3374
|
+
```
|
|
3375
|
+
|
|
3376
|
+
- *Type:* projen.Dependencies
|
|
3377
|
+
|
|
3378
|
+
Project dependencies.
|
|
3379
|
+
|
|
3380
|
+
---
|
|
3381
|
+
|
|
3382
|
+
##### `ejected`<sup>Required</sup> <a name="ejected" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.ejected"></a>
|
|
3383
|
+
|
|
3384
|
+
```typescript
|
|
3385
|
+
public readonly ejected: boolean;
|
|
3386
|
+
```
|
|
3387
|
+
|
|
3388
|
+
- *Type:* boolean
|
|
3389
|
+
|
|
3390
|
+
Whether or not the project is being ejected.
|
|
3391
|
+
|
|
3392
|
+
---
|
|
3393
|
+
|
|
3394
|
+
##### `files`<sup>Required</sup> <a name="files" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.files"></a>
|
|
3395
|
+
|
|
3396
|
+
```typescript
|
|
3397
|
+
public readonly files: FileBase[];
|
|
3398
|
+
```
|
|
3399
|
+
|
|
3400
|
+
- *Type:* projen.FileBase[]
|
|
3401
|
+
|
|
3402
|
+
All files in this project.
|
|
3403
|
+
|
|
3404
|
+
---
|
|
3405
|
+
|
|
3406
|
+
##### `gitattributes`<sup>Required</sup> <a name="gitattributes" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.gitattributes"></a>
|
|
3407
|
+
|
|
3408
|
+
```typescript
|
|
3409
|
+
public readonly gitattributes: GitAttributesFile;
|
|
3410
|
+
```
|
|
3411
|
+
|
|
3412
|
+
- *Type:* projen.GitAttributesFile
|
|
3413
|
+
|
|
3414
|
+
The .gitattributes file for this repository.
|
|
3415
|
+
|
|
3416
|
+
---
|
|
3417
|
+
|
|
3418
|
+
##### `gitignore`<sup>Required</sup> <a name="gitignore" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.gitignore"></a>
|
|
3419
|
+
|
|
3420
|
+
```typescript
|
|
3421
|
+
public readonly gitignore: IgnoreFile;
|
|
3422
|
+
```
|
|
3423
|
+
|
|
3424
|
+
- *Type:* projen.IgnoreFile
|
|
3425
|
+
|
|
3426
|
+
.gitignore.
|
|
3427
|
+
|
|
3428
|
+
---
|
|
3429
|
+
|
|
3430
|
+
##### `logger`<sup>Required</sup> <a name="logger" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.logger"></a>
|
|
3431
|
+
|
|
3432
|
+
```typescript
|
|
3433
|
+
public readonly logger: Logger;
|
|
3434
|
+
```
|
|
3435
|
+
|
|
3436
|
+
- *Type:* projen.Logger
|
|
3437
|
+
|
|
3438
|
+
Logging utilities.
|
|
3439
|
+
|
|
3440
|
+
---
|
|
3441
|
+
|
|
3442
|
+
##### `name`<sup>Required</sup> <a name="name" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.name"></a>
|
|
3443
|
+
|
|
3444
|
+
```typescript
|
|
3445
|
+
public readonly name: string;
|
|
3446
|
+
```
|
|
3447
|
+
|
|
3448
|
+
- *Type:* string
|
|
3449
|
+
|
|
3450
|
+
Project name.
|
|
3451
|
+
|
|
3452
|
+
---
|
|
3453
|
+
|
|
3454
|
+
##### `outdir`<sup>Required</sup> <a name="outdir" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.outdir"></a>
|
|
3455
|
+
|
|
3456
|
+
```typescript
|
|
3457
|
+
public readonly outdir: string;
|
|
3458
|
+
```
|
|
3459
|
+
|
|
3460
|
+
- *Type:* string
|
|
3461
|
+
|
|
3462
|
+
Absolute output directory of this project.
|
|
3463
|
+
|
|
3464
|
+
---
|
|
3465
|
+
|
|
3466
|
+
##### `packageTask`<sup>Required</sup> <a name="packageTask" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.packageTask"></a>
|
|
3467
|
+
|
|
3468
|
+
```typescript
|
|
3469
|
+
public readonly packageTask: Task;
|
|
3470
|
+
```
|
|
3471
|
+
|
|
3472
|
+
- *Type:* projen.Task
|
|
3473
|
+
|
|
3474
|
+
---
|
|
3475
|
+
|
|
3476
|
+
##### `postCompileTask`<sup>Required</sup> <a name="postCompileTask" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.postCompileTask"></a>
|
|
3477
|
+
|
|
3478
|
+
```typescript
|
|
3479
|
+
public readonly postCompileTask: Task;
|
|
3480
|
+
```
|
|
3481
|
+
|
|
3482
|
+
- *Type:* projen.Task
|
|
3483
|
+
|
|
3484
|
+
---
|
|
3485
|
+
|
|
3486
|
+
##### `preCompileTask`<sup>Required</sup> <a name="preCompileTask" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.preCompileTask"></a>
|
|
3487
|
+
|
|
3488
|
+
```typescript
|
|
3489
|
+
public readonly preCompileTask: Task;
|
|
3490
|
+
```
|
|
3491
|
+
|
|
3492
|
+
- *Type:* projen.Task
|
|
3493
|
+
|
|
3494
|
+
---
|
|
3495
|
+
|
|
3496
|
+
##### `projectBuild`<sup>Required</sup> <a name="projectBuild" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.projectBuild"></a>
|
|
3497
|
+
|
|
3498
|
+
```typescript
|
|
3499
|
+
public readonly projectBuild: ProjectBuild;
|
|
3500
|
+
```
|
|
3501
|
+
|
|
3502
|
+
- *Type:* projen.ProjectBuild
|
|
3503
|
+
|
|
3504
|
+
Manages the build process of the project.
|
|
3505
|
+
|
|
3506
|
+
---
|
|
3507
|
+
|
|
3508
|
+
##### `projenCommand`<sup>Required</sup> <a name="projenCommand" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.projenCommand"></a>
|
|
3509
|
+
|
|
3510
|
+
```typescript
|
|
3511
|
+
public readonly projenCommand: string;
|
|
3512
|
+
```
|
|
3513
|
+
|
|
3514
|
+
- *Type:* string
|
|
3515
|
+
|
|
3516
|
+
The command to use in order to run the projen CLI.
|
|
3517
|
+
|
|
3518
|
+
---
|
|
3519
|
+
|
|
3520
|
+
##### `root`<sup>Required</sup> <a name="root" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.root"></a>
|
|
3521
|
+
|
|
3522
|
+
```typescript
|
|
3523
|
+
public readonly root: Project;
|
|
3524
|
+
```
|
|
3525
|
+
|
|
3526
|
+
- *Type:* projen.Project
|
|
3527
|
+
|
|
3528
|
+
The root project.
|
|
3529
|
+
|
|
3530
|
+
---
|
|
3531
|
+
|
|
3532
|
+
##### `tasks`<sup>Required</sup> <a name="tasks" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.tasks"></a>
|
|
3533
|
+
|
|
3534
|
+
```typescript
|
|
3535
|
+
public readonly tasks: Tasks;
|
|
3536
|
+
```
|
|
3537
|
+
|
|
3538
|
+
- *Type:* projen.Tasks
|
|
3539
|
+
|
|
3540
|
+
Project tasks.
|
|
3541
|
+
|
|
3542
|
+
---
|
|
3543
|
+
|
|
3544
|
+
##### `testTask`<sup>Required</sup> <a name="testTask" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.testTask"></a>
|
|
3545
|
+
|
|
3546
|
+
```typescript
|
|
3547
|
+
public readonly testTask: Task;
|
|
3548
|
+
```
|
|
3549
|
+
|
|
3550
|
+
- *Type:* projen.Task
|
|
3551
|
+
|
|
3552
|
+
---
|
|
3553
|
+
|
|
3554
|
+
##### `defaultTask`<sup>Optional</sup> <a name="defaultTask" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.defaultTask"></a>
|
|
3555
|
+
|
|
3556
|
+
```typescript
|
|
3557
|
+
public readonly defaultTask: Task;
|
|
3558
|
+
```
|
|
3559
|
+
|
|
3560
|
+
- *Type:* projen.Task
|
|
3561
|
+
|
|
3562
|
+
This is the "default" task, the one that executes "projen".
|
|
3563
|
+
|
|
3564
|
+
Undefined if
|
|
3565
|
+
the project is being ejected.
|
|
3566
|
+
|
|
3567
|
+
---
|
|
3568
|
+
|
|
3569
|
+
##### `initProject`<sup>Optional</sup> <a name="initProject" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.initProject"></a>
|
|
3570
|
+
|
|
3571
|
+
```typescript
|
|
3572
|
+
public readonly initProject: InitProject;
|
|
3573
|
+
```
|
|
3574
|
+
|
|
3575
|
+
- *Type:* projen.InitProject
|
|
3576
|
+
|
|
3577
|
+
The options used when this project is bootstrapped via `projen new`.
|
|
3578
|
+
|
|
3579
|
+
It
|
|
3580
|
+
includes the original set of options passed to the CLI and also the JSII
|
|
3581
|
+
FQN of the project type.
|
|
3582
|
+
|
|
3583
|
+
---
|
|
3584
|
+
|
|
3585
|
+
##### `parent`<sup>Optional</sup> <a name="parent" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.parent"></a>
|
|
3586
|
+
|
|
3587
|
+
```typescript
|
|
3588
|
+
public readonly parent: Project;
|
|
3589
|
+
```
|
|
3590
|
+
|
|
3591
|
+
- *Type:* projen.Project
|
|
3592
|
+
|
|
3593
|
+
A parent project.
|
|
3594
|
+
|
|
3595
|
+
If undefined, this is the root project.
|
|
3596
|
+
|
|
3597
|
+
---
|
|
3598
|
+
|
|
3599
|
+
##### `projectType`<sup>Required</sup> <a name="projectType" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.projectType"></a>
|
|
3600
|
+
|
|
3601
|
+
```typescript
|
|
3602
|
+
public readonly projectType: ProjectType;
|
|
3603
|
+
```
|
|
3604
|
+
|
|
3605
|
+
- *Type:* projen.ProjectType
|
|
3606
|
+
|
|
3607
|
+
---
|
|
3608
|
+
|
|
3609
|
+
##### `autoApprove`<sup>Optional</sup> <a name="autoApprove" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.autoApprove"></a>
|
|
3610
|
+
|
|
3611
|
+
```typescript
|
|
3612
|
+
public readonly autoApprove: AutoApprove;
|
|
3613
|
+
```
|
|
3614
|
+
|
|
3615
|
+
- *Type:* projen.github.AutoApprove
|
|
3616
|
+
|
|
3617
|
+
Auto approve set up for this project.
|
|
3618
|
+
|
|
3619
|
+
---
|
|
3620
|
+
|
|
3621
|
+
##### `devContainer`<sup>Optional</sup> <a name="devContainer" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.devContainer"></a>
|
|
3622
|
+
|
|
3623
|
+
```typescript
|
|
3624
|
+
public readonly devContainer: DevContainer;
|
|
3625
|
+
```
|
|
3626
|
+
|
|
3627
|
+
- *Type:* projen.vscode.DevContainer
|
|
3628
|
+
|
|
3629
|
+
Access for .devcontainer.json (used for GitHub Codespaces).
|
|
3630
|
+
|
|
3631
|
+
This will be `undefined` if devContainer boolean is false
|
|
3632
|
+
|
|
3633
|
+
---
|
|
3634
|
+
|
|
3635
|
+
##### `github`<sup>Optional</sup> <a name="github" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.github"></a>
|
|
3636
|
+
|
|
3637
|
+
```typescript
|
|
3638
|
+
public readonly github: GitHub;
|
|
3639
|
+
```
|
|
3640
|
+
|
|
3641
|
+
- *Type:* projen.github.GitHub
|
|
3642
|
+
|
|
3643
|
+
Access all github components.
|
|
3644
|
+
|
|
3645
|
+
This will be `undefined` for subprojects.
|
|
3646
|
+
|
|
3647
|
+
---
|
|
3648
|
+
|
|
3649
|
+
##### `gitpod`<sup>Optional</sup> <a name="gitpod" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.gitpod"></a>
|
|
3650
|
+
|
|
3651
|
+
```typescript
|
|
3652
|
+
public readonly gitpod: Gitpod;
|
|
3653
|
+
```
|
|
3654
|
+
|
|
3655
|
+
- *Type:* projen.Gitpod
|
|
3656
|
+
|
|
3657
|
+
Access for Gitpod.
|
|
3658
|
+
|
|
3659
|
+
This will be `undefined` if gitpod boolean is false
|
|
3660
|
+
|
|
3661
|
+
---
|
|
3662
|
+
|
|
3663
|
+
##### `vscode`<sup>Optional</sup> <a name="vscode" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.vscode"></a>
|
|
3664
|
+
|
|
3665
|
+
```typescript
|
|
3666
|
+
public readonly vscode: VsCode;
|
|
3667
|
+
```
|
|
3668
|
+
|
|
3669
|
+
- *Type:* projen.vscode.VsCode
|
|
3670
|
+
|
|
3671
|
+
Access all VSCode components.
|
|
3672
|
+
|
|
3673
|
+
This will be `undefined` for subprojects.
|
|
3674
|
+
|
|
3675
|
+
---
|
|
3676
|
+
|
|
3677
|
+
##### ~~`allowLibraryDependencies`~~<sup>Required</sup> <a name="allowLibraryDependencies" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.allowLibraryDependencies"></a>
|
|
3678
|
+
|
|
3679
|
+
- *Deprecated:* use `package.allowLibraryDependencies`
|
|
3680
|
+
|
|
3681
|
+
```typescript
|
|
3682
|
+
public readonly allowLibraryDependencies: boolean;
|
|
3683
|
+
```
|
|
3684
|
+
|
|
3685
|
+
- *Type:* boolean
|
|
3686
|
+
|
|
3687
|
+
---
|
|
3688
|
+
|
|
3689
|
+
##### `artifactsDirectory`<sup>Required</sup> <a name="artifactsDirectory" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.artifactsDirectory"></a>
|
|
3690
|
+
|
|
3691
|
+
```typescript
|
|
3692
|
+
public readonly artifactsDirectory: string;
|
|
3693
|
+
```
|
|
3694
|
+
|
|
3695
|
+
- *Type:* string
|
|
3696
|
+
|
|
3697
|
+
The build output directory.
|
|
3698
|
+
|
|
3699
|
+
An npm tarball will be created under the `js`
|
|
3700
|
+
subdirectory. For example, if this is set to `dist` (the default), the npm
|
|
3701
|
+
tarball will be placed under `dist/js/boom-boom-1.2.3.tg`.
|
|
3702
|
+
|
|
3703
|
+
---
|
|
3704
|
+
|
|
3705
|
+
##### `artifactsJavascriptDirectory`<sup>Required</sup> <a name="artifactsJavascriptDirectory" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.artifactsJavascriptDirectory"></a>
|
|
3706
|
+
|
|
3707
|
+
```typescript
|
|
3708
|
+
public readonly artifactsJavascriptDirectory: string;
|
|
3709
|
+
```
|
|
3710
|
+
|
|
3711
|
+
- *Type:* string
|
|
3712
|
+
|
|
3713
|
+
The location of the npm tarball after build (`${artifactsDirectory}/js`).
|
|
3714
|
+
|
|
3715
|
+
---
|
|
3716
|
+
|
|
3717
|
+
##### `bundler`<sup>Required</sup> <a name="bundler" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.bundler"></a>
|
|
3718
|
+
|
|
3719
|
+
```typescript
|
|
3720
|
+
public readonly bundler: Bundler;
|
|
3721
|
+
```
|
|
3722
|
+
|
|
3723
|
+
- *Type:* projen.javascript.Bundler
|
|
3724
|
+
|
|
3725
|
+
---
|
|
3726
|
+
|
|
3727
|
+
##### ~~`entrypoint`~~<sup>Required</sup> <a name="entrypoint" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.entrypoint"></a>
|
|
3728
|
+
|
|
3729
|
+
- *Deprecated:* use `package.entrypoint`
|
|
3730
|
+
|
|
3731
|
+
```typescript
|
|
3732
|
+
public readonly entrypoint: string;
|
|
3733
|
+
```
|
|
3734
|
+
|
|
3735
|
+
- *Type:* string
|
|
3736
|
+
|
|
3737
|
+
---
|
|
3738
|
+
|
|
3739
|
+
##### ~~`manifest`~~<sup>Required</sup> <a name="manifest" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.manifest"></a>
|
|
3740
|
+
|
|
3741
|
+
- *Deprecated:* use `package.addField(x, y)`
|
|
3742
|
+
|
|
3743
|
+
```typescript
|
|
3744
|
+
public readonly manifest: any;
|
|
3745
|
+
```
|
|
3746
|
+
|
|
3747
|
+
- *Type:* any
|
|
3748
|
+
|
|
3749
|
+
---
|
|
3750
|
+
|
|
3751
|
+
##### `package`<sup>Required</sup> <a name="package" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.package"></a>
|
|
3752
|
+
|
|
3753
|
+
```typescript
|
|
3754
|
+
public readonly package: NodePackage;
|
|
3755
|
+
```
|
|
3756
|
+
|
|
3757
|
+
- *Type:* projen.javascript.NodePackage
|
|
3758
|
+
|
|
3759
|
+
API for managing the node package.
|
|
3760
|
+
|
|
3761
|
+
---
|
|
3762
|
+
|
|
3763
|
+
##### ~~`packageManager`~~<sup>Required</sup> <a name="packageManager" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.packageManager"></a>
|
|
3764
|
+
|
|
3765
|
+
- *Deprecated:* use `package.packageManager`
|
|
3766
|
+
|
|
3767
|
+
```typescript
|
|
3768
|
+
public readonly packageManager: NodePackageManager;
|
|
3769
|
+
```
|
|
3770
|
+
|
|
3771
|
+
- *Type:* projen.javascript.NodePackageManager
|
|
3772
|
+
|
|
3773
|
+
The package manager to use.
|
|
3774
|
+
|
|
3775
|
+
---
|
|
3776
|
+
|
|
3777
|
+
##### `runScriptCommand`<sup>Required</sup> <a name="runScriptCommand" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.runScriptCommand"></a>
|
|
3778
|
+
|
|
3779
|
+
```typescript
|
|
3780
|
+
public readonly runScriptCommand: string;
|
|
3781
|
+
```
|
|
3782
|
+
|
|
3783
|
+
- *Type:* string
|
|
3784
|
+
|
|
3785
|
+
The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager).
|
|
3786
|
+
|
|
3787
|
+
---
|
|
3788
|
+
|
|
3789
|
+
##### `autoMerge`<sup>Optional</sup> <a name="autoMerge" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.autoMerge"></a>
|
|
3790
|
+
|
|
3791
|
+
```typescript
|
|
3792
|
+
public readonly autoMerge: AutoMerge;
|
|
3793
|
+
```
|
|
3794
|
+
|
|
3795
|
+
- *Type:* projen.github.AutoMerge
|
|
3796
|
+
|
|
3797
|
+
Component that sets up mergify for merging approved pull requests.
|
|
3798
|
+
|
|
3799
|
+
---
|
|
3800
|
+
|
|
3801
|
+
##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.buildWorkflow"></a>
|
|
3802
|
+
|
|
3803
|
+
```typescript
|
|
3804
|
+
public readonly buildWorkflow: BuildWorkflow;
|
|
3805
|
+
```
|
|
3806
|
+
|
|
3807
|
+
- *Type:* projen.build.BuildWorkflow
|
|
3808
|
+
|
|
3809
|
+
The PR build GitHub workflow.
|
|
3810
|
+
|
|
3811
|
+
`undefined` if `buildWorkflow` is disabled.
|
|
3812
|
+
|
|
3813
|
+
---
|
|
3814
|
+
|
|
3815
|
+
##### `buildWorkflowJobId`<sup>Optional</sup> <a name="buildWorkflowJobId" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.buildWorkflowJobId"></a>
|
|
3816
|
+
|
|
3817
|
+
```typescript
|
|
3818
|
+
public readonly buildWorkflowJobId: string;
|
|
3819
|
+
```
|
|
3820
|
+
|
|
3821
|
+
- *Type:* string
|
|
3822
|
+
|
|
3823
|
+
The job ID of the build workflow.
|
|
3824
|
+
|
|
3825
|
+
---
|
|
3826
|
+
|
|
3827
|
+
##### `jest`<sup>Optional</sup> <a name="jest" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.jest"></a>
|
|
3828
|
+
|
|
3829
|
+
```typescript
|
|
3830
|
+
public readonly jest: Jest;
|
|
3831
|
+
```
|
|
3832
|
+
|
|
3833
|
+
- *Type:* projen.javascript.Jest
|
|
3834
|
+
|
|
3835
|
+
The Jest configuration (if enabled).
|
|
3836
|
+
|
|
3837
|
+
---
|
|
3838
|
+
|
|
3839
|
+
##### `maxNodeVersion`<sup>Optional</sup> <a name="maxNodeVersion" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.maxNodeVersion"></a>
|
|
3840
|
+
|
|
3841
|
+
```typescript
|
|
3842
|
+
public readonly maxNodeVersion: string;
|
|
3843
|
+
```
|
|
3844
|
+
|
|
3845
|
+
- *Type:* string
|
|
3846
|
+
|
|
3847
|
+
Maximum node version required by this package.
|
|
3848
|
+
|
|
3849
|
+
---
|
|
3850
|
+
|
|
3851
|
+
##### `minNodeVersion`<sup>Optional</sup> <a name="minNodeVersion" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.minNodeVersion"></a>
|
|
3852
|
+
|
|
3853
|
+
```typescript
|
|
3854
|
+
public readonly minNodeVersion: string;
|
|
3855
|
+
```
|
|
3856
|
+
|
|
3857
|
+
- *Type:* string
|
|
3858
|
+
|
|
3859
|
+
Minimum node.js version required by this package.
|
|
3860
|
+
|
|
3861
|
+
---
|
|
3862
|
+
|
|
3863
|
+
##### `npmignore`<sup>Optional</sup> <a name="npmignore" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.npmignore"></a>
|
|
3864
|
+
|
|
3865
|
+
```typescript
|
|
3866
|
+
public readonly npmignore: IgnoreFile;
|
|
3867
|
+
```
|
|
3868
|
+
|
|
3869
|
+
- *Type:* projen.IgnoreFile
|
|
3870
|
+
|
|
3871
|
+
The .npmignore file.
|
|
3872
|
+
|
|
3873
|
+
---
|
|
3874
|
+
|
|
3875
|
+
##### `prettier`<sup>Optional</sup> <a name="prettier" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.prettier"></a>
|
|
3876
|
+
|
|
3877
|
+
```typescript
|
|
3878
|
+
public readonly prettier: Prettier;
|
|
3879
|
+
```
|
|
3880
|
+
|
|
3881
|
+
- *Type:* projen.javascript.Prettier
|
|
3882
|
+
|
|
3883
|
+
---
|
|
3884
|
+
|
|
3885
|
+
##### ~~`publisher`~~<sup>Optional</sup> <a name="publisher" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.publisher"></a>
|
|
3886
|
+
|
|
3887
|
+
- *Deprecated:* use `release.publisher`.
|
|
3888
|
+
|
|
3889
|
+
```typescript
|
|
3890
|
+
public readonly publisher: Publisher;
|
|
3891
|
+
```
|
|
3892
|
+
|
|
3893
|
+
- *Type:* projen.release.Publisher
|
|
3894
|
+
|
|
3895
|
+
Package publisher.
|
|
3896
|
+
|
|
3897
|
+
This will be `undefined` if the project does not have a
|
|
3898
|
+
release workflow.
|
|
3899
|
+
|
|
3900
|
+
---
|
|
3901
|
+
|
|
3902
|
+
##### `release`<sup>Optional</sup> <a name="release" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.release"></a>
|
|
3903
|
+
|
|
3904
|
+
```typescript
|
|
3905
|
+
public readonly release: Release;
|
|
3906
|
+
```
|
|
3907
|
+
|
|
3908
|
+
- *Type:* projen.release.Release
|
|
3909
|
+
|
|
3910
|
+
Release management.
|
|
3911
|
+
|
|
3912
|
+
---
|
|
3913
|
+
|
|
3914
|
+
##### `upgradeWorkflow`<sup>Optional</sup> <a name="upgradeWorkflow" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.upgradeWorkflow"></a>
|
|
3915
|
+
|
|
3916
|
+
```typescript
|
|
3917
|
+
public readonly upgradeWorkflow: UpgradeDependencies;
|
|
3918
|
+
```
|
|
3919
|
+
|
|
3920
|
+
- *Type:* projen.javascript.UpgradeDependencies
|
|
3921
|
+
|
|
3922
|
+
The upgrade workflow.
|
|
3923
|
+
|
|
3924
|
+
---
|
|
3925
|
+
|
|
3926
|
+
##### `docsDirectory`<sup>Required</sup> <a name="docsDirectory" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.docsDirectory"></a>
|
|
3927
|
+
|
|
3928
|
+
```typescript
|
|
3929
|
+
public readonly docsDirectory: string;
|
|
3930
|
+
```
|
|
3931
|
+
|
|
3932
|
+
- *Type:* string
|
|
3933
|
+
|
|
3934
|
+
---
|
|
3935
|
+
|
|
3936
|
+
##### `libdir`<sup>Required</sup> <a name="libdir" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.libdir"></a>
|
|
3937
|
+
|
|
3938
|
+
```typescript
|
|
3939
|
+
public readonly libdir: string;
|
|
3940
|
+
```
|
|
3941
|
+
|
|
3942
|
+
- *Type:* string
|
|
3943
|
+
|
|
3944
|
+
The directory in which compiled .js files reside.
|
|
3945
|
+
|
|
3946
|
+
---
|
|
3947
|
+
|
|
3948
|
+
##### `srcdir`<sup>Required</sup> <a name="srcdir" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.srcdir"></a>
|
|
3949
|
+
|
|
3950
|
+
```typescript
|
|
3951
|
+
public readonly srcdir: string;
|
|
3952
|
+
```
|
|
3953
|
+
|
|
3954
|
+
- *Type:* string
|
|
3955
|
+
|
|
3956
|
+
The directory in which the .ts sources reside.
|
|
3957
|
+
|
|
3958
|
+
---
|
|
3959
|
+
|
|
3960
|
+
##### `testdir`<sup>Required</sup> <a name="testdir" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.testdir"></a>
|
|
3961
|
+
|
|
3962
|
+
```typescript
|
|
3963
|
+
public readonly testdir: string;
|
|
3964
|
+
```
|
|
3965
|
+
|
|
3966
|
+
- *Type:* string
|
|
3967
|
+
|
|
3968
|
+
The directory in which tests reside.
|
|
3969
|
+
|
|
3970
|
+
---
|
|
3971
|
+
|
|
3972
|
+
##### `tsconfigDev`<sup>Required</sup> <a name="tsconfigDev" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.tsconfigDev"></a>
|
|
3973
|
+
|
|
3974
|
+
```typescript
|
|
3975
|
+
public readonly tsconfigDev: TypescriptConfig;
|
|
3976
|
+
```
|
|
3977
|
+
|
|
3978
|
+
- *Type:* projen.javascript.TypescriptConfig
|
|
3979
|
+
|
|
3980
|
+
A typescript configuration file which covers all files (sources, tests, projen).
|
|
3981
|
+
|
|
3982
|
+
---
|
|
3983
|
+
|
|
3984
|
+
##### `watchTask`<sup>Required</sup> <a name="watchTask" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.watchTask"></a>
|
|
3985
|
+
|
|
3986
|
+
```typescript
|
|
3987
|
+
public readonly watchTask: Task;
|
|
3988
|
+
```
|
|
3989
|
+
|
|
3990
|
+
- *Type:* projen.Task
|
|
3991
|
+
|
|
3992
|
+
The "watch" task.
|
|
3993
|
+
|
|
3994
|
+
---
|
|
3995
|
+
|
|
3996
|
+
##### `docgen`<sup>Optional</sup> <a name="docgen" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.docgen"></a>
|
|
3997
|
+
|
|
3998
|
+
```typescript
|
|
3999
|
+
public readonly docgen: boolean;
|
|
4000
|
+
```
|
|
4001
|
+
|
|
4002
|
+
- *Type:* boolean
|
|
4003
|
+
|
|
4004
|
+
---
|
|
4005
|
+
|
|
4006
|
+
##### `eslint`<sup>Optional</sup> <a name="eslint" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.eslint"></a>
|
|
4007
|
+
|
|
4008
|
+
```typescript
|
|
4009
|
+
public readonly eslint: Eslint;
|
|
4010
|
+
```
|
|
4011
|
+
|
|
4012
|
+
- *Type:* projen.javascript.Eslint
|
|
4013
|
+
|
|
4014
|
+
---
|
|
4015
|
+
|
|
4016
|
+
##### `tsconfig`<sup>Optional</sup> <a name="tsconfig" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.tsconfig"></a>
|
|
4017
|
+
|
|
4018
|
+
```typescript
|
|
4019
|
+
public readonly tsconfig: TypescriptConfig;
|
|
4020
|
+
```
|
|
4021
|
+
|
|
4022
|
+
- *Type:* projen.javascript.TypescriptConfig
|
|
4023
|
+
|
|
4024
|
+
---
|
|
4025
|
+
|
|
4026
|
+
##### `tsconfigEslint`<sup>Optional</sup> <a name="tsconfigEslint" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.tsconfigEslint"></a>
|
|
4027
|
+
|
|
4028
|
+
```typescript
|
|
4029
|
+
public readonly tsconfigEslint: TypescriptConfig;
|
|
4030
|
+
```
|
|
4031
|
+
|
|
4032
|
+
- *Type:* projen.javascript.TypescriptConfig
|
|
4033
|
+
|
|
4034
|
+
---
|
|
4035
|
+
|
|
4036
|
+
##### `appEntrypoint`<sup>Required</sup> <a name="appEntrypoint" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.appEntrypoint"></a>
|
|
4037
|
+
|
|
4038
|
+
```typescript
|
|
4039
|
+
public readonly appEntrypoint: string;
|
|
4040
|
+
```
|
|
4041
|
+
|
|
4042
|
+
- *Type:* string
|
|
4043
|
+
|
|
4044
|
+
The CDK app entrypoint.
|
|
4045
|
+
|
|
4046
|
+
---
|
|
4047
|
+
|
|
4048
|
+
##### `cdkConfig`<sup>Required</sup> <a name="cdkConfig" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.cdkConfig"></a>
|
|
4049
|
+
|
|
4050
|
+
```typescript
|
|
4051
|
+
public readonly cdkConfig: CdkConfig;
|
|
4052
|
+
```
|
|
4053
|
+
|
|
4054
|
+
- *Type:* projen.awscdk.CdkConfig
|
|
4055
|
+
|
|
4056
|
+
cdk.json configuration.
|
|
4057
|
+
|
|
4058
|
+
---
|
|
4059
|
+
|
|
4060
|
+
##### `cdkDeps`<sup>Required</sup> <a name="cdkDeps" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.cdkDeps"></a>
|
|
4061
|
+
|
|
4062
|
+
```typescript
|
|
4063
|
+
public readonly cdkDeps: AwsCdkDeps;
|
|
4064
|
+
```
|
|
4065
|
+
|
|
4066
|
+
- *Type:* projen.awscdk.AwsCdkDeps
|
|
4067
|
+
|
|
4068
|
+
---
|
|
4069
|
+
|
|
4070
|
+
##### `cdkTasks`<sup>Required</sup> <a name="cdkTasks" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.cdkTasks"></a>
|
|
4071
|
+
|
|
4072
|
+
```typescript
|
|
4073
|
+
public readonly cdkTasks: CdkTasks;
|
|
4074
|
+
```
|
|
4075
|
+
|
|
4076
|
+
- *Type:* projen.awscdk.CdkTasks
|
|
4077
|
+
|
|
4078
|
+
Common CDK tasks.
|
|
4079
|
+
|
|
4080
|
+
---
|
|
4081
|
+
|
|
4082
|
+
##### `cdkVersion`<sup>Required</sup> <a name="cdkVersion" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.cdkVersion"></a>
|
|
4083
|
+
|
|
4084
|
+
```typescript
|
|
4085
|
+
public readonly cdkVersion: string;
|
|
4086
|
+
```
|
|
4087
|
+
|
|
4088
|
+
- *Type:* string
|
|
4089
|
+
|
|
4090
|
+
The CDK version this app is using.
|
|
4091
|
+
|
|
4092
|
+
---
|
|
4093
|
+
|
|
4094
|
+
##### `deployWorkflowTask`<sup>Required</sup> <a name="deployWorkflowTask" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.deployWorkflowTask"></a>
|
|
4095
|
+
|
|
4096
|
+
```typescript
|
|
4097
|
+
public readonly deployWorkflowTask: Task;
|
|
4098
|
+
```
|
|
4099
|
+
|
|
4100
|
+
- *Type:* projen.Task
|
|
4101
|
+
|
|
4102
|
+
Task to deploy your app.
|
|
4103
|
+
|
|
4104
|
+
---
|
|
4105
|
+
|
|
4106
|
+
#### Constants <a name="Constants" id="Constants"></a>
|
|
4107
|
+
|
|
4108
|
+
| **Name** | **Type** | **Description** |
|
|
4109
|
+
| --- | --- | --- |
|
|
4110
|
+
| <code><a href="#deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.DEFAULT_TASK">DEFAULT_TASK</a></code> | <code>string</code> | The name of the default task (the task executed when `projen` is run without arguments). |
|
|
4111
|
+
|
|
4112
|
+
---
|
|
4113
|
+
|
|
4114
|
+
##### `DEFAULT_TASK`<sup>Required</sup> <a name="DEFAULT_TASK" id="deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp.property.DEFAULT_TASK"></a>
|
|
4115
|
+
|
|
4116
|
+
```typescript
|
|
4117
|
+
public readonly DEFAULT_TASK: string;
|
|
4118
|
+
```
|
|
4119
|
+
|
|
4120
|
+
- *Type:* string
|
|
4121
|
+
|
|
4122
|
+
The name of the default task (the task executed when `projen` is run without arguments).
|
|
4123
|
+
|
|
4124
|
+
Normally
|
|
4125
|
+
this task should synthesize the project files.
|
|
4126
|
+
|
|
4127
|
+
---
|
|
2621
4128
|
|
|
2622
4129
|
|