Skip to content

Commit

Permalink
Merge pull request github#35066 from github/repo-sync
Browse files Browse the repository at this point in the history
Repo sync
  • Loading branch information
docs-bot authored Oct 24, 2024
2 parents bd3a19e + fb6361b commit 4ab3784
Show file tree
Hide file tree
Showing 16 changed files with 81 additions and 17 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Exporting data from security overview
shortTitle: Export data
intro: You can export CSV files of your organization's{% ifversion security-overview-export-dashboard-data %} overview,{% endif %} risk and coverage data from security overview.
intro: You can export CSV files of your organization's overview, risk, coverage, and {% data variables.product.prodname_codeql %} pull request alerts data from security overview.
permissions: '{% data reusables.permissions.security-overview %}'
versions:
feature: security-overview-export-data
Expand All @@ -20,7 +20,7 @@ redirect_from:

{% data reusables.security-overview.download-csv-files %}

{% ifversion security-overview-export-dashboard-data %}The overview page contains data about security alerts across your organization, while the risk and coverage pages contain data about repositories and how they are affected by security alerts or covered by security features.{% endif %}
The overview page contains data about security alerts across your organization, while the risk and coverage pages contain data about repositories and how they are affected by security alerts or covered by security features. The {% data variables.product.prodname_codeql %} pull request alerts page contains data about {% data variables.product.prodname_codeql %} alerts that were caught in pull requests merged to the default branch.

The CSV file you download will contain data corresponding to the filters you have applied to security overview. For example, if you add the filter `dependabot-alerts:enabled`, your file will only contain data for repositories that have enabled {% data variables.product.prodname_dependabot_alerts %}.

Expand All @@ -35,10 +35,10 @@ The CSV file you download will contain data corresponding to the filters you hav
{% data reusables.profile.access_org %}
1. In the "Organizations" section, select the organization for which you would like to download security overview data.
{% data reusables.organizations.security-overview %}
1. In the "Security" sidebar, choose the page that you want to export data from by clicking on {% ifversion security-overview-export-dashboard-data %}**{% octicon "graph" aria-hidden="true" %}Overview**, {% endif %}**{% octicon "meter" aria-hidden="true" %} Coverage** or **{% octicon "shield" aria-hidden="true" %} Risk**.
1. In the "Security" sidebar, choose the page that you want to export data from by clicking on **{% octicon "graph" aria-hidden="true" %}Overview**, **{% octicon "meter" aria-hidden="true" %} Coverage**, **{% octicon "shield" aria-hidden="true" %} Risk** or **{% octicon "graph" aria-hidden="true" %} {% data variables.product.prodname_codeql %} pull request alerts**.
1. Next to the search bar, click {% octicon "download" aria-hidden="true" %} **Export CSV**.

It may take a moment for {% data variables.product.product_name %} to generate the CSV file of your data. Once the CSV file generates, the file will automatically start downloading, and a banner will appear confirming your report is ready. {% ifversion security-overview-export-dashboard-data %}If you are downloading the CSV from the overview page, you will also receive an email when your report is ready, containing a link to download the CSV.{% endif %}
It may take a moment for {% data variables.product.product_name %} to generate the CSV file of your data. Once the CSV file generates, the file will automatically start downloading, and a banner will appear confirming your report is ready. If you are downloading the CSV from the overview page, you will also receive an email when your report is ready, containing a link to download the CSV.

