Skip to content

Commit

Permalink
Add content for 'Enablement trends report (for security products)' (#…
Browse files Browse the repository at this point in the history
…49989)

Co-authored-by: github-actions <github-actions@github.com>
Co-authored-by: Felicity Chapman <felicitymay@github.com>
  • Loading branch information
3 people authored Apr 8, 2024
1 parent 0420def commit 9a4e847
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 1 deletion.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,15 @@ You can use security overview to see which repositories and teams have already e
You can download a CSV file of the data displayed on the "Security coverage" page. This data file can be used for efforts like security research and in-depth data analysis, and can integrate easily with external datasets. For more information, see "[AUTOTITLE](/code-security/security-overview/exporting-data-from-the-risk-and-coverage-pages)."
{% endif %}

{% ifversion security-overview-tool-adoption %}

You can use the "Enablement trends" (beta) view to see enablement status and enablement status trends over time for {% data variables.product.prodname_dependabot %}, {% data variables.product.prodname_code_scanning %}, or {% data variables.product.prodname_secret_scanning %} for repositories in an organization. For each of these features, you can view a graph visualizing the percentage of repositories that have the feature enabled, as well as a detailed table with enablement percentages for different points in time. For more information, see "[Viewing enablement trends for an organization (beta)](#viewing-enablement-trends-for-an-organization-beta)."

{% endif %}

## Viewing the enablement of code security features for an organization

{% data reusables.security-overview.information-varies-GHAS %}
You can view data to assess the enablement of code security features across organizations in an enterprise. {% data reusables.security-overview.information-varies-GHAS %}

{% ifversion dependabot-updates-paused-enterprise-orgs %}

Expand Down Expand Up @@ -73,6 +79,30 @@ In the enterprise-level view, you can view data about the enablement of features

{% endif %}

{% ifversion security-overview-tool-adoption %}

## Viewing enablement trends for an organization (beta)

{% note %}

**Note:** The "Enablement trends" view is currently in beta and is subject to change.

{% endnote %}

You can view data to assess the enablement status and enablement status trends of code security features for an organization.

{% data reusables.organizations.navigate-to-org %}
{% data reusables.organizations.security-overview %}
1. In the sidebar, under "Metrics", click **{% octicon "meter" aria-hidden="true" %} Enablement trends**.
1. Click on one of the tabs for "{% data variables.product.prodname_dependabot %}", "{% data variables.product.prodname_code_scanning_caps %}", or "{% data variables.product.prodname_secret_scanning_caps %}" to view enablement trends and the percentage of repositories in your organization with that feature enabled. This data is displayed as a graph and a detailed table.
1. Optionally, use the options at the top of the "Enablement trends" (beta) view page to filter the group of repositories you want to see enablement trends for.
- Use the date picker to set the time range that you want to view enablement trends for.
- Click in the search box to add further filters on the enablement trends displayed. The filters you can apply are the same as those for the "Overview" dashboard (beta) view. For more information, see "[AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview)."

![Screenshot of the beta "Enablement trends" view for an organization, showing Dependabot status and trends over 30 days, with a filter applied.](/assets/images/help/security-overview/security-overview-enablement-trends.png)

{% endif %}

## Interpreting and acting on the enablement data

Some code security features can and should be enabled on all repositories. For example, {% data variables.secret-scanning.alerts %} and push protection reduce the risk of a security leak no matter what information is stored in the repository. If you see repositories that don't already use these features, you should either enable them or discuss an enablement plan with the team who owns the repository. For information on enabling features for a whole organization, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)."
Expand Down
5 changes: 5 additions & 0 deletions data/features/security-overview-tool-adoption.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Reference: #13509
# Documentation for the Enablement trends report (for security products) [Public Beta]
versions:
ghes: '>3.12'
ghec: '*'

0 comments on commit 9a4e847

Please sign in to comment.