Skip to content

Commit 931147e

Browse files
committed
Improve OS types and docs
1 parent 1b65777 commit 931147e

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

pr-checks/sync.ts

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,21 @@ interface WorkflowInput {
2828
/** A partial mapping from known input names to input definitions. */
2929
type WorkflowInputs = Partial<Record<KnownInputName, WorkflowInput>>;
3030

31+
/** An operating system identifier. */
32+
type OperatingSystemIdentifier = "ubuntu" | "macos" | "windows";
33+
34+
/**
35+
* Represents an operating system matrix entry for a generated PR check workflow.
36+
*
37+
* Either a string containing the OS identifier or an object containing the OS identifier and an
38+
* optional runner image label.
39+
*/
3140
type OperatingSystem =
32-
| string
41+
| OperatingSystemIdentifier
3342
| {
34-
os: string;
43+
/** OS identifier. */
44+
os: OperatingSystemIdentifier;
45+
/** Optional runner image label. */
3546
"runner-image"?: string;
3647
};
3748

0 commit comments

Comments
 (0)