From a41a19bcd29617101eac666582ed543806eaeb89 Mon Sep 17 00:00:00 2001 From: Caro Galvin Date: Thu, 15 Oct 2026 20:33:58 +0000 Subject: [PATCH] Document Code Quality license CSV downloads (#63781) Co-authored-by: carogalvin <223556219+Copilot@users.noreply.github.com> Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com> Copilot-Session: 637b33e5-5817-4081-9e97-72be4fe5b891 --- .../product-billing/github-code-quality.md | 2 ++ .../how-tos/products/download-license-use.md | 6 ++--- content/billing/reference/license-reports.md | 25 ++++++++++++++++--- .../view-and-manage-cost.md | 1 + 4 files changed, 28 insertions(+), 6 deletions(-) diff --git a/content/billing/concepts/product-billing/github-code-quality.md b/content/billing/concepts/product-billing/github-code-quality.md index 82e44a153d25..e9999f8d20cf 100644 --- a/content/billing/concepts/product-billing/github-code-quality.md +++ b/content/billing/concepts/product-billing/github-code-quality.md @@ -46,6 +46,8 @@ To understand your license usage, and which licenses you can free up, it helps t Users can contribute to multiple repositories or organizations. Usage is measured across the whole organization or enterprise to ensure that each member uses one license regardless of how many repositories or organizations the user contributes to. +To see which committers and repositories contribute to your license usage, download the {% data variables.product.prodname_code_quality_short %} CSV report from the **Licensing** page. See [AUTOTITLE](/billing/how-tos/products/download-license-use). + ## Further reading * [AUTOTITLE](/code-security/tutorials/improve-code-quality/catch-issues-before-merge) diff --git a/content/billing/how-tos/products/download-license-use.md b/content/billing/how-tos/products/download-license-use.md index 552ac3a4ed5f..bd8d4d52aa92 100644 --- a/content/billing/how-tos/products/download-license-use.md +++ b/content/billing/how-tos/products/download-license-use.md @@ -1,6 +1,6 @@ --- title: Downloading license use for your enterprise or organization -intro: Get data on consumption of {% data variables.product.github %}, {% data variables.product.prodname_copilot_short %}, and {% data variables.product.prodname_AS %} licenses. +intro: Get data on consumption of {% data variables.product.github %}, {% data variables.product.prodname_copilot_short %}{% ifversion code-quality %}, {% data variables.product.prodname_code_quality_short %}{% endif %}, and {% data variables.product.prodname_AS %} licenses. permissions: '{% data reusables.permissions.enhanced-billing-enterprise %}' versions: fpt: '*' @@ -15,7 +15,7 @@ category: - Manage your plan and licenses --- -You can download CSV files with details of paid license use through the {% data variables.product.github %} user interface or the REST API. +You can download CSV files with details of paid license use through the {% data variables.product.github %} user interface. For supported products, you can also retrieve license usage information through the REST API. For more detailed reports on usage of all paid products, see [AUTOTITLE](/billing/how-tos/products/view-productlicense-use). @@ -26,7 +26,7 @@ For more detailed reports on usage of all paid products, see [AUTOTITLE](/billin 1. In the license area of interest, click **Download CSV report**. If offered a choice, choose your preferred report. -The report will be emailed to the default email address associated with your {% data variables.product.github %} account. For information about the fields, see [AUTOTITLE](/billing/reference/license-reports). +The report will be emailed to the default email address associated with your {% data variables.product.github %} account.{% ifversion code-quality %} The exception is {% data variables.product.prodname_code_quality_short %} reports, which download directly to your browser instead.{% endif %} For information about the fields, see [AUTOTITLE](/billing/reference/license-reports). ## On {% data variables.product.prodname_ghe_server %} diff --git a/content/billing/reference/license-reports.md b/content/billing/reference/license-reports.md index 5116e701b32f..db7c8c8ea610 100644 --- a/content/billing/reference/license-reports.md +++ b/content/billing/reference/license-reports.md @@ -12,13 +12,13 @@ category: - Track spending and control costs --- -Each license report shows information about license users in your enterprise account, for {% data variables.product.prodname_copilot_short %}, or for {% data variables.product.prodname_AS %}. +Each license report shows information about license users in your enterprise account, for {% data variables.product.prodname_copilot_short %}{% ifversion code-quality %}, for {% data variables.product.prodname_code_quality_short %}{% endif %}, or for {% data variables.product.prodname_AS %}. -**Cloud users** can download license reports from the {% octicon "law" aria-hidden="true" aria-label="law" %} **Licensing** page under {% octicon "credit-card" aria-hidden="true" aria-label="credit-card" %} **Billing & licensing** or using the REST API. +**Cloud users** can download license reports from the {% octicon "law" aria-hidden="true" aria-label="law" %} **Licensing** page under {% octicon "credit-card" aria-hidden="true" aria-label="credit-card" %} **Billing & licensing** or, for supported products, using the REST API. {% ifversion fpt or ghec %} -* Enterprise and {% data variables.product.prodname_AS %} license users, see [AUTOTITLE](/billing/how-tos/products/download-license-use) +* Enterprise{% ifversion code-quality %}, {% data variables.product.prodname_code_quality_short %},{% endif %} and {% data variables.product.prodname_AS %} license users, see [AUTOTITLE](/billing/how-tos/products/download-license-use) * {% data variables.product.prodname_copilot %} license users, see [AUTOTITLE](/copilot/how-tos/administer-copilot/download-activity-report) * Report using the REST API, see [AUTOTITLE](/billing/tutorials/automate-usage-reporting) @@ -28,6 +28,25 @@ If you want to generate a more detailed usage report, see [AUTOTITLE](/billing/t **{% data variables.product.prodname_ghe_server %} users** can download license reports for {% data variables.product.prodname_AS %} from the **License** page under enterprise settings, see [AUTOTITLE](/billing/how-tos/products/download-license-use). +{% ifversion code-quality %} + +## {% data variables.product.prodname_code_quality_short %} license report + +The CSV file lists active committers consuming {% data variables.product.prodname_code_quality_short %} licenses and the repositories contributing to that usage. + +| Field | Description | +|-------|-------------| +| User login | The {% data variables.product.github %} username of the user. | +| Organization / repository | The owner and name of a repository contributing to the user's {% data variables.product.prodname_code_quality_short %} license usage. | +| Last pushed date | The push date recorded for the user's license usage in the repository, in `YYYY-MM-DD` format. A hyphen (`-`) indicates that the date is unknown. | +| Last pushed email | The user's Git author email address. | + +A user can appear in multiple rows if they contributed to multiple repositories. Each user consumes one {% data variables.product.prodname_code_quality_short %} license across the organization or enterprise, regardless of how many repositories they contribute to. Do not use the number of rows as the license count. + +The report shows current active committers, not all licenses billed during a billing period. For details of how license usage affects your bill, see [AUTOTITLE](/billing/concepts/product-billing/github-code-quality). + +{% endif %} + ## {% data variables.product.prodname_AS %} license report The CSV file contains information about each user who is currently consuming a license. The most recent commit by each of these users to repositories with paid security features enabled is reported. diff --git a/content/code-security/how-tos/maintain-quality-code/view-and-manage-cost.md b/content/code-security/how-tos/maintain-quality-code/view-and-manage-cost.md index 1485db7b900c..730e3af4b978 100644 --- a/content/code-security/how-tos/maintain-quality-code/view-and-manage-cost.md +++ b/content/code-security/how-tos/maintain-quality-code/view-and-manage-cost.md @@ -36,6 +36,7 @@ It's important to understand how {% data variables.product.prodname_code_quality {% data variables.product.prodname_code_quality_short %} usage appears in the **same billing and usage views as your other products**, not in a separate {% data variables.product.prodname_code_quality_short %} meter. Where you look depends on how granular a breakdown you need: +* **Committers consuming licenses**: Download the {% data variables.product.prodname_code_quality_short %} license report from the **Licensing** page under **Billing & licensing**. The CSV lists active committers and the repositories contributing to their license usage. See [AUTOTITLE](/billing/how-tos/products/download-license-use). * **For a repository- or organization-level breakdown, download the billing usage report** from the "Billing and licensing" tab. This is the only place you can attribute {% data variables.product.prodname_code_quality_short %} spend, including {% data variables.product.prodname_actions %} minutes, down to a specific repository or organization. There's no equivalent view in the UI. See [AUTOTITLE](/billing/how-tos/products/view-productlicense-use). * **For {% data variables.product.prodname_code_quality_short %}'s {% data variables.product.prodname_ai_credits_short %} usage over time, use the AI usage page** and group it by **Product** using the dropdown at the top right. This separates {% data variables.product.prodname_code_quality_short %} from your other AI products, like {% data variables.product.prodname_copilot_short %}, so you can track its share of the pool. To monitor the pool as a whole instead, see [AUTOTITLE](/copilot/concepts/billing-and-usage/organizations-and-enterprises/billing).