Skip to content

Commit f06d9f5

Browse files
committed
Add more descriptive comment on job run UUID
1 parent 9c9fc41 commit f06d9f5

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

src/actions-util.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,15 @@ export type ActionStatus =
315315
| "user-error";
316316

317317
export interface StatusReportBase {
318-
/** UUID representing the job run that this status report belongs to. */
318+
/** UUID representing the job run that this status report belongs to.
319+
* We generate our own UUID here because Actions currently does not expose
320+
* a unique job run identifier. This UUID will allow us to more easily
321+
* match reports from different steps in the same workflow job.
322+
*
323+
* If and when Actions does expose a unique job ID, we plan to populate
324+
* this field with the Actions-generated identifier, as it will allow us
325+
* to more easily join our telemetry data with Actions telemetry tables.
326+
*/
319327
job_run_uuid: string;
320328
/** ID of the workflow run containing the action run. */
321329
workflow_run_id: number;

0 commit comments

Comments
 (0)