@cdk8s/projen-common 0.1.19 → 0.1.21

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.
Files changed (7) hide show
  1. package/.jsii +3 -3
  2. package/API.md +45 -12
  3. package/lib/components/triage/triage.js +1 -1
  4. package/lib/projects/jsii.js +1 -1
  5. package/lib/projects/node.js +1 -1
  6. package/lib/projects/typescript.js +1 -1
  7. package/package.json +2 -2
package/.jsii CHANGED
@@ -87,7 +87,7 @@
87
87
  "stability": "stable"
88
88
  },
89
89
  "homepage": "https://github.com/cdk8s-team/cdk8s-projen-common.git",
90
- "jsiiVersion": "6.0.10 (build bb45f01)",
90
+ "jsiiVersion": "6.0.11 (build d41f82c)",
91
91
  "license": "Apache-2.0",
92
92
  "metadata": {
93
93
  "jsii": {
@@ -764,6 +764,6 @@
764
764
  "symbolId": "src/components/triage/triage:TriageProps"
765
765
  }
766
766
  },
767
- "version": "0.1.19",
768
- "fingerprint": "hQvdVM8lWQClOLzbNDQ5k7KRhASBT+fnyCvDukJvU+g="
767
+ "version": "0.1.21",
768
+ "fingerprint": "AYkdJ06kGLQIpyTkEBEt+TmqXFtDj1uTO70hmsDgY9k="
769
769
  }
package/API.md CHANGED
@@ -4389,7 +4389,7 @@ const cdk8sTeamJsiiProjectOptions: Cdk8sTeamJsiiProjectOptions = { ... }
4389
4389
  | <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
4390
4390
  | <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
4391
4391
  | <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
4392
- | <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.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@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
4392
+ | <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. |
4393
4393
  | <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
4394
4394
  | <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
4395
4395
  | <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
@@ -4569,6 +4569,10 @@ public readonly projenCommand: string;
4569
4569
 
4570
4570
  The shell command to use in order to run the projen CLI.
4571
4571
 
4572
+ Inserted verbatim into task steps, workflows and IDE configuration, and run
4573
+ by each of their shells - locally, in CI and in dev containers. Keep it a
4574
+ plain unquoted command, since shell syntax in it executes in all of them.
4575
+
4572
4576
  Can be used to customize in special environments.
4573
4577
 
4574
4578
  ---
@@ -5853,7 +5857,9 @@ Container image to use for GitHub workflows.
5853
5857
 
5854
5858
  ---
5855
5859
 
5856
- ##### `workflowRunsOn`<sup>Optional</sup> <a name="workflowRunsOn" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.workflowRunsOn"></a>
5860
+ ##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.workflowRunsOn"></a>
5861
+
5862
+ - *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
5857
5863
 
5858
5864
  ```typescript
5859
5865
  public readonly workflowRunsOn: string[];
@@ -5866,7 +5872,9 @@ Github Runner selection labels.
5866
5872
 
5867
5873
  ---
5868
5874
 
5869
- ##### `workflowRunsOnGroup`<sup>Optional</sup> <a name="workflowRunsOnGroup" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.workflowRunsOnGroup"></a>
5875
+ ##### ~~`workflowRunsOnGroup`~~<sup>Optional</sup> <a name="workflowRunsOnGroup" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.workflowRunsOnGroup"></a>
5876
+
5877
+ - *Deprecated:* use `githubOptions.workflowRunsOnGroup` on the project, or `runsOnGroup` on `ReleaseOptions`
5870
5878
 
5871
5879
  ```typescript
5872
5880
  public readonly workflowRunsOnGroup: GroupRunnerOptions;
@@ -6023,7 +6031,10 @@ public readonly codeCov: boolean;
6023
6031
  - *Type:* boolean
6024
6032
  - *Default:* false
6025
6033
 
6026
- Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
6034
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/.
6035
+
6036
+ Uses codecov/codecov-action. By default, OIDC auth is used.
6037
+ Alternatively a token can be provided via `codeCovTokenSecret`.
6027
6038
 
6028
6039
  ---
6029
6040
 
@@ -6927,7 +6938,7 @@ const cdk8sTeamNodeProjectOptions: Cdk8sTeamNodeProjectOptions = { ... }
6927
6938
  | <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
6928
6939
  | <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
6929
6940
  | <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
6930
- | <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.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@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
6941
+ | <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. |
6931
6942
  | <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
