Skip to content

Commit 2a2f4c3

Browse files
committed
Add docs for automationId
1 parent 6d060bb commit 2a2f4c3

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/sarif/index.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,12 @@ import * as sarif from "sarif";
66

77
export type * from "sarif";
88

9-
// `automationId` is non-standard.
9+
// Extends `ToolComponent` with the non-standard `automationId` property we use.
1010
export type RunKey = sarif.ToolComponent & {
11+
/**
12+
* Describes a SARIF run (either uniquely or not uniquely) based on the criteria used by
13+
* Code Scanning to determine analysis categories
14+
*/
1115
automationId: string | undefined;
1216
};
1317

0 commit comments

Comments
 (0)