Skip to content

Commit

Permalink
[MEGABRANCH] Add content for GHAS security configurations public beta…
Browse files Browse the repository at this point in the history
… (#49364)

Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com>
Co-authored-by: Anne-Marie <102995847+am-stead@users.noreply.github.com>
Co-authored-by: Felicity Chapman <felicitymay@github.com>
Co-authored-by: github-actions <github-actions@github.com>
Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
Co-authored-by: Dorothy Mitchell <19343236+dorothymitchell@users.noreply.github.com>
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
  • Loading branch information
8 people authored Apr 2, 2024
1 parent 836e92a commit eca583d
Show file tree
Hide file tree
Showing 57 changed files with 1,016 additions and 27 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 @@ -16,7 +16,15 @@ shortTitle: Manage GitHub Advanced Security

## About management of {% data variables.product.prodname_advanced_security %} features

You can use {% data variables.product.prodname_advanced_security %} features to harden security for the organizations in your enterprise. To streamline management of {% data variables.product.prodname_advanced_security %}, you can enable or disable each feature for all existing and/or new repositories within the organizations owned by your enterprise.
You can use {% data variables.product.prodname_advanced_security %} features to harden security for the organizations in your enterprise. {% ifversion security-configurations %}{% data reusables.security-configurations.enable-security-features-with-gh-config %}

{% note %}

**Note:** {% data reusables.security-configurations.security-configurations-beta-note-short %}

{% endnote %}

To manage individual {% data variables.product.prodname_GH_advanced_security %} features, {% else %}To streamline management of {% data variables.product.prodname_advanced_security %}, {% endif %}you can enable or disable each feature for all existing and/or new repositories within the organizations owned by your enterprise.

{% ifversion secret-scanning-enterprise-level-api %}{% data reusables.secret-scanning.secret-scanning-enterprise-level-api %}{% endif %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ shortTitle: Advanced Security billing

{% ifversion fpt %}

If you want to use {% data variables.product.prodname_GH_advanced_security %} features on any repository apart from a public repository on {% data variables.product.prodname_dotcom_the_website %}, you will need a {% data variables.product.prodname_GH_advanced_security %} license, available with {% data variables.product.prodname_ghe_cloud %} or {% data variables.product.prodname_ghe_server %}. {% data reusables.advanced-security.ghas-trial %}
{% data reusables.advanced-security.ghas-license-info-for-fpt %}

{% note %}

Expand All @@ -37,6 +37,17 @@ For information about billing for {% data variables.product.prodname_GH_advanced

If you want to use {% data variables.product.prodname_GH_advanced_security %} features on any repository apart from a public repository on {% data variables.product.prodname_dotcom_the_website %}, you will need a {% data variables.product.prodname_GH_advanced_security %} license. For more information about {% data variables.product.prodname_GH_advanced_security %}, see "[AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security)."

{% ifversion security-configurations %}
{% data reusables.security-configurations.managing-GHAS-licenses %}

{% note %}

**Note:** {% data reusables.security-configurations.security-configurations-beta-note-short %}

{% endnote %}

{% endif %}

{% data reusables.advanced-security.ghas-trial-availability %} For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-advanced-security/setting-up-a-trial-of-github-advanced-security)."

{% data reusables.advanced-security.ghas-trial-invoiced %}
Expand All @@ -47,6 +58,17 @@ For other billing-related questions, contact {% data variables.contact.github_su

You can make extra features for code security available to users by buying and uploading a license for {% data variables.product.prodname_GH_advanced_security %}. For more information about {% data variables.product.prodname_GH_advanced_security %}, see "[AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security)."

{% ifversion security-configurations %}
{% data reusables.security-configurations.managing-GHAS-licenses %}

{% note %}

**Note:** {% data reusables.security-configurations.security-configurations-beta-note-short %}

{% endnote %}

{% endif %}

{% endif %}

{% ifversion ghes or ghec %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,17 @@ shortTitle: Manage Advanced Security licensing

Each license for {% data variables.product.prodname_GH_advanced_security %} specifies a maximum number of accounts that can use these features. Each active committer to at least one repository with the feature enabled uses one {% ifversion ghas-billing-UI-update %}license{% else %}seat{% endif %}. A committer is considered active if one of their commits has been pushed to the repository within the last 90 days, regardless of when it was originally authored. For more information about committer numbers, see "[AUTOTITLE](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)." For information about purchasing a license, see "[AUTOTITLE](/billing/managing-billing-for-github-advanced-security/signing-up-for-github-advanced-security)."

## Managing the number of GitHub Advanced Security committers
## Managing the number of committers in your subscription

{% ifversion security-configurations %}
{% note %}

**Note:** {% data reusables.security-configurations.managing-GHAS-licenses %}

{% data reusables.security-configurations.security-configurations-beta-note-short %}

{% endnote %}
{% endif %}

{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.settings-tab %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,16 @@ You can view the enterprise account's current {% ifversion ghas-billing-UI-updat

If you run out of licenses, the section will be red and show "Limit exceeded." You should either reduce your use of {% data variables.product.prodname_GH_advanced_security %} or purchase more licenses. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security#getting-the-most-out-of-github-advanced-security)" and "[AUTOTITLE](/billing/managing-billing-for-github-advanced-security/managing-your-github-advanced-security-licensing)."

{% ifversion security-configurations %}
{% note %}

**Note:** {% data reusables.security-configurations.managing-GHAS-licenses %}

{% data reusables.security-configurations.security-configurations-beta-note-short %}

{% endnote %}
{% endif %}

{% elsif ghes %}

{% data reusables.enterprise-accounts.access-enterprise %}
Expand All @@ -66,6 +76,15 @@ You can view the enterprise account's current {% ifversion ghas-billing-UI-updat

For more information, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)."

{% ifversion security-configurations %}
{% note %}

**Note:** {% data reusables.security-configurations.managing-GHAS-licenses %}

{% data reusables.security-configurations.security-configurations-beta-note-short %}

{% endnote %}
{% endif %}
{% endif %}

## Downloading {% data variables.product.prodname_GH_advanced_security %} license usage information
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Adopting GitHub Advanced Security at scale
shortTitle: Adopting GHAS at scale
shortTitle: Adopt GHAS at scale
intro: A phased approach to rolling out GitHub Advanced Security at your company using industry and GitHub best practices.
versions:
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,20 @@ If you haven't already enabled GHAS for your {% data variables.product.prodname_

You need to enable GHAS for each pilot project, either by enabling the GHAS features for each repository or for all repositories in any organizations taking part in the pilot. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)" or "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)"

{% ifversion security-configurations %}

## Piloting all {% data variables.product.prodname_GH_advanced_security %} features (beta)

{% data reusables.security-configurations.enable-security-features-with-gh-config %}

{% note %}

**Note:** {% data reusables.security-configurations.security-configurations-beta-note-short %}

{% endnote %}

{% endif %}

## Piloting {% data variables.product.prodname_code_scanning %}

{% ifversion ghes %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,16 @@ This article is part of a series on adopting {% data variables.product.prodname_

{% endnote %}

{% ifversion security-configurations %}
{% note %}

**Note:** {% data reusables.security-configurations.enable-security-features-with-gh-config %}

{% data reusables.security-configurations.security-configurations-beta-note-short %}

{% endnote %}
{% endif %}

## Enabling code scanning

{% ifversion default-setup-ghas-enablement %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,16 @@ This article is part of a series on adopting {% data variables.product.prodname_

You can enable secret scanning for individual repositories or for all repositories in an organization or enterprise. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)", "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)", or "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise)."

{% ifversion security-configurations %}
{% note %}

**Note:** {% data reusables.security-configurations.enable-security-features-with-gh-config %}

{% data reusables.security-configurations.security-configurations-beta-note-short %}

{% endnote %}
{% endif %}

This article explains a high-level process focusing on enabling {% data variables.product.prodname_secret_scanning %} for all repositories in an organization. The principles described in this article can still be applied even if you take a more staggered approach of enabling {% data variables.product.prodname_secret_scanning %} for individual repositories.

## 1. Focus on newly committed secrets
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,7 @@ shortTitle: Dependabot quickstart

This quickstart guide walks you through setting up and enabling {% data variables.product.prodname_dependabot %} and viewing {% data variables.product.prodname_dependabot_alerts %} and updates for a repository.

{% data variables.product.prodname_dependabot %} consists of three different features that help you manage your dependencies:

- {% data variables.product.prodname_dependabot_alerts %}—inform you about vulnerabilities in the dependencies that you use in your repository.
- {% data variables.product.prodname_dependabot_security_updates %}—automatically raise pull requests to update the dependencies you use that have known security vulnerabilities.
- {% data variables.product.prodname_dependabot_version_updates %}—automatically raise pull requests to keep your dependencies up-to-date.
{% data reusables.dependabot.dependabot-overview %}

## Prerequisites

Expand Down
4 changes: 2 additions & 2 deletions content/code-security/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ topics:
children:
- /github-security-features
- /dependabot-quickstart-guide
- /securing-your-repository
- /securing-your-organization
- /quickstart-for-securing-your-repository
- /quickstart-for-securing-your-organization
- /adding-a-security-policy-to-your-repository
- /auditing-security-alerts
- /best-practices-for-preventing-data-leaks-in-your-organization
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Securing your organization
title: Quickstart for securing your organization
intro: "You can use a number of {% data variables.product.prodname_dotcom %} features to help keep your organization secure."
permissions: Organization owners and security managers can manage security features for an organization.
redirect_from:
- /code-security/getting-started/securing-your-organization
versions:
fpt: "*"
ghes: "*"
Expand All @@ -12,7 +14,7 @@ topics:
- Dependencies
- Vulnerabilities
- Advanced Security
shortTitle: Secure your organization
shortTitle: Secure organization quickstart
---

## Introduction
Expand Down Expand Up @@ -49,7 +51,16 @@ There are some features you must configure for each repository individually. For

When you have decided to enable a security feature, the next step is to decide how to roll out that feature across your organization.

- If you want to roll out a feature as quickly as possible, you can enable it for all eligible repositories at once. For more information, see "[Enabling a feature for all repositories](#enabling-a-feature-for-all-repositories)."
{% ifversion security-configurations %}
- If you want to enable multiple security features at scale, you can use the {% data variables.product.prodname_github_security_configuration %}, a collection of security enablement settings you can apply to repositories in your organization. See "[AUTOTITLE](/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)."

{% note %}

**Note:** {% data reusables.security-configurations.security-configurations-beta-note-short %}

{% endnote %}
{% endif %}
- If you want to roll out a {% ifversion security-configurations %}single {% endif %}feature as quickly as possible, you can enable it for all eligible repositories at once. For more information, see "[Enabling a feature for all repositories](#enabling-a-feature-for-all-repositories)."
- If you want control over how quickly you roll out a feature, and which features are enabled in which repositories, you can enable a feature for a selection of repositories. For more information, see "[Enabling a feature for a selection of repositories](#enabling-a-feature-for-a-selection-of-repositories)."

When you have decided how to enable a feature for your organization's existing repositories, you must also decide how to handle any new repositories that are created in your organization in the future. For more information, see "[Enabling a feature for new repositories](#enabling-a-feature-for-new-repositories)."
Expand Down Expand Up @@ -94,7 +105,7 @@ If you're not sure about the impact a feature will have, you may want to test th

On this view, you can use checkboxes to select specific repositories, or you can use the search bar to find the repositories where you want to enable a feature. For example, you can use filters to identify repositories where a certain team has write or admin access, or exclude repositories that don't require the same level of protection, such as test repositories or repositories for internal documentation. Then you can enable features for all selected repositories at once. For more information, see "[AUTOTITLE](/code-security/security-overview/enabling-security-features-for-multiple-repositories)."

{% else %}When you have identified the repositories that require a feature, you can enable the feature for each repository individually. As an organization owner or security manager, you can configure the security settings for each repository in your organization. For more information, see "[AUTOTITLE](/code-security/getting-started/securing-your-repository)."
{% else %}When you have identified the repositories that require a feature, you can enable the feature for each repository individually. As an organization owner or security manager, you can configure the security settings for each repository in your organization. For more information, see "[AUTOTITLE](/code-security/getting-started/quickstart-for-securing-your-repository)."

{% ifversion fpt %}For organizations on {% data variables.product.prodname_ghe_cloud %}, you can use the "Security coverage" view to identify repositories that require a feature, then enable that feature for those repositories. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/code-security/security-overview/enabling-security-features-for-multiple-repositories)" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: Securing your repository
title: Quickstart for securing your repository
intro: 'You can use a number of {% data variables.product.prodname_dotcom %} features to help keep your repository secure.'
permissions: Repository administrators and organization owners can configure repository security settings.
redirect_from:
- /github/administering-a-repository/about-securing-your-repository
- /github/code-security/getting-started/about-securing-your-repository
- /code-security/getting-started/securing-your-repository
versions:
fpt: '*'
ghes: '*'
Expand All @@ -15,7 +16,7 @@ topics:
- Dependencies
- Vulnerabilities
- Advanced Security
shortTitle: Secure your repository
shortTitle: Secure repository quickstart
---

## Introduction
Expand Down Expand Up @@ -79,7 +80,7 @@ For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-aler

Dependency review lets you visualize dependency changes in pull requests before they are merged into your repositories. For more information, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)."

Dependency review is a {% data variables.product.prodname_GH_advanced_security %} feature. {% ifversion fpt or ghec %}Dependency review is already enabled for all public repositories. {% ifversion fpt %}Organizations that use {% data variables.product.prodname_ghe_cloud %} with {% data variables.product.prodname_advanced_security %} can additionally enable dependency review for private and internal repositories. For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/code-security/getting-started/securing-your-repository#managing-dependency-review). {% endif %}{% endif %}{% ifversion ghec or ghes %}To enable dependency review for a {% ifversion ghec %}private or internal {% endif %}repository, ensure that the dependency graph is enabled and enable {% data variables.product.prodname_GH_advanced_security %}.
Dependency review is a {% data variables.product.prodname_GH_advanced_security %} feature. {% ifversion fpt or ghec %}Dependency review is already enabled for all public repositories. {% ifversion fpt %}Organizations that use {% data variables.product.prodname_ghe_cloud %} with {% data variables.product.prodname_advanced_security %} can additionally enable dependency review for private and internal repositories. For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/code-security/getting-started/quickstart-for-securing-your-repository#managing-dependency-review). {% endif %}{% endif %}{% ifversion ghec or ghes %}To enable dependency review for a {% ifversion ghec %}private or internal {% endif %}repository, ensure that the dependency graph is enabled and enable {% data variables.product.prodname_GH_advanced_security %}.

1. From the main page of your repository, click **{% octicon "gear" aria-label="The Settings gear" %}Settings**.
1. Click **Security & analysis**.
Expand Down
Loading

0 comments on commit eca583d

Please sign in to comment.