Skip to content

Commit

Permalink
Add more descriptive comment on job run UUID
Browse files Browse the repository at this point in the history
  • Loading branch information
angelapwen committed May 19, 2023
1 parent 9c9fc41 commit f06d9f5
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion src/actions-util.ts
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,15 @@ export type ActionStatus =
| "user-error";

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

0 comments on commit f06d9f5

Please sign in to comment.