{% ifversion secret-scanning-non-provider-patterns %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,5 @@ You can apply filters to the data. The metrics are based on activity from the de
* At the top of the page, next to the search box, click {% octicon "filter" aria-hidden="true" %} **Filter**.
* Click {% octicon "plus" aria-hidden="true" %} **Add a filter**, then select a filter from the dropdown menu.
* To search for repositories matching the selected filter, fill out the available fields for that filter, then click **Apply**. You can repeat this process to add as many filters as you would like to your search.
* Optionally, to remove a filter from your search, click {% octicon "filter" aria-hidden="true" %} **Filter**. In the row of the filter you want to remove, click {% octicon "x" aria-label="Delete FILTER-NUMBER: FILTER-PROPERTIES" %}, then click **Apply**.
* Optionally, to remove a filter from your search, click {% octicon "filter" aria-hidden="true" %} **Filter**. In the row of the filter you want to remove, click {% octicon "x" aria-label="Delete FILTER-NUMBER: FILTER-PROPERTIES" %}, then click **Apply**.{% ifversion security-overview-export-data %}
1. You can use the {% octicon "download" aria-hidden="true" %} **Export CSV** button to download a CSV file of the data currently displayed on the page for security research and in-depth data analysis. For more information, see "[AUTOTITLE](/code-security/security-overview/exporting-data-from-security-overview)." {% endif %}
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,7 @@ To see all available chat variables, type `#` in the chat prompt box. See also [
## Using {% data variables.product.prodname_dotcom %} skills for {% data variables.product.prodname_copilot_short %}

> [!NOTE]
> * The `@github` chat participant is currently in {% data variables.release-phases.public_preview %} and is subject to change.
> * This functionality is available with {% data variables.product.prodname_copilot_chat_short %} v0.20.3 or later and {% data variables.product.prodname_vscode_shortname %} or {% data variables.product.prodname_vscode_shortname %} Insiders 1.93 or later.
> This functionality is available with the {% data variables.product.prodname_copilot_chat_short %} extension v0.20.3 or later and {% data variables.product.prodname_vscode_shortname %} or {% data variables.product.prodname_vscode_shortname %} Insiders 1.93 or later.
{% data variables.product.prodname_copilot_short %} has a collection of {% data variables.product.prodname_dotcom %}-specific skills that it can use to answer your questions. To access these skills in {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vscode_shortname %}, include `@github` in your question.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
### Leveraging a web search to answer a question

> [!NOTE]
> * Bing search integration in {% data variables.product.prodname_copilot_chat_short %} is currently in {% data variables.release-phases.public_preview %} and is subject to change.
> * The `@github` chat participant in {% data variables.product.prodname_vscode_shortname %} and {% data variables.product.prodname_vs %} is currently in {% data variables.release-phases.public_preview %} and is subject to change. For more information, see "[Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms)."
> Bing search integration in {% data variables.product.prodname_copilot_chat_short %} is currently in {% data variables.release-phases.public_preview %} and is subject to change.
When you use the `@github` chat participant, {% data variables.product.prodname_copilot_chat %} can use a Bing search to help answer your question if this has been enabled by your administrator.

Expand Down
2 changes: 1 addition & 1 deletion data/reusables/security-overview/download-csv-files.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
You can download comma-separated values (CSV) files containing data from the {% ifversion security-overview-export-dashboard-data %} overview, {% endif %}risk and coverage pages of your organization's security overview. These files can be used for efforts like security research and in-depth data analysis, and can integrate easily with external datasets.
You can download comma-separated values (CSV) files containing data from the "Overview", "Risk", "Coverage" and "{% data variables.product.prodname_codeql %} pull request alerts" pages of your organization's security overview. These files can be used for efforts like security research and in-depth data analysis, and can integrate easily with external datasets.
5 changes: 5 additions & 0 deletions src/audit-logs/data/fpt/organization.json
Original file line number Diff line number Diff line change
Expand Up @@ -3024,6 +3024,11 @@
"description": "GitHub detected a secret and created a secret scanning alert.",
"docs_reference_links": "/code-security/secret-scanning/managing-alerts-from-secret-scanning"
},
{
"action": "secret_scanning_alert.public_leak",
"description": "A secret scanning alert was leaked in a public repo.",
"docs_reference_links": "/code-security/secret-scanning/managing-alerts-from-secret-scanning"
},
{
"action": "secret_scanning_alert.reopen",
"description": "A secret scanning alert was reopened.",
Expand Down
10 changes: 10 additions & 0 deletions src/audit-logs/data/fpt/user.json
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,21 @@
"description": "A CSV export was requested on the \"CodeQL pull request alerts\" page.",
"docs_reference_links": "N/A"
},
{
"action": "business.security_center_export_coverage",
"description": "A CSV export was requested on the \"Coverage\" page.",
"docs_reference_links": "N/A"
},
{
"action": "business.security_center_export_overview_dashboard",
"description": "A CSV export was requested on the \"Overview Dashboard\" page.",
"docs_reference_links": "N/A"
},
{
"action": "business.security_center_export_risk",
"description": "A CSV export was requested on the \"Risk\" page.",
"docs_reference_links": "N/A"
},
{
"action": "business.set_actions_fork_pr_approvals_policy",
"description": "The policy for requiring approvals for workflows from public forks was changed for an enterprise.",
Expand Down
37 changes: 36 additions & 1 deletion src/audit-logs/data/ghec/enterprise.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
},
{
"action": "api.request",
"description": "An API request was made to a security-significant endpoint for the enterprise. This event is only included if API Request Events is enabled in the enterprise's audit log settings. This event is only available via audit log streaming.",
"description": "An API request was made to an endpoint for the enterprise, or an enterprise owned resource. This event is only included if API Request Events is enabled in the enterprise's audit log settings. This event is only available via audit log streaming.",
"docs_reference_links": "/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise#enabling-audit-log-streaming-of-api-requests"
},
{
Expand Down Expand Up @@ -564,11 +564,21 @@
"description": "A CSV export was requested on the \"CodeQL pull request alerts\" page.",
"docs_reference_links": "N/A"
},
{
"action": "business.security_center_export_coverage",
"description": "A CSV export was requested on the \"Coverage\" page.",
"docs_reference_links": "N/A"
},
{
"action": "business.security_center_export_overview_dashboard",
"description": "A CSV export was requested on the \"Overview Dashboard\" page.",
"docs_reference_links": "N/A"
},
{
"action": "business.security_center_export_risk",
"description": "A CSV export was requested on the \"Risk\" page.",
"docs_reference_links": "N/A"
},
{
"action": "business.set_actions_fork_pr_approvals_policy",
"description": "The policy for requiring approvals for workflows from public forks was changed for an enterprise.",
Expand Down Expand Up @@ -3664,6 +3674,26 @@
"description": "Secret scanning push protection was enabled for a repository.",
"docs_reference_links": "/code-security/secret-scanning/protecting-pushes-with-secret-scanning"
},
{
"action": "repository_security_configuration.applied",
"description": "A code security configuration was applied to a repository.",
"docs_reference_links": "N/A"
},
{
"action": "repository_security_configuration.failed",
"description": "A code security configuration failed to attach to the repository.",
"docs_reference_links": "N/A"
},
{
"action": "repository_security_configuration.removed",
"description": "A code security configuration was removed from a repository.",
"docs_reference_links": "N/A"
},
{
"action": "repository_security_configuration.removed_by_settings_change",
"description": "A code security configuration was removed due to a change in repository or enterprise settings.",
"docs_reference_links": "N/A"
},
{
"action": "repository_visibility_change.clear",
"description": "The repository visibility change setting was cleared for an organization or enterprise.",
Expand Down Expand Up @@ -3779,6 +3809,11 @@
"description": "GitHub detected a secret and created a secret scanning alert.",
"docs_reference_links": "/code-security/secret-scanning/managing-alerts-from-secret-scanning"
},
{
"action": "secret_scanning_alert.public_leak",
"description": "A secret scanning alert was leaked in a public repo.",
"docs_reference_links": "/code-security/secret-scanning/managing-alerts-from-secret-scanning"
},
{
"action": "secret_scanning_alert.reopen",
"description": "A secret scanning alert was reopened.",
Expand Down
5 changes: 5 additions & 0 deletions src/audit-logs/data/ghec/organization.json
Original file line number Diff line number Diff line change
Expand Up @@ -3024,6 +3024,11 @@
"description": "GitHub detected a secret and created a secret scanning alert.",
"docs_reference_links": "/code-security/secret-scanning/managing-alerts-from-secret-scanning"
},
{
"action": "secret_scanning_alert.public_leak",
"description": "A secret scanning alert was leaked in a public repo.",
"docs_reference_links": "/code-security/secret-scanning/managing-alerts-from-secret-scanning"
},
{
"action": "secret_scanning_alert.reopen",
"description": "A secret scanning alert was reopened.",
Expand Down
10 changes: 10 additions & 0 deletions src/audit-logs/data/ghec/user.json
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,21 @@
"description": "A CSV export was requested on the \"CodeQL pull request alerts\" page.",
"docs_reference_links": "N/A"
},
{
"action": "business.security_center_export_coverage",
"description": "A CSV export was requested on the \"Coverage\" page.",
"docs_reference_links": "N/A"
},
{
"action": "business.security_center_export_overview_dashboard",
"description": "A CSV export was requested on the \"Overview Dashboard\" page.",
"docs_reference_links": "N/A"
},
{
"action": "business.security_center_export_risk",
"description": "A CSV export was requested on the \"Risk\" page.",
"docs_reference_links": "N/A"
},
{
"action": "business.set_actions_fork_pr_approvals_policy",
"description": "The policy for requiring approvals for workflows from public forks was changed for an enterprise.",
Expand Down
2 changes: 1 addition & 1 deletion src/audit-logs/data/ghes-3.11/enterprise.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
},
{
"action": "api.request",
"description": "An API request was made to a security-significant endpoint for the enterprise. This event is only included if API Request Events is enabled in the enterprise's audit log settings. This event is only available via audit log streaming.",
"description": "An API request was made to an endpoint for the enterprise, or an enterprise owned resource. This event is only included if API Request Events is enabled in the enterprise's audit log settings. This event is only available via audit log streaming.",
"docs_reference_links": "/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise#enabling-audit-log-streaming-of-api-requests"
},
{
Expand Down
2 changes: 1 addition & 1 deletion src/audit-logs/data/ghes-3.12/enterprise.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
},
{
"action": "api.request",
"description": "An API request was made to a security-significant endpoint for the enterprise. This event is only included if API Request Events is enabled in the enterprise's audit log settings. This event is only available via audit log streaming.",
"description": "An API request was made to an endpoint for the enterprise, or an enterprise owned resource. This event is only included if API Request Events is enabled in the enterprise's audit log settings. This event is only available via audit log streaming.",
"docs_reference_links": "/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise#enabling-audit-log-streaming-of-api-requests"
},
{
Expand Down
2 changes: 1 addition & 1 deletion src/audit-logs/data/ghes-3.13/enterprise.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
},
{
"action": "api.request",
"description": "An API request was made to a security-significant endpoint for the enterprise. This event is only included if API Request Events is enabled in the enterprise's audit log settings. This event is only available via audit log streaming.",
"description": "An API request was made to an endpoint for the enterprise, or an enterprise owned resource. This event is only included if API Request Events is enabled in the enterprise's audit log settings. This event is only available via audit log streaming.",
"docs_reference_links": "/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise#enabling-audit-log-streaming-of-api-requests"
},
{
Expand Down
2 changes: 1 addition & 1 deletion src/audit-logs/data/ghes-3.14/enterprise.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
},
{
"action": "api.request",
"description": "An API request was made to a security-significant endpoint for the enterprise. This event is only included if API Request Events is enabled in the enterprise's audit log settings. This event is only available via audit log streaming.",
"description": "An API request was made to an endpoint for the enterprise, or an enterprise owned resource. This event is only included if API Request Events is enabled in the enterprise's audit log settings. This event is only available via audit log streaming.",
"docs_reference_links": "/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise#enabling-audit-log-streaming-of-api-requests"
},
{
Expand Down
2 changes: 1 addition & 1 deletion src/audit-logs/data/ghes-3.15/enterprise.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
},
{
"action": "api.request",
"description": "An API request was made to a security-significant endpoint for the enterprise. This event is only included if API Request Events is enabled in the enterprise's audit log settings. This event is only available via audit log streaming.",
"description": "An API request was made to an endpoint for the enterprise, or an enterprise owned resource. This event is only included if API Request Events is enabled in the enterprise's audit log settings. This event is only available via audit log streaming.",
"docs_reference_links": "/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise#enabling-audit-log-streaming-of-api-requests"
},
{
Expand Down
2 changes: 1 addition & 1 deletion src/audit-logs/lib/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
"apiOnlyEvents": "This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.",
"apiRequestEvent": "This event is only available via audit log streaming."
},
"sha": "30a09f504125749aff6a164e2f7a4518c5096b2d"
"sha": "50b493f0914184eb8479e18ead886625a6fc2ed6"
}

0 comments on commit 4ab3784

Please sign in to comment.