cdklabs-projen-project-types 0.6.5 → 0.6.6
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 +566 -445
- package/API.md +311 -0
- package/lib/cdk-common-options.d.ts +5 -0
- package/lib/cdk-common-options.js +1 -1
- package/lib/cdk-construct-library-options.d.ts +5 -0
- package/lib/cdk-construct-library-options.js +1 -1
- package/lib/cdk-jsii-options.d.ts +5 -0
- package/lib/cdk-jsii-options.js +1 -1
- package/lib/cdk.js +2 -2
- package/lib/cdklabs.js +3 -3
- package/lib/check-gha-expressions.d.ts +15 -0
- package/lib/check-gha-expressions.js +65 -0
- package/lib/common-options.js +6 -1
- package/lib/index.d.ts +1 -0
- package/lib/index.js +2 -1
- package/lib/jsii.js +1 -1
- package/lib/rosetta.js +1 -1
- package/lib/yarn/constraints.js +1 -1
- package/lib/yarn/jsii-build.js +1 -1
- package/lib/yarn/monorepo-options.d.ts +5 -0
- package/lib/yarn/monorepo-options.js +1 -1
- package/lib/yarn/monorepo-release.js +1 -1
- package/lib/yarn/monorepo.js +7 -3
- package/lib/yarn/typescript-workspace-release.js +1 -1
- package/lib/yarn/typescript-workspace.js +1 -1
- package/package.json +1 -1
package/API.md
CHANGED
|
@@ -9906,6 +9906,191 @@ public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string;
|
|
|
9906
9906
|
|
|
9907
9907
|
---
|
|
9908
9908
|
|
|
9909
|
+
### CheckGhaExpressions <a name="CheckGhaExpressions" id="cdklabs-projen-project-types.CheckGhaExpressions"></a>
|
|
9910
|
+
|
|
9911
|
+
Check GitHub Actions workflows for the use of dangerous expressions directly interpolated in shell steps.
|
|
9912
|
+
|
|
9913
|
+
Some of these can be used to perform command injection attacks. We block all of them to be overly safe,
|
|
9914
|
+
even the ones that are not dangerous.
|
|
9915
|
+
|
|
9916
|
+
Automatically added to all of our project types.
|
|
9917
|
+
|
|
9918
|
+
#### Initializers <a name="Initializers" id="cdklabs-projen-project-types.CheckGhaExpressions.Initializer"></a>
|
|
9919
|
+
|
|
9920
|
+
```typescript
|
|
9921
|
+
import { CheckGhaExpressions } from 'cdklabs-projen-project-types'
|
|
9922
|
+
|
|
9923
|
+
new CheckGhaExpressions(project: IConstruct)
|
|
9924
|
+
```
|
|
9925
|
+
|
|
9926
|
+
| **Name** | **Type** | **Description** |
|
|
9927
|
+
| --- | --- | --- |
|
|
9928
|
+
| <code><a href="#cdklabs-projen-project-types.CheckGhaExpressions.Initializer.parameter.project">project</a></code> | <code>constructs.IConstruct</code> | *No description.* |
|
|
9929
|
+
|
|
9930
|
+
---
|
|
9931
|
+
|
|
9932
|
+
##### `project`<sup>Required</sup> <a name="project" id="cdklabs-projen-project-types.CheckGhaExpressions.Initializer.parameter.project"></a>
|
|
9933
|
+
|
|
9934
|
+
- *Type:* constructs.IConstruct
|
|
9935
|
+
|
|
9936
|
+
---
|
|
9937
|
+
|
|
9938
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
9939
|
+
|
|
9940
|
+
| **Name** | **Description** |
|
|
9941
|
+
| --- | --- |
|
|
9942
|
+
| <code><a href="#cdklabs-projen-project-types.CheckGhaExpressions.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
9943
|
+
| <code><a href="#cdklabs-projen-project-types.CheckGhaExpressions.with">with</a></code> | Applies one or more mixins to this construct. |
|
|
9944
|
+
| <code><a href="#cdklabs-projen-project-types.CheckGhaExpressions.postSynthesize">postSynthesize</a></code> | Called after synthesis. |
|
|
9945
|
+
| <code><a href="#cdklabs-projen-project-types.CheckGhaExpressions.preSynthesize">preSynthesize</a></code> | Called before synthesis. |
|
|
9946
|
+
| <code><a href="#cdklabs-projen-project-types.CheckGhaExpressions.synthesize">synthesize</a></code> | Synthesizes files to the project output directory. |
|
|
9947
|
+
|
|
9948
|
+
---
|
|
9949
|
+
|
|
9950
|
+
##### `toString` <a name="toString" id="cdklabs-projen-project-types.CheckGhaExpressions.toString"></a>
|
|
9951
|
+
|
|
9952
|
+
```typescript
|
|
9953
|
+
public toString(): string
|
|
9954
|
+
```
|
|
9955
|
+
|
|
9956
|
+
Returns a string representation of this construct.
|
|
9957
|
+
|
|
9958
|
+
##### `with` <a name="with" id="cdklabs-projen-project-types.CheckGhaExpressions.with"></a>
|
|
9959
|
+
|
|
9960
|
+
```typescript
|
|
9961
|
+
public with(mixins: ...IMixin[]): IConstruct
|
|
9962
|
+
```
|
|
9963
|
+
|
|
9964
|
+
Applies one or more mixins to this construct.
|
|
9965
|
+
|
|
9966
|
+
Mixins are applied in order. The list of constructs is captured at the
|
|
9967
|
+
start of the call, so constructs added by a mixin will not be visited.
|
|
9968
|
+
Use multiple `with()` calls if subsequent mixins should apply to added
|
|
9969
|
+
constructs.
|
|
9970
|
+
|
|
9971
|
+
###### `mixins`<sup>Required</sup> <a name="mixins" id="cdklabs-projen-project-types.CheckGhaExpressions.with.parameter.mixins"></a>
|
|
9972
|
+
|
|
9973
|
+
- *Type:* ...constructs.IMixin[]
|
|
9974
|
+
|
|
9975
|
+
The mixins to apply.
|
|
9976
|
+
|
|
9977
|
+
---
|
|
9978
|
+
|
|
9979
|
+
##### `postSynthesize` <a name="postSynthesize" id="cdklabs-projen-project-types.CheckGhaExpressions.postSynthesize"></a>
|
|
9980
|
+
|
|
9981
|
+
```typescript
|
|
9982
|
+
public postSynthesize(): void
|
|
9983
|
+
```
|
|
9984
|
+
|
|
9985
|
+
Called after synthesis.
|
|
9986
|
+
|
|
9987
|
+
Order is *not* guaranteed.
|
|
9988
|
+
|
|
9989
|
+
##### `preSynthesize` <a name="preSynthesize" id="cdklabs-projen-project-types.CheckGhaExpressions.preSynthesize"></a>
|
|
9990
|
+
|
|
9991
|
+
```typescript
|
|
9992
|
+
public preSynthesize(): void
|
|
9993
|
+
```
|
|
9994
|
+
|
|
9995
|
+
Called before synthesis.
|
|
9996
|
+
|
|
9997
|
+
##### `synthesize` <a name="synthesize" id="cdklabs-projen-project-types.CheckGhaExpressions.synthesize"></a>
|
|
9998
|
+
|
|
9999
|
+
```typescript
|
|
10000
|
+
public synthesize(): void
|
|
10001
|
+
```
|
|
10002
|
+
|
|
10003
|
+
Synthesizes files to the project output directory.
|
|
10004
|
+
|
|
10005
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
10006
|
+
|
|
10007
|
+
| **Name** | **Description** |
|
|
10008
|
+
| --- | --- |
|
|
10009
|
+
| <code><a href="#cdklabs-projen-project-types.CheckGhaExpressions.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
10010
|
+
| <code><a href="#cdklabs-projen-project-types.CheckGhaExpressions.isComponent">isComponent</a></code> | Test whether the given construct is a component. |
|
|
10011
|
+
|
|
10012
|
+
---
|
|
10013
|
+
|
|
10014
|
+
##### `isConstruct` <a name="isConstruct" id="cdklabs-projen-project-types.CheckGhaExpressions.isConstruct"></a>
|
|
10015
|
+
|
|
10016
|
+
```typescript
|
|
10017
|
+
import { CheckGhaExpressions } from 'cdklabs-projen-project-types'
|
|
10018
|
+
|
|
10019
|
+
CheckGhaExpressions.isConstruct(x: any)
|
|
10020
|
+
```
|
|
10021
|
+
|
|
10022
|
+
Checks if `x` is a construct.
|
|
10023
|
+
|
|
10024
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
10025
|
+
instances, even when the construct library is symlinked.
|
|
10026
|
+
|
|
10027
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
10028
|
+
disk are seen as independent, completely different libraries. As a
|
|
10029
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
10030
|
+
is seen as a different class, and an instance of one class will not test as
|
|
10031
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
10032
|
+
like this, but users may manually symlink construct libraries together or
|
|
10033
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
10034
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
10035
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
10036
|
+
this type-testing method instead.
|
|
10037
|
+
|
|
10038
|
+
###### `x`<sup>Required</sup> <a name="x" id="cdklabs-projen-project-types.CheckGhaExpressions.isConstruct.parameter.x"></a>
|
|
10039
|
+
|
|
10040
|
+
- *Type:* any
|
|
10041
|
+
|
|
10042
|
+
Any object.
|
|
10043
|
+
|
|
10044
|
+
---
|
|
10045
|
+
|
|
10046
|
+
##### `isComponent` <a name="isComponent" id="cdklabs-projen-project-types.CheckGhaExpressions.isComponent"></a>
|
|
10047
|
+
|
|
10048
|
+
```typescript
|
|
10049
|
+
import { CheckGhaExpressions } from 'cdklabs-projen-project-types'
|
|
10050
|
+
|
|
10051
|
+
CheckGhaExpressions.isComponent(x: any)
|
|
10052
|
+
```
|
|
10053
|
+
|
|
10054
|
+
Test whether the given construct is a component.
|
|
10055
|
+
|
|
10056
|
+
###### `x`<sup>Required</sup> <a name="x" id="cdklabs-projen-project-types.CheckGhaExpressions.isComponent.parameter.x"></a>
|
|
10057
|
+
|
|
10058
|
+
- *Type:* any
|
|
10059
|
+
|
|
10060
|
+
---
|
|
10061
|
+
|
|
10062
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
10063
|
+
|
|
10064
|
+
| **Name** | **Type** | **Description** |
|
|
10065
|
+
| --- | --- | --- |
|
|
10066
|
+
| <code><a href="#cdklabs-projen-project-types.CheckGhaExpressions.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
10067
|
+
| <code><a href="#cdklabs-projen-project-types.CheckGhaExpressions.property.project">project</a></code> | <code>projen.Project</code> | *No description.* |
|
|
10068
|
+
|
|
10069
|
+
---
|
|
10070
|
+
|
|
10071
|
+
##### `node`<sup>Required</sup> <a name="node" id="cdklabs-projen-project-types.CheckGhaExpressions.property.node"></a>
|
|
10072
|
+
|
|
10073
|
+
```typescript
|
|
10074
|
+
public readonly node: Node;
|
|
10075
|
+
```
|
|
10076
|
+
|
|
10077
|
+
- *Type:* constructs.Node
|
|
10078
|
+
|
|
10079
|
+
The tree node.
|
|
10080
|
+
|
|
10081
|
+
---
|
|
10082
|
+
|
|
10083
|
+
##### `project`<sup>Required</sup> <a name="project" id="cdklabs-projen-project-types.CheckGhaExpressions.property.project"></a>
|
|
10084
|
+
|
|
10085
|
+
```typescript
|
|
10086
|
+
public readonly project: Project;
|
|
10087
|
+
```
|
|
10088
|
+
|
|
10089
|
+
- *Type:* projen.Project
|
|
10090
|
+
|
|
10091
|
+
---
|
|
10092
|
+
|
|
10093
|
+
|
|
9909
10094
|
### Constraints <a name="Constraints" id="cdklabs-projen-project-types.yarn.Constraints"></a>
|
|
9910
10095
|
|
|
9911
10096
|
#### Initializers <a name="Initializers" id="cdklabs-projen-project-types.yarn.Constraints.Initializer"></a>
|
|
@@ -13714,6 +13899,7 @@ const cdkCommonOptions: CdkCommonOptions = { ... }
|
|
|
13714
13899
|
|
|
13715
13900
|
| **Name** | **Type** | **Description** |
|
|
13716
13901
|
| --- | --- | --- |
|
|
13902
|
+
| <code><a href="#cdklabs-projen-project-types.CdkCommonOptions.property.checkGhaExpressions">checkGhaExpressions</a></code> | <code>boolean</code> | Enable GitHub Actions expressions validation. |
|
|
13717
13903
|
| <code><a href="#cdklabs-projen-project-types.CdkCommonOptions.property.enablePRAutoMerge">enablePRAutoMerge</a></code> | <code>boolean</code> | Whether to enable the auto merge workflow for PRs. |
|
|
13718
13904
|
| <code><a href="#cdklabs-projen-project-types.CdkCommonOptions.property.ghAutoMergeOptions">ghAutoMergeOptions</a></code> | <code>projen.github.AutoQueueOptions</code> | Options for the GitHub auto merge workflow. |
|
|
13719
13905
|
| <code><a href="#cdklabs-projen-project-types.CdkCommonOptions.property.private">private</a></code> | <code>boolean</code> | Whether or not this package is private. |
|
|
@@ -13724,6 +13910,19 @@ const cdkCommonOptions: CdkCommonOptions = { ... }
|
|
|
13724
13910
|
|
|
13725
13911
|
---
|
|
13726
13912
|
|
|
13913
|
+
##### `checkGhaExpressions`<sup>Optional</sup> <a name="checkGhaExpressions" id="cdklabs-projen-project-types.CdkCommonOptions.property.checkGhaExpressions"></a>
|
|
13914
|
+
|
|
13915
|
+
```typescript
|
|
13916
|
+
public readonly checkGhaExpressions: boolean;
|
|
13917
|
+
```
|
|
13918
|
+
|
|
13919
|
+
- *Type:* boolean
|
|
13920
|
+
- *Default:* true
|
|
13921
|
+
|
|
13922
|
+
Enable GitHub Actions expressions validation.
|
|
13923
|
+
|
|
13924
|
+
---
|
|
13925
|
+
|
|
13727
13926
|
##### `enablePRAutoMerge`<sup>Optional</sup> <a name="enablePRAutoMerge" id="cdklabs-projen-project-types.CdkCommonOptions.property.enablePRAutoMerge"></a>
|
|
13728
13927
|
|
|
13729
13928
|
```typescript
|
|
@@ -13869,6 +14068,7 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
|
|
|
13869
14068
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.catalog">catalog</a></code> | <code>projen.cdk.Catalog</code> | Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:. |
|
|
13870
14069
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.cdkCliVersion">cdkCliVersion</a></code> | <code>string</code> | Version range of the AWS CDK CLI to depend on. |
|
|
13871
14070
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.cdkVersionPinning">cdkVersionPinning</a></code> | <code>boolean</code> | Use pinned version instead of caret version for CDK. |
|
|
14071
|
+
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.checkGhaExpressions">checkGhaExpressions</a></code> | <code>boolean</code> | Enable GitHub Actions expressions validation. |
|
|
13872
14072
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
13873
14073
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
|
|
13874
14074
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
@@ -14477,6 +14677,19 @@ If you use experimental features this will let you define the moment you include
|
|
|
14477
14677
|
|
|
14478
14678
|
---
|
|
14479
14679
|
|
|
14680
|
+
##### `checkGhaExpressions`<sup>Optional</sup> <a name="checkGhaExpressions" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.checkGhaExpressions"></a>
|
|
14681
|
+
|
|
14682
|
+
```typescript
|
|
14683
|
+
public readonly checkGhaExpressions: boolean;
|
|
14684
|
+
```
|
|
14685
|
+
|
|
14686
|
+
- *Type:* boolean
|
|
14687
|
+
- *Default:* true
|
|
14688
|
+
|
|
14689
|
+
Enable GitHub Actions expressions validation.
|
|
14690
|
+
|
|
14691
|
+
---
|
|
14692
|
+
|
|
14480
14693
|
##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.checkLicenses"></a>
|
|
14481
14694
|
|
|
14482
14695
|
```typescript
|
|
@@ -16640,6 +16853,7 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
|
|
|
16640
16853
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
16641
16854
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
16642
16855
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
|
|
16856
|
+
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.checkGhaExpressions">checkGhaExpressions</a></code> | <code>boolean</code> | Enable GitHub Actions expressions validation. |
|
|
16643
16857
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
16644
16858
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
|
|
16645
16859
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
@@ -17171,6 +17385,19 @@ The version of Bun to use if using Bun as a package manager.
|
|
|
17171
17385
|
|
|
17172
17386
|
---
|
|
17173
17387
|
|
|
17388
|
+
##### `checkGhaExpressions`<sup>Optional</sup> <a name="checkGhaExpressions" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.checkGhaExpressions"></a>
|
|
17389
|
+
|
|
17390
|
+
```typescript
|
|
17391
|
+
public readonly checkGhaExpressions: boolean;
|
|
17392
|
+
```
|
|
17393
|
+
|
|
17394
|
+
- *Type:* boolean
|
|
17395
|
+
- *Default:* true
|
|
17396
|
+
|
|
17397
|
+
Enable GitHub Actions expressions validation.
|
|
17398
|
+
|
|
17399
|
+
---
|
|
17400
|
+
|
|
17174
17401
|
##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.checkLicenses"></a>
|
|
17175
17402
|
|
|
17176
17403
|
```typescript
|
|
@@ -19230,6 +19457,7 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
|
|
|
19230
19457
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.catalog">catalog</a></code> | <code>projen.cdk.Catalog</code> | Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:. |
|
|
19231
19458
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.cdkCliVersion">cdkCliVersion</a></code> | <code>string</code> | Version range of the AWS CDK CLI to depend on. |
|
|
19232
19459
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.cdkVersionPinning">cdkVersionPinning</a></code> | <code>boolean</code> | Use pinned version instead of caret version for CDK. |
|
|
19460
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.checkGhaExpressions">checkGhaExpressions</a></code> | <code>boolean</code> | Enable GitHub Actions expressions validation. |
|
|
19233
19461
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
19234
19462
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
|
|
19235
19463
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
@@ -19840,6 +20068,19 @@ If you use experimental features this will let you define the moment you include
|
|
|
19840
20068
|
|
|
19841
20069
|
---
|
|
19842
20070
|
|
|
20071
|
+
##### `checkGhaExpressions`<sup>Optional</sup> <a name="checkGhaExpressions" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.checkGhaExpressions"></a>
|
|
20072
|
+
|
|
20073
|
+
```typescript
|
|
20074
|
+
public readonly checkGhaExpressions: boolean;
|
|
20075
|
+
```
|
|
20076
|
+
|
|
20077
|
+
- *Type:* boolean
|
|
20078
|
+
- *Default:* true
|
|
20079
|
+
|
|
20080
|
+
Enable GitHub Actions expressions validation.
|
|
20081
|
+
|
|
20082
|
+
---
|
|
20083
|
+
|
|
19843
20084
|
##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.checkLicenses"></a>
|
|
19844
20085
|
|
|
19845
20086
|
```typescript
|
|
@@ -22040,6 +22281,7 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
|
|
|
22040
22281
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
22041
22282
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
22042
22283
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
|
|
22284
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.checkGhaExpressions">checkGhaExpressions</a></code> | <code>boolean</code> | Enable GitHub Actions expressions validation. |
|
|
22043
22285
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
22044
22286
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
|
|
22045
22287
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
@@ -22573,6 +22815,19 @@ The version of Bun to use if using Bun as a package manager.
|
|
|
22573
22815
|
|
|
22574
22816
|
---
|
|
22575
22817
|
|
|
22818
|
+
##### `checkGhaExpressions`<sup>Optional</sup> <a name="checkGhaExpressions" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.checkGhaExpressions"></a>
|
|
22819
|
+
|
|
22820
|
+
```typescript
|
|
22821
|
+
public readonly checkGhaExpressions: boolean;
|
|
22822
|
+
```
|
|
22823
|
+
|
|
22824
|
+
- *Type:* boolean
|
|
22825
|
+
- *Default:* true
|
|
22826
|
+
|
|
22827
|
+
Enable GitHub Actions expressions validation.
|
|
22828
|
+
|
|
22829
|
+
---
|
|
22830
|
+
|
|
22576
22831
|
##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.checkLicenses"></a>
|
|
22577
22832
|
|
|
22578
22833
|
```typescript
|
|
@@ -24669,6 +24924,7 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
|
|
|
24669
24924
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
24670
24925
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
24671
24926
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
|
|
24927
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.checkGhaExpressions">checkGhaExpressions</a></code> | <code>boolean</code> | Enable GitHub Actions expressions validation. |
|
|
24672
24928
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
24673
24929
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
|
|
24674
24930
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
@@ -25185,6 +25441,19 @@ The version of Bun to use if using Bun as a package manager.
|
|
|
25185
25441
|
|
|
25186
25442
|
---
|
|
25187
25443
|
|
|
25444
|
+
##### `checkGhaExpressions`<sup>Optional</sup> <a name="checkGhaExpressions" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.checkGhaExpressions"></a>
|
|
25445
|
+
|
|
25446
|
+
```typescript
|
|
25447
|
+
public readonly checkGhaExpressions: boolean;
|
|
25448
|
+
```
|
|
25449
|
+
|
|
25450
|
+
- *Type:* boolean
|
|
25451
|
+
- *Default:* true
|
|
25452
|
+
|
|
25453
|
+
Enable GitHub Actions expressions validation.
|
|
25454
|
+
|
|
25455
|
+
---
|
|
25456
|
+
|
|
25188
25457
|
##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.checkLicenses"></a>
|
|
25189
25458
|
|
|
25190
25459
|
```typescript
|
|
@@ -27150,6 +27419,7 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
|
|
|
27150
27419
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
27151
27420
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
27152
27421
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
27422
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.checkGhaExpressions">checkGhaExpressions</a></code> | <code>boolean</code> | Enable GitHub Actions expressions validation. |
|
|
27153
27423
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.enablePRAutoMerge">enablePRAutoMerge</a></code> | <code>boolean</code> | Whether to enable the auto merge workflow for PRs. |
|
|
27154
27424
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.ghAutoMergeOptions">ghAutoMergeOptions</a></code> | <code>projen.github.AutoQueueOptions</code> | Options for the GitHub auto merge workflow. |
|
|
27155
27425
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.private">private</a></code> | <code>boolean</code> | Whether or not this package is private. |
|
|
@@ -29285,6 +29555,19 @@ same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).
|
|
|
29285
29555
|
|
|
29286
29556
|
---
|
|
29287
29557
|
|
|
29558
|
+
##### `checkGhaExpressions`<sup>Optional</sup> <a name="checkGhaExpressions" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.checkGhaExpressions"></a>
|
|
29559
|
+
|
|
29560
|
+
```typescript
|
|
29561
|
+
public readonly checkGhaExpressions: boolean;
|
|
29562
|
+
```
|
|
29563
|
+
|
|
29564
|
+
- *Type:* boolean
|
|
29565
|
+
- *Default:* true
|
|
29566
|
+
|
|
29567
|
+
Enable GitHub Actions expressions validation.
|
|
29568
|
+
|
|
29569
|
+
---
|
|
29570
|
+
|
|
29288
29571
|
##### `enablePRAutoMerge`<sup>Optional</sup> <a name="enablePRAutoMerge" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.enablePRAutoMerge"></a>
|
|
29289
29572
|
|
|
29290
29573
|
```typescript
|
|
@@ -29544,6 +29827,7 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
|
|
|
29544
29827
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
29545
29828
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
29546
29829
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
29830
|
+
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.checkGhaExpressions">checkGhaExpressions</a></code> | <code>boolean</code> | Enable GitHub Actions expressions validation. |
|
|
29547
29831
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.enablePRAutoMerge">enablePRAutoMerge</a></code> | <code>boolean</code> | Whether to enable the auto merge workflow for PRs. |
|
|
29548
29832
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.ghAutoMergeOptions">ghAutoMergeOptions</a></code> | <code>projen.github.AutoQueueOptions</code> | Options for the GitHub auto merge workflow. |
|
|
29549
29833
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.private">private</a></code> | <code>boolean</code> | Whether or not this package is private. |
|
|
@@ -31679,6 +31963,19 @@ same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).
|
|
|
31679
31963
|
|
|
31680
31964
|
---
|
|
31681
31965
|
|
|
31966
|
+
##### `checkGhaExpressions`<sup>Optional</sup> <a name="checkGhaExpressions" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.checkGhaExpressions"></a>
|
|
31967
|
+
|
|
31968
|
+
```typescript
|
|
31969
|
+
public readonly checkGhaExpressions: boolean;
|
|
31970
|
+
```
|
|
31971
|
+
|
|
31972
|
+
- *Type:* boolean
|
|
31973
|
+
- *Default:* true
|
|
31974
|
+
|
|
31975
|
+
Enable GitHub Actions expressions validation.
|
|
31976
|
+
|
|
31977
|
+
---
|
|
31978
|
+
|
|
31682
31979
|
##### `enablePRAutoMerge`<sup>Optional</sup> <a name="enablePRAutoMerge" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.enablePRAutoMerge"></a>
|
|
31683
31980
|
|
|
31684
31981
|
```typescript
|
|
@@ -32180,6 +32477,7 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
|
|
|
32180
32477
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
|
|
32181
32478
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
32182
32479
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.bunVersion">bunVersion</a></code> | <code>string</code> | The version of Bun to use if using Bun as a package manager. |
|
|
32480
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.checkGhaExpressions">checkGhaExpressions</a></code> | <code>boolean</code> | Enable GitHub Actions expressions validation. |
|
|
32183
32481
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
32184
32482
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
|
|
32185
32483
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
@@ -32696,6 +32994,19 @@ The version of Bun to use if using Bun as a package manager.
|
|
|
32696
32994
|
|
|
32697
32995
|
---
|
|
32698
32996
|
|
|
32997
|
+
##### `checkGhaExpressions`<sup>Optional</sup> <a name="checkGhaExpressions" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.checkGhaExpressions"></a>
|
|
32998
|
+
|
|
32999
|
+
```typescript
|
|
33000
|
+
public readonly checkGhaExpressions: boolean;
|
|
33001
|
+
```
|
|
33002
|
+
|
|
33003
|
+
- *Type:* boolean
|
|
33004
|
+
- *Default:* true
|
|
33005
|
+
|
|
33006
|
+
Enable GitHub Actions expressions validation.
|
|
33007
|
+
|
|
33008
|
+
---
|
|
33009
|
+
|
|
32699
33010
|
##### `checkLicenses`<sup>Optional</sup> <a name="checkLicenses" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.checkLicenses"></a>
|
|
32700
33011
|
|
|
32701
33012
|
```typescript
|
|
@@ -4,6 +4,11 @@ import { OrgTenancy } from './';
|
|
|
4
4
|
* CdkCommonOptions
|
|
5
5
|
*/
|
|
6
6
|
export interface CdkCommonOptions {
|
|
7
|
+
/**
|
|
8
|
+
* Enable GitHub Actions expressions validation.
|
|
9
|
+
* @default true
|
|
10
|
+
*/
|
|
11
|
+
readonly checkGhaExpressions?: boolean;
|
|
7
12
|
/**
|
|
8
13
|
* Whether to enable the auto merge workflow for PRs.
|
|
9
14
|
* This will enable the auto merge workflow as well as the merge queue
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
3
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2RrLWNvbW1vbi1vcHRpb25zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2Nkay1jb21tb24tb3B0aW9ucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiLy8gfn4gR2VuZXJhdGVkIGJ5IHByb2plbi4gVG8gbW9kaWZ5LCBlZGl0IC5wcm9qZW5yYy50cyBhbmQgcnVuIFwieWFybiBwcm9qZW5cIi5cbmltcG9ydCB7IGdpdGh1YiB9IGZyb20gJ3Byb2plbic7XG5pbXBvcnQgeyBPcmdUZW5hbmN5IH0gZnJvbSAnLi8nO1xuXG4vKipcbiAqIENka0NvbW1vbk9wdGlvbnNcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBDZGtDb21tb25PcHRpb25zIHtcbiAgLyoqXG4gICAqIEVuYWJsZSBHaXRIdWIgQWN0aW9ucyBleHByZXNzaW9ucyB2YWxpZGF0aW9uLlxuICAgKiBAZGVmYXVsdCB0cnVlXG4gICAqL1xuICByZWFkb25seSBjaGVja0doYUV4cHJlc3Npb25zPzogYm9vbGVhbjtcbiAgLyoqXG4gICAqIFdoZXRoZXIgdG8gZW5hYmxlIHRoZSBhdXRvIG1lcmdlIHdvcmtmbG93IGZvciBQUnMuXG4gICAqIFRoaXMgd2lsbCBlbmFibGUgdGhlIGF1dG8gbWVyZ2Ugd29ya2Zsb3cgYXMgd2VsbCBhcyB0aGUgbWVyZ2UgcXVldWVcbiAgICogQGRlZmF1bHQgLSB0cnVlIGZvciBwcml2YXRlIHByb2plY3RzLCBmYWxzZSBvdGhlcndpc2VcbiAgICovXG4gIHJlYWRvbmx5IGVuYWJsZVBSQXV0b01lcmdlPzogYm9vbGVhbjtcbiAgLyoqXG4gICAqIE9wdGlvbnMgZm9yIHRoZSBHaXRIdWIgYXV0byBtZXJnZSB3b3JrZmxvdy5cbiAgICogVGhhdCBpcyB0aGUgd29ya2Zsb3cgdGhhdCB0dXJucyBvbiBhdXRvIG1lcmdlIG9uIGFsbCBQUnMuXG4gICAqIEBkZWZhdWx0IC0gZGVmYXVsdCBvcHRpb25zXG4gICAqL1xuICByZWFkb25seSBnaEF1dG9NZXJnZU9wdGlvbnM/OiBnaXRodWIuQXV0b1F1ZXVlT3B0aW9ucztcbiAgLyoqXG4gICAqIFdoZXRoZXIgb3Igbm90IHRoaXMgcGFja2FnZSBpcyBwcml2YXRlLlxuICAgKiBTZXR0aW5nIHRoaXMgdmFyaWFibGUgdG8gdHJ1ZSBtZWFucyB0aGF0IHlvdXIgcHJvamVjdCBpcyBjcmVhdGVkIHdpdGggc2FuZSBkZWZhdWx0cyBmb3IgcHJpdmF0ZSByZXBvc2l0b3JpZXMuXG4gICAqIEBkZWZhdWx0IHRydWVcbiAgICovXG4gIHJlYWRvbmx5IHByaXZhdGU/OiBib29sZWFuO1xuICAvKipcbiAgICogU2V0IGEgbWluaW1hbCBub2RlIHZlcnNpb24gdmlhIHRoZSBlbmdpbmVzIGZpZWxkXG4gICAqIFNldCB0aGlzIHRvIGBmYWxzZWAgaWYgYSBwYWNrYWdlIGRpZCBub3QgZW5mb3JjZSB0aGlzIHByZXZpb3VzbHkgYW5kIHdlIGRvbid0IHdhbnQgdG8gY2hhbmdlIHRoaXMgZm9yIG5vdy5cbiAgICogQGRlZmF1bHQgdHJ1ZVxuICAgKi9cbiAgcmVhZG9ubHkgc2V0Tm9kZUVuZ2luZVZlcnNpb24/OiBib29sZWFuO1xuICAvKipcbiAgICogVGhlIG9yZ2FuaXphdGlvbiB0aGlzIHByb2plY3QgaXMgcGFydCBvZi5cbiAgICogQGRlZmF1bHQgLSBBdXRvIGRldGVjdGVkIGZyb20gcGFja2FnZSBuYW1lXG4gICAqL1xuICByZWFkb25seSB0ZW5hbmN5PzogT3JnVGVuYW5jeTtcbiAgLyoqXG4gICAqIFdoZXRoZXIgdG8gZW5hYmxlIHRoZSBzZXBhcmF0ZSB3b3JrZmxvdyB0byB1cGdyYWRlIHRoZSBjZGtsYWJzLXByb2plbi1wcm9qZWN0LXR5cGVzIGRlcGVuZGVuY2llcy5cbiAgICogQGRlZmF1bHQgdHJ1ZVxuICAgKi9cbiAgcmVhZG9ubHkgdXBncmFkZUNka2xhYnNQcm9qZW5Qcm9qZWN0VHlwZXM/OiBib29sZWFuO1xuICAvKipcbiAgICogV2hldGhlciB0byBoYXZlIGEgc2VwYXJhdGUgd29ya2Zsb3cgdG8gdXBncmFkZSBydW50aW1lIGRlcHMgYW5kIG1hcmsgdGhpcyBQUiBhcyBmaXguXG4gICAqIEBkZWZhdWx0IHRydWVcbiAgICovXG4gIHJlYWRvbmx5IHVwZ3JhZGVSdW50aW1lRGVwc0FzRml4PzogYm9vbGVhbjtcbn1cbiJdfQ==
|
|
@@ -186,6 +186,11 @@ export interface CdkConstructLibraryOptions {
|
|
|
186
186
|
* If you use experimental features this will let you define the moment you include breaking changes.
|
|
187
187
|
*/
|
|
188
188
|
readonly cdkVersionPinning?: boolean;
|
|
189
|
+
/**
|
|
190
|
+
* Enable GitHub Actions expressions validation.
|
|
191
|
+
* @default true
|
|
192
|
+
*/
|
|
193
|
+
readonly checkGhaExpressions?: boolean;
|
|
189
194
|
/**
|
|
190
195
|
* Configure which licenses should be deemed acceptable for use by dependencies.
|
|
191
196
|
* This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.
|