Skip to content

Commit eca583d

Browse files
sabrowning1saritaiam-steadfelicitymaygithub-actions
authored
[MEGABRANCH] Add content for GHAS security configurations public beta (#49364)
Co-authored-by: Sarita Iyer <[email protected]> Co-authored-by: Anne-Marie <[email protected]> Co-authored-by: Felicity Chapman <[email protected]> Co-authored-by: github-actions <[email protected]> Co-authored-by: Ben Ahmady <[email protected]> Co-authored-by: Dorothy Mitchell <[email protected]> Co-authored-by: mc <[email protected]>
1 parent 836e92a commit eca583d

File tree

57 files changed

+1016
-27
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+1016
-27
lines changed
Loading
Loading

content/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,15 @@ shortTitle: Manage GitHub Advanced Security
1616

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

19-
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.
19+
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 %}
20+
21+
{% note %}
22+
23+
**Note:** {% data reusables.security-configurations.security-configurations-beta-note-short %}
24+
25+
{% endnote %}
26+
27+
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.
2028

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

content/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security.md

+23-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ shortTitle: Advanced Security billing
2323

2424
{% ifversion fpt %}
2525

26-
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 %}
26+
{% data reusables.advanced-security.ghas-license-info-for-fpt %}
2727

2828
{% note %}
2929

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

3838
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)."
3939

40+
{% ifversion security-configurations %}
41+
{% data reusables.security-configurations.managing-GHAS-licenses %}
42+
43+
{% note %}
44+
45+
**Note:** {% data reusables.security-configurations.security-configurations-beta-note-short %}
46+
47+
{% endnote %}
48+
49+
{% endif %}
50+
4051
{% 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)."
4152

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

4859
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)."
4960

61+
{% ifversion security-configurations %}
62+
{% data reusables.security-configurations.managing-GHAS-licenses %}
63+
64+
{% note %}
65+
66+
**Note:** {% data reusables.security-configurations.security-configurations-beta-note-short %}
67+
68+
{% endnote %}
69+
70+
{% endif %}
71+
5072
{% endif %}
5173

5274
{% ifversion ghes or ghec %}

content/billing/managing-billing-for-github-advanced-security/managing-your-github-advanced-security-licensing.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,17 @@ shortTitle: Manage Advanced Security licensing
1515

1616
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)."
1717

18-
## Managing the number of GitHub Advanced Security committers
18+
## Managing the number of committers in your subscription
19+
20+
{% ifversion security-configurations %}
21+
{% note %}
22+
23+
**Note:** {% data reusables.security-configurations.managing-GHAS-licenses %}
24+
25+
{% data reusables.security-configurations.security-configurations-beta-note-short %}
26+
27+
{% endnote %}
28+
{% endif %}
1929

2030
{% data reusables.enterprise-accounts.access-enterprise %}
2131
{% data reusables.enterprise-accounts.settings-tab %}

content/billing/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md

+19
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,16 @@ You can view the enterprise account's current {% ifversion ghas-billing-UI-updat
4040

4141
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)."
4242

43+
{% ifversion security-configurations %}
44+
{% note %}
45+
46+
**Note:** {% data reusables.security-configurations.managing-GHAS-licenses %}
47+
48+
{% data reusables.security-configurations.security-configurations-beta-note-short %}
49+
50+
{% endnote %}
51+
{% endif %}
52+
4353
{% elsif ghes %}
4454

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

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

79+
{% ifversion security-configurations %}
80+
{% note %}
81+
82+
**Note:** {% data reusables.security-configurations.managing-GHAS-licenses %}
83+
84+
{% data reusables.security-configurations.security-configurations-beta-note-short %}
85+
86+
{% endnote %}
87+
{% endif %}
6988
{% endif %}
7089

7190
## Downloading {% data variables.product.prodname_GH_advanced_security %} license usage information

content/code-security/adopting-github-advanced-security-at-scale/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Adopting GitHub Advanced Security at scale
3-
shortTitle: Adopting GHAS at scale
3+
shortTitle: Adopt GHAS at scale
44
intro: A phased approach to rolling out GitHub Advanced Security at your company using industry and GitHub best practices.
55
versions:
66
ghes: '*'

content/code-security/adopting-github-advanced-security-at-scale/phase-3-pilot-programs.md

+14
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,20 @@ If you haven't already enabled GHAS for your {% data variables.product.prodname_
3131

3232
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)"
3333

34+
{% ifversion security-configurations %}
35+
36+
## Piloting all {% data variables.product.prodname_GH_advanced_security %} features (beta)
37+
38+
{% data reusables.security-configurations.enable-security-features-with-gh-config %}
39+
40+
{% note %}
41+
42+
**Note:** {% data reusables.security-configurations.security-configurations-beta-note-short %}
43+
44+
{% endnote %}
45+
46+
{% endif %}
47+
3448
## Piloting {% data variables.product.prodname_code_scanning %}
3549