6932
6943
  | <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
6933
6944
  | <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
@@ -7081,6 +7092,10 @@ public readonly projenCommand: string;
7081
7092
 
7082
7093
  The shell command to use in order to run the projen CLI.
7083
7094
 
7095
+ Inserted verbatim into task steps, workflows and IDE configuration, and run
7096
+ by each of their shells - locally, in CI and in dev containers. Keep it a
7097
+ plain unquoted command, since shell syntax in it executes in all of them.
7098
+
7084
7099
  Can be used to customize in special environments.
7085
7100
 
7086
7101
  ---
@@ -8365,7 +8380,9 @@ Container image to use for GitHub workflows.
8365
8380
 
8366
8381
  ---
8367
8382
 
8368
- ##### `workflowRunsOn`<sup>Optional</sup> <a name="workflowRunsOn" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.workflowRunsOn"></a>
8383
+ ##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.workflowRunsOn"></a>
8384
+
8385
+ - *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
8369
8386
 
8370
8387
  ```typescript
8371
8388
  public readonly workflowRunsOn: string[];
@@ -8378,7 +8395,9 @@ Github Runner selection labels.
8378
8395
 
8379
8396
  ---
8380
8397
 
8381
- ##### `workflowRunsOnGroup`<sup>Optional</sup> <a name="workflowRunsOnGroup" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.workflowRunsOnGroup"></a>
8398
+ ##### ~~`workflowRunsOnGroup`~~<sup>Optional</sup> <a name="workflowRunsOnGroup" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.workflowRunsOnGroup"></a>
8399
+
8400
+ - *Deprecated:* use `githubOptions.workflowRunsOnGroup` on the project, or `runsOnGroup` on `ReleaseOptions`
8382
8401
 
8383
8402
  ```typescript
8384
8403
  public readonly workflowRunsOnGroup: GroupRunnerOptions;
@@ -8535,7 +8554,10 @@ public readonly codeCov: boolean;
8535
8554
  - *Type:* boolean
8536
8555
  - *Default:* false
8537
8556
 
8538
- Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
8557
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/.
8558
+
8559
+ Uses codecov/codecov-action. By default, OIDC auth is used.
8560
+ Alternatively a token can be provided via `codeCovTokenSecret`.
8539
8561
 
8540
8562
  ---
8541
8563
 
