From c897aa186aece06435bcecf77810f8d075493189 Mon Sep 17 00:00:00 2001 From: James Turley Date: Wed, 14 Dec 2022 11:19:22 +0000 Subject: [PATCH] Additional doc comments for billing map keys --- github/actions_workflow_runs.go | 1 + github/actions_workflows.go | 1 + github/billing.go | 1 + 3 files changed, 3 insertions(+) diff --git a/github/actions_workflow_runs.go b/github/actions_workflow_runs.go index 9ded7742a05..6241dc629fc 100644 --- a/github/actions_workflow_runs.go +++ b/github/actions_workflow_runs.go @@ -70,6 +70,7 @@ type WorkflowRunUsage struct { } // WorkflowRunBillMap represents different runner environments available for a workflow run. +// Its key is the name of its environment, e.g. "UBUNTU", "MACOS", "WINDOWS", etc. type WorkflowRunBillMap map[string]*WorkflowRunBill // WorkflowRunBill specifies billable time for a specific environment in a workflow run. diff --git a/github/actions_workflows.go b/github/actions_workflows.go index d2a00f9f30c..c9b47ed4be4 100644 --- a/github/actions_workflows.go +++ b/github/actions_workflows.go @@ -36,6 +36,7 @@ type WorkflowUsage struct { } // WorkflowBillMap represents different runner environments available for a workflow. +// Its key is the name of its environment, e.g. "UBUNTU", "MACOS", "WINDOWS", etc. type WorkflowBillMap map[string]*WorkflowBill // WorkflowBill specifies billable time for a specific environment in a workflow. diff --git a/github/billing.go b/github/billing.go index 39a607b2ae2..2f5861ce808 100644 --- a/github/billing.go +++ b/github/billing.go @@ -24,6 +24,7 @@ type ActionBilling struct { MinutesUsedBreakdown MinutesUsedBreakdown `json:"minutes_used_breakdown"` } +// MinutesUsedBreakdown counts the actions minutes used by machine type (e.g. UBUNTU, WINDOWS, MACOS). type MinutesUsedBreakdown = map[string]int // PackageBilling represents a GitHub Package billing.