3650
{% ifversion ghes %}

content/code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md

+10
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,16 @@ This article is part of a series on adopting {% data variables.product.prodname_
1515

1616
{% endnote %}
1717

18+
{% ifversion security-configurations %}
19+
{% note %}
20+
21+
**Note:** {% data reusables.security-configurations.enable-security-features-with-gh-config %}
22+
23+
{% data reusables.security-configurations.security-configurations-beta-note-short %}
24+
25+
{% endnote %}
26+
{% endif %}
27+
1828
## Enabling code scanning
1929

2030
{% ifversion default-setup-ghas-enablement %}

content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md

+10
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,16 @@ This article is part of a series on adopting {% data variables.product.prodname_
1717

1818
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)."
1919

20+
{% ifversion security-configurations %}
21+
{% note %}
22+
23+
**Note:** {% data reusables.security-configurations.enable-security-features-with-gh-config %}
24+
25+
{% data reusables.security-configurations.security-configurations-beta-note-short %}
26+
27+
{% endnote %}
28+
{% endif %}
29+
2030
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.
2131

2232
## 1. Focus on newly committed secrets

content/code-security/getting-started/dependabot-quickstart-guide.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,7 @@ shortTitle: Dependabot quickstart
2020

2121
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.
2222

23-
{% data variables.product.prodname_dependabot %} consists of three different features that help you manage your dependencies:
24-
25-
- {% data variables.product.prodname_dependabot_alerts %}—inform you about vulnerabilities in the dependencies that you use in your repository.
26-
- {% data variables.product.prodname_dependabot_security_updates %}—automatically raise pull requests to update the dependencies you use that have known security vulnerabilities.
27-
- {% data variables.product.prodname_dependabot_version_updates %}—automatically raise pull requests to keep your dependencies up-to-date.
23+
{% data reusables.dependabot.dependabot-overview %}
2824

2925
## Prerequisites
3026

content/code-security/getting-started/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ topics:
1414
children:
1515
- /github-security-features
1616
- /dependabot-quickstart-guide
17-
- /securing-your-repository
18-
- /securing-your-organization
17+
- /quickstart-for-securing-your-repository
18+
- /quickstart-for-securing-your-organization
1919
- /adding-a-security-policy-to-your-repository
2020
- /auditing-security-alerts
2121
- /best-practices-for-preventing-data-leaks-in-your-organization

content/code-security/getting-started/securing-your-organization.md renamed to content/code-security/getting-started/quickstart-for-securing-your-organization.md

+15-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
2-
title: Securing your organization
2+
title: Quickstart for securing your organization
33
intro: "You can use a number of {% data variables.product.prodname_dotcom %} features to help keep your organization secure."
44
permissions: Organization owners and security managers can manage security features for an organization.
5+
redirect_from:
6+
- /code-security/getting-started/securing-your-organization
57
versions:
68
fpt: "*"
79
ghes: "*"
@@ -12,7 +14,7 @@ topics:
1214
- Dependencies
1315
- Vulnerabilities
1416
- Advanced Security
15-
shortTitle: Secure your organization
17+
shortTitle: Secure organization quickstart
1618
---
1719

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

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

52-
- 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)."
54+
{% ifversion security-configurations %}
55+
- 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)."
56+
57+
{% note %}
58+
59+
**Note:** {% data reusables.security-configurations.security-configurations-beta-note-short %}
60+
61+
{% endnote %}
62+
{% endif %}
63+
- 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)."
5364
- 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)."
5465

5566
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)."
@@ -94,7 +105,7 @@ If you're not sure about the impact a feature will have, you may want to test th
94105

95106
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)."
96107

97-
{% 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)."
108+
{% 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)."
98109

99110
{% 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 %}
100111

content/code-security/getting-started/securing-your-repository.md renamed to content/code-security/getting-started/quickstart-for-securing-your-repository.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
title: Securing your repository
2+
title: Quickstart for securing your repository
33
intro: 'You can use a number of {% data variables.product.prodname_dotcom %} features to help keep your repository secure.'
44
permissions: Repository administrators and organization owners can configure repository security settings.
55
redirect_from:
66
- /github/administering-a-repository/about-securing-your-repository
77
- /github/code-security/getting-started/about-securing-your-repository
8+
- /code-security/getting-started/securing-your-repository
89
versions:
910
fpt: '*'
1011
ghes: '*'
@@ -15,7 +16,7 @@ topics:
1516
- Dependencies
1617
- Vulnerabilities
1718
- Advanced Security
18-
shortTitle: Secure your repository
19+
shortTitle: Secure repository quickstart
1920
---
2021

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

8081
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)."
8182

82-
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 %}.
83+
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 %}.
8384

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

0 commit comments

Comments
 (0)