Skip to content

Commit f8dcf2e

Browse files
milesjmilesj
committed
Update schemas.
1 parent 7dd838b commit f8dcf2e

6 files changed

Lines changed: 32 additions & 24 deletions

File tree

‎crates/config/tests/workspace_config_test.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -821,7 +821,7 @@ vcs:
821821
use super::*;
822822

823823
#[test]
824-
#[should_panic(expected = "unexpected character '@' while parsing major version number")]
824+
#[should_panic(expected = "Failed to parse a version requirement")]
825825
fn errors_on_invalid_req() {
826826
test_load_config(FILENAME, "versionConstraint: '@1.0.0'", |path| {
827827
load_config_from_root(path)

‎packages/types/src/project-config.ts‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ export type OwnersPaths = string[] | Record<string, string[]>;
106106
*/
107107
export interface OwnersConfig {
108108
/**
109-
* Bitbucket only. A map of custom groups (prefixed with `@@@`),
109+
* `bitbucket-legacy` only. A map of custom groups (prefixed with `@@@`),
110110
* to a list of user and normal groups.
111111
*/
112112
customGroups?: Record<string, string[]>;
@@ -121,9 +121,9 @@ export interface OwnersConfig {
121121
*/
122122
paths: OwnersPaths;
123123
/**
124-
* Bitbucket and GitLab only. The number of approvals required for the
125-
* request to be satisfied. For Bitbucket, utilizes the `Check()` condition.
126-
* For GitLab, marks the code owners section as required.
124+
* `bitbucket-legacy` and GitLab only. The number of approvals required
125+
* for the request to be satisfied. For `bitbucket-legacy`, utilizes the
126+
* `Check()` condition. For GitLab, marks the code owners section as required.
127127
*/
128128
requiredApprovals?: number | null;
129129
}
@@ -331,7 +331,7 @@ export type PartialOwnersPaths = string[] | Record<string, string[]>;
331331
*/
332332
export interface PartialOwnersConfig {
333333
/**
334-
* Bitbucket only. A map of custom groups (prefixed with `@@@`),
334+
* `bitbucket-legacy` only. A map of custom groups (prefixed with `@@@`),
335335
* to a list of user and normal groups.
336336
*/
337337
customGroups?: Record<string, string[]> | null;
@@ -346,9 +346,9 @@ export interface PartialOwnersConfig {
346346
*/
347347
paths?: PartialOwnersPaths | null;
348348
/**
349-
* Bitbucket and GitLab only. The number of approvals required for the
350-
* request to be satisfied. For Bitbucket, utilizes the `Check()` condition.
351-
* For GitLab, marks the code owners section as required.
349+
* `bitbucket-legacy` and GitLab only. The number of approvals required
350+
* for the request to be satisfied. For `bitbucket-legacy`, utilizes the
351+
* `Check()` condition. For GitLab, marks the code owners section as required.
352352
*/
353353
requiredApprovals?: number | null;
354354
}

‎packages/types/src/tasks-config.ts‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -416,7 +416,8 @@ export interface TaskOptionsConfig {
416416
retryCount?: number | null;
417417
/**
418418
* Runs direct task dependencies (via `deps`) in sequential order.
419-
* This _does not_ apply to indirect or transient dependencies.
419+
* Each dependency's own dependency subtree is also ordered, so that
420+
* transitive dependencies run after the preceding direct dependency.
420421
*/
421422
runDepsInParallel?: boolean | null;
422423
/** Runs the task from the workspace root, instead of the project root. */
@@ -940,7 +941,8 @@ export interface PartialTaskOptionsConfig {
940941
retryCount?: number | null;
941942
/**
942943
* Runs direct task dependencies (via `deps`) in sequential order.
943-
* This _does not_ apply to indirect or transient dependencies.
944+
* Each dependency's own dependency subtree is also ordered, so that
945+
* transitive dependencies run after the preceding direct dependency.
944946
*/
945947
runDepsInParallel?: boolean | null;
946948
/** Runs the task from the workspace root, instead of the project root. */

‎packages/types/src/workspace-config.ts‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ export interface CodeownersConfig {
4848
*/
4949
orderBy: CodeownersOrderBy;
5050
/**
51-
* Bitbucket and GitLab only. The number of approvals required for the
52-
* request to be satisfied. This will be applied to all paths.
51+
* `bitbucket-legacy` and GitLab only. The number of approvals required
52+
* for the request to be satisfied. This will be applied to all paths.
5353
* @since 1.28.0
5454
*/
5555
requiredApprovals?: number | null;
@@ -608,6 +608,8 @@ export interface VcsConfig {
608608
sync?: boolean;
609609
}
610610

611+
export type Requirement = string;
612+
611613
/**
612614
* Configures all aspects of the moon workspace.
613615
* Docs: https://moonrepo.dev/docs/config/workspace
@@ -694,7 +696,7 @@ export interface WorkspaceConfig {
694696
*/
695697
vcs: VcsConfig;
696698
/** Requires a specific version of the `moon` binary. */
697-
versionConstraint?: string | null;
699+
versionConstraint?: Requirement | null;
698700
}
699701

700702
/** Configures aspects of the content-addressable storage (CAS) cache. */
@@ -737,8 +739,8 @@ export interface PartialCodeownersConfig {
737739
*/
738740
orderBy?: CodeownersOrderBy | null;
739741
/**
740-
* Bitbucket and GitLab only. The number of approvals required for the
741-
* request to be satisfied. This will be applied to all paths.
742+
* `bitbucket-legacy` and GitLab only. The number of approvals required
743+
* for the request to be satisfied. This will be applied to all paths.
742744
* @since 1.28.0
743745
*/
744746
requiredApprovals?: number | null;
@@ -1339,5 +1341,5 @@ export interface PartialWorkspaceConfig {
13391341
*/
13401342
vcs?: PartialVcsConfig | null;
13411343
/** Requires a specific version of the `moon` binary. */
1342-
versionConstraint?: string | null;
1344+
versionConstraint?: Requirement | null;
13431345
}

‎website/static/schemas/v2/project.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -574,7 +574,7 @@
574574
"properties": {
575575
"customGroups": {
576576
"title": "customGroups",
577-
"description": "Bitbucket only. A map of custom groups (prefixed with @@@), to a list of user and normal groups.",
577+
"description": "bitbucket-legacy only. A map of custom groups (prefixed with @@@), to a list of user and normal groups.",
578578
"type": "object",
579579
"additionalProperties": {
580580
"type": "array",
@@ -585,7 +585,7 @@
585585
"propertyNames": {
586586
"type": "string"
587587
},
588-
"markdownDescription": "Bitbucket only. A map of custom groups (prefixed with `@@@`), to a list of user and normal groups."
588+
"markdownDescription": "`bitbucket-legacy` only. A map of custom groups (prefixed with `@@@`), to a list of user and normal groups."
589589
},
590590
"defaultOwner": {
591591
"title": "defaultOwner",
@@ -617,7 +617,7 @@
617617
},
618618
"requiredApprovals": {
619619
"title": "requiredApprovals",
620-
"description": "Bitbucket and GitLab only. The number of approvals required for the request to be satisfied. For Bitbucket, utilizes the Check() condition. For GitLab, marks the code owners section as required.",
620+
"description": "bitbucket-legacy and GitLab only. The number of approvals required for the request to be satisfied. For bitbucket-legacy, utilizes the Check() condition. For GitLab, marks the code owners section as required.",
621621
"anyOf": [
622622
{
623623
"type": "number"
@@ -626,7 +626,7 @@
626626
"type": "null"
627627
}
628628
],
629-
"markdownDescription": "Bitbucket and GitLab only. The number of approvals required for the request to be satisfied. For Bitbucket, utilizes the `Check()` condition. For GitLab, marks the code owners section as required."
629+
"markdownDescription": "`bitbucket-legacy` and GitLab only. The number of approvals required for the request to be satisfied. For `bitbucket-legacy`, utilizes the `Check()` condition. For GitLab, marks the code owners section as required."
630630
}
631631
},
632632
"additionalProperties": false

‎website/static/schemas/v2/workspace.json‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@
171171
"description": "Requires a specific version of the moon binary.",
172172
"anyOf": [
173173
{
174-
"type": "string"
174+
"$ref": "#/definitions/Requirement"
175175
},
176176
{
177177
"type": "null"
@@ -255,15 +255,16 @@
255255
},
256256
"requiredApprovals": {
257257
"title": "requiredApprovals",
258-
"description": "Bitbucket and GitLab only. The number of approvals required for the request to be satisfied. This will be applied to all paths. @since 1.28.0",
258+
"description": "bitbucket-legacy and GitLab only. The number of approvals required for the request to be satisfied. This will be applied to all paths. @since 1.28.0",
259259
"anyOf": [
260260
{
261261
"type": "number"
262262
},
263263
{
264264
"type": "null"
265265
}
266-
]
266+
],
267+
"markdownDescription": "`bitbucket-legacy` and GitLab only. The number of approvals required for the request to be satisfied. This will be applied to all paths. @since 1.28.0"
267268
},
268269
"sync": {
269270
"title": "sync",
@@ -939,6 +940,9 @@
939940
"additionalProperties": false,
940941
"markdownDescription": "Configures for server-only authentication with TLS. @since 1.30.0"
941942
},
943+
"Requirement": {
944+
"type": "string"
945+
},
942946
"VcsClient": {
943947
"description": "The VCS being utilized by the repository.",
944948
"type": "string",

0 commit comments

Comments
 (0)