Skip to content

Commit 49a9978

Browse files
mchammer01felicitymayam-stead
authored
GHAS unbundling - adopting GitHub Advanced Security directory (#54765)
Co-authored-by: Felicity Chapman <felicitymay@github.com> Co-authored-by: Anne-Marie <102995847+am-stead@users.noreply.github.com>
1 parent ae0c5e5 commit 49a9978

8 files changed

Lines changed: 48 additions & 176 deletions

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Adopting GitHub Advanced Security at scale
2+
title: 'Adopting {% data variables.product.prodname_GHAS %} at scale'
33
shortTitle: Adopt GHAS at scale
4-
intro: A phased approach to rolling out GitHub Advanced Security at your company using industry and GitHub best practices.
4+
intro: A phased approach to rolling out {% data variables.product.prodname_GHAS %} at your company using industry and GitHub best practices.
55
versions:
66
ghes: '*'
77
ghec: '*'

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

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
title: Introduction to adopting GitHub Advanced Security at scale
3-
intro: 'You can adopt {% data variables.product.prodname_GH_advanced_security %} at scale in your company following industry and GitHub best practices.'
2+
title: 'Introduction to adopting {% data variables.product.prodname_GHAS %} at scale'
3+
intro: 'You can adopt {% data variables.product.prodname_GHAS %} at scale in your company following industry and {% data variables.product.github %} best practices.'
4+
allowTitleToDifferFromFilename: true
45
versions:
56
ghes: '*'
67
ghec: '*'
@@ -17,11 +18,11 @@ redirect_from:
1718

1819
## About these articles
1920

20-
{% data variables.product.prodname_GH_advanced_security %} (GHAS) helps teams build more secure code faster using integrated tooling such as secret scanning and code scanning using {% data variables.product.prodname_codeql %}. To understand the security features available through {% data variables.product.prodname_GH_advanced_security %}, see [AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security).
21+
{% data variables.product.prodname_GHAS %} (GHAS) products help teams build more secure code faster using integrated tooling such as secret scanning and code scanning using {% data variables.product.prodname_codeql %}. To understand the security features available through {% data variables.product.prodname_GHAS %}, see [AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security).
2122

2223
GHAS is a suite of tools that requires active participation from developers across your enterprise. To realize the best return on your investment, you must learn how to use, apply, and maintain GHAS.
2324

24-
We’ve created a phased approach to GHAS rollouts developed from industry and GitHub best practices. We expect most customers will want to follow these phases, based on our experience helping customers with a successful deployment of {% data variables.product.prodname_GH_advanced_security %}, but you may need to modify this approach to meet the needs of your company.
25+
We’ve created a phased approach to GHAS rollouts developed from industry and GitHub best practices. We expect most customers will want to follow these phases, based on our experience helping customers with a successful deployment of {% data variables.product.prodname_GHAS %}, but you may need to modify this approach to meet the needs of your company.
2526

2627
Enabling GHAS across a large organization can be broken down into six core phases.
2728

@@ -41,9 +42,9 @@ Enabling GHAS across a large organization can be broken down into six core phase
4142

4243
If you encounter any issues or have any questions during your implementation, you can search our documentation for solutions or engage with {% data variables.contact.github_support %}. For more information, see [AUTOTITLE](/support/learning-about-github-support/about-github-support).
4344

44-
If you prefer to have guidance throughout the rollout process, {% data variables.product.prodname_professional_services_team %} can partner with you for a successful rollout and implementation of {% data variables.product.prodname_GH_advanced_security %}. We offer a variety of {% data variables.product.prodname_professional_services %} options for guidance and support. We also have training and bootcamps available to help your company to optimize the value of {% data variables.product.prodname_GH_advanced_security %}.
45+
If you prefer to have guidance throughout the rollout process, {% data variables.product.prodname_professional_services_team %} can partner with you for a successful rollout and implementation of {% data variables.product.prodname_GHAS %}. We offer a variety of {% data variables.product.prodname_professional_services %} options for guidance and support. We also have training and bootcamps available to help your company to optimize the value of {% data variables.product.prodname_GHAS %}.
4546

4647
Speak with your sales representative for more information about all the {% data variables.product.prodname_professional_services %} options available. For more information, contact {% data variables.contact.contact_enterprise_sales %}.
4748

48-
> [!NOTE]
49+
>[!TIP]
4950
> For the first article in this series, see [AUTOTITLE](/code-security/adopting-github-advanced-security-at-scale/phase-1-align-on-your-rollout-strategy-and-goals).

content/code-security/adopting-github-advanced-security-at-scale/phase-1-align-on-your-rollout-strategy-and-goals.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: 'Phase 1: Align on your rollout strategy and goals'
3-
intro: 'Before enabling {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}, plan how GHAS should be rolled out across your enterprise.'
3+
intro: '{% ifversion ghas-products %}Before enabling {% data variables.product.prodname_GH_code_security %} and {% data variables.product.prodname_GH_secret_protection %} features, plan how these GHAS products should be rolled out across your enterprise.{% else %}Before enabling {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}, plan how GHAS should be rolled out across your enterprise.{% endif %}'
44
versions:
55
ghes: '*'
66
ghec: '*'
@@ -10,20 +10,20 @@ topics:
1010
shortTitle: 1. Align on strategy
1111
---
1212

13-
> [!NOTE]
14-
> This article is part of a series on adopting {% data variables.product.prodname_GH_advanced_security %} at scale. For the introduction to this series, see [AUTOTITLE](/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale).
13+
> [!TIP]
14+
> This article is part of a series on adopting {% data variables.product.prodname_GHAS %} at scale. For the introduction to this series, see [AUTOTITLE](/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale).
1515
1616
## Set clear goals for your company’s rollout
1717

1818
To build a foundation for the direction of your company's rollout, outline goals for GHAS within your company, and communicate those goals to your team. Your goals can be simple or complex, as long as your team is aligned. If you need assistance with your goals, {% data variables.product.prodname_professional_services %} can provide recommendations based on our experience with your company and other customers.
1919

2020
Here are some high-level examples of what your goals for rolling out GHAS might look like:
2121

22-
* Reducing the number of vulnerabilities: This may be in general, or because your company was recently impacted by a significant vulnerability that you believe could have been prevented by a tool like GHAS.
23-
* Identifying high-risk repositories: Some companies simply want to target repositories that contain the most risk, enabling them to reduce risk by remediating vulnerabilities.
24-
* Increasing remediation rates: To prevent the accumulation of security debt, you may wish to drive developer adoption of findings and ensure these vulnerabilities are remediated in a timely manner.
25-
* Meeting compliance requirements: For example, many healthcare companies use GHAS to prevent the exposure of PHI (Personal Health Information).
2622
* Preventing secrets leakage: Many companies want to prevent critical information from being leaked, such as software keys or financial data.
23+
* Meeting compliance requirements: For example, many healthcare companies use GHAS to prevent the exposure of PHI (Personal Health Information).
24+
* Reducing the number of vulnerabilities: This may be in general, or because your company was recently impacted by a significant vulnerability that you believe could have been prevented by a tool like GHAS.
25+
* Identifying high-risk repositories: Some companies simply want to target repositories that contain the most risk, enabling them to reduce risk by remediating vulnerabilities in their code and in their supply chain.
26+
* Increasing remediation rates: To prevent the accumulation of security debt, you will wish to drive developer adoption of findings and ensure these vulnerabilities are remediated in a timely manner.
2727

2828
## Lead your rollout with both your security and development groups
2929

@@ -43,7 +43,10 @@ GHAS is a suite of tools that increases with value when configured, maintained,
4343

4444
### 2. GHAS will require adjustment out of the box
4545

46-
After GHAS is set up on your repositories, you'll need to configure GHAS to meet your company’s needs.{% ifversion default-setup-ghas-enablement %} For example, while default setup for {% data variables.product.prodname_code_scanning %} automatically detects the languages to be scanned, you may need to customize other aspects of your {% data variables.product.prodname_code_scanning %} configuration. {% else %} {% data variables.product.prodname_code_scanning_caps %} in particular requires further customization, such as evaluating initial results and making adjustments for future scans. Many customers find that initial scans return limited or irrelevant results until {% data variables.product.prodname_code_scanning %} is adjusted based on the application's threat model.{% endif %}
46+
After GHAS is set up on your repositories, you'll need to configure GHAS to meet your company’s needs. For example:
47+
48+
* Default setup for {% data variables.product.prodname_code_scanning %} automatically detects the languages to be scanned, but you may need to customize other aspects of your {% data variables.product.prodname_code_scanning %} configuration such as the application's threat model to fine tune the results.
49+
* {% data variables.product.prodname_secret_scanning_caps %} automatically detects the patterns used by many commonly used systems, but you may want to add custom patterns to detect tokens and other secrets used by internal tooling.
4750

4851
### 3. GHAS tools are most effective when used together and integrated into your application security program
4952

@@ -59,5 +62,5 @@ If your company is interested in custom {% data variables.product.prodname_codeq
5962

6063
When {% data variables.product.prodname_code_scanning %} is run from a pull request, the scan will include the full codebase and not just the changes made in the pull request. Scanning the entire codebase is an important step to ensure the change has been reviewed against all interactions in the codebase.
6164

62-
> [!NOTE]
65+
> [!TIP]
6366
> For the next article in this series, see [AUTOTITLE](/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale).

0 commit comments

Comments
 (0)