@@ -9086,7 +9108,7 @@ const cdk8sTeamTypeScriptProjectOptions: Cdk8sTeamTypeScriptProjectOptions = { .
9086
9108
  | <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
9087
9109
  | <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
9088
9110
  | <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
9089
- | <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.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@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
9111
+ | <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/. |
9090
9112
  | <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
9091
9113
  | <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
9092
9114
  | <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
@@ -9260,6 +9282,10 @@ public readonly projenCommand: string;
9260
9282
 
9261
9283
  The shell command to use in order to run the projen CLI.
9262
9284
 
9285
+ Inserted verbatim into task steps, workflows and IDE configuration, and run
9286
+ by each of their shells - locally, in CI and in dev containers. Keep it a
9287
+ plain unquoted command, since shell syntax in it executes in all of them.
9288
+
9263
9289
  Can be used to customize in special environments.
9264
9290
 
9265
9291
  ---
@@ -10544,7 +10570,9 @@ Container image to use for GitHub workflows.
10544
10570
 
10545
10571
  ---
10546
10572
 
10547
- ##### `workflowRunsOn`<sup>Optional</sup> <a name="workflowRunsOn" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.workflowRunsOn"></a>
10573
+ ##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.workflowRunsOn"></a>
10574
+
10575
+ - *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
10548
10576
 
10549
10577
  ```typescript
10550
10578
  public readonly workflowRunsOn: string[];
@@ -10557,7 +10585,9 @@ Github Runner selection labels.
10557
10585
 
10558
10586
  ---
10559
10587
 
10560
- ##### `workflowRunsOnGroup`<sup>Optional</sup> <a name="workflowRunsOnGroup" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.workflowRunsOnGroup"></a>
10588
+ ##### ~~`workflowRunsOnGroup`~~<sup>Optional</sup> <a name="workflowRunsOnGroup" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.workflowRunsOnGroup"></a>
10589
+
10590
+ - *Deprecated:* use `githubOptions.workflowRunsOnGroup` on the project, or `runsOnGroup` on `ReleaseOptions`
10561
10591
 
10562
10592
  ```typescript
10563
10593
  public readonly workflowRunsOnGroup: GroupRunnerOptions;
@@ -10714,7 +10744,10 @@ public readonly codeCov: boolean;
10714
10744
  - *Type:* boolean
10715
10745
  - *Default:* false
10716
10746
 
10717
- Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
10747
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/.
10748
+
10749
+ Uses codecov/codecov-action. By default, OIDC auth is used.
10750
+ Alternatively a token can be provided via `codeCovTokenSecret`.
10718
10751
 
10719
10752
  ---
10720
10753
 
package/lib/components/triage/triage.js CHANGED
@@ -10,7 +10,7 @@ const workflows_model_1 = require("projen/lib/github/workflows-model");
10
10
  * @see https://github.com/marketplace/actions/add-to-github-projects
11
11
  */
12
12
  class Triage extends projen_1.Component {
13
- static [JSII_RTTI_SYMBOL_1] = { fqn: "@cdk8s/projen-common.Triage", version: "0.1.19" };
13
+ static [JSII_RTTI_SYMBOL_1] = { fqn: "@cdk8s/projen-common.Triage", version: "0.1.21" };
14
14
  constructor(project, props) {
15
15
  super(project);
16
16
  // hmm, we need to remember to update this in 2024
package/lib/projects/jsii.js CHANGED
@@ -46,7 +46,7 @@ const code = new maker.CodeMaker();
46
46
  * @pjid cdk8s-team-jsii-project
47
47
  */
48
48
  class Cdk8sTeamJsiiProject extends projen_1.cdk.JsiiProject {
49
- static [JSII_RTTI_SYMBOL_1] = { fqn: "@cdk8s/projen-common.Cdk8sTeamJsiiProject", version: "0.1.19" };
49
+ static [JSII_RTTI_SYMBOL_1] = { fqn: "@cdk8s/projen-common.Cdk8sTeamJsiiProject", version: "0.1.21" };
50
50
  constructor(options) {
51
51
  node.validateOptions(options);
52
52
  node.validateProjectName(options);
package/lib/projects/node.js CHANGED
@@ -150,7 +150,7 @@ function buildRepositoryName(projectName) {
150
150
  * @pjid cdk8s-team-node-project
151
151
  */
152
152
  class Cdk8sTeamNodeProject extends projen_1.javascript.NodeProject {
153
- static [JSII_RTTI_SYMBOL_1] = { fqn: "@cdk8s/projen-common.Cdk8sTeamNodeProject", version: "0.1.19" };
153
+ static [JSII_RTTI_SYMBOL_1] = { fqn: "@cdk8s/projen-common.Cdk8sTeamNodeProject", version: "0.1.21" };
154
154
  constructor(options) {
155
155
  validateOptions(options);
156
156
  validateProjectName(options);
package/lib/projects/typescript.js CHANGED
@@ -44,7 +44,7 @@ const backport_1 = require("../components/backport/backport");
44
44
  * @pjid cdk8s-team-typescript-project
45
45
  */
46
46
  class Cdk8sTeamTypeScriptProject extends projen_1.typescript.TypeScriptProject {
47
- static [JSII_RTTI_SYMBOL_1] = { fqn: "@cdk8s/projen-common.Cdk8sTeamTypeScriptProject", version: "0.1.19" };
47
+ static [JSII_RTTI_SYMBOL_1] = { fqn: "@cdk8s/projen-common.Cdk8sTeamTypeScriptProject", version: "0.1.21" };
48
48
  constructor(options) {
49
49
  node.validateOptions(options);
50
50
  node.validateProjectName(options);
package/package.json CHANGED
@@ -56,7 +56,7 @@
56
56
  "jsii-docgen": "^10.5.0",
57
57
  "jsii-pacmak": "^1.139.0",
58
58
  "jsii-rosetta": "6.0.x",
59
- "projen": "^0.101.31",
59
+ "projen": "^0.103.1",
60
60
  "ts-jest": "^29",
61
61
  "ts-node": "^10.9.2",
62
62
  "typescript": "6.0.x"
@@ -75,7 +75,7 @@
75
75
  "main": "lib/index.js",
76
76
  "license": "Apache-2.0",
77
77
  "stability": "stable",
78
- "version": "0.1.19",
78
+ "version": "0.1.21",
79
79
  "jest": {
80
80
  "coverageProvider": "v8",
81
81
  "testMatch": [