Skip to content

Commit df74bd2

Browse files
[EDI] Configuring advanced setup for code scanning with CodeQL at scale (#59533)
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
1 parent d4a72f9 commit df74bd2

1 file changed

Lines changed: 4 additions & 12 deletions

File tree

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Configuring advanced setup for code scanning with CodeQL at scale
33
shortTitle: CodeQL advanced setup at scale
4-
intro: You can use a script to configure advanced setup for {% data variables.product.prodname_code_scanning %} for a specific group of repositories in your organization.
4+
intro: Establish a highly customizable {% data variables.product.prodname_code_scanning %} setup at scale with a script.
55
permissions: '{% data reusables.permissions.security-org-enable %}'
66
product: '{% data reusables.gated-features.code-scanning %}'
77
redirect_from:
@@ -18,18 +18,12 @@ allowTitleToDifferFromFilename: true
1818
contentType: how-tos
1919
---
2020

21-
## About enabling advanced setup for {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %} at scale
22-
23-
If you need to configure a highly customizable {% data variables.product.prodname_code_scanning %} setup for many repositories in your organization, or if repositories in your organization are ineligible for default setup, you can enable {% data variables.product.prodname_code_scanning %} at scale with advanced setup.
24-
25-
To enable advanced setup across multiple repositories, you can write a bulk configuration script. To successfully execute the script, {% data variables.product.prodname_actions %} must be enabled for the {% ifversion fpt %}organization{% elsif ghec %}organization or enterprise{% elsif ghes %}site{% endif %}.
26-
27-
Alternatively, if you do not need granular control over the {% data variables.product.prodname_code_scanning %} configuration for many repositories in your organization, you can quickly and easily configure {% data variables.product.prodname_code_scanning %} at scale with default setup. For more information, see [AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale).
28-
2921
## Using a script to enable advanced setup
3022

3123
For repositories that are not eligible for default setup, you can use a bulk configuration script to enable advanced setup across multiple repositories.
3224

25+
> [!NOTE] To successfully execute the script, {% data variables.product.prodname_actions %} must be enabled for the {% ifversion fpt %}organization{% elsif ghec %}organization or enterprise{% elsif ghes %}instance{% endif %}.
26+
3327
1. Identify a group of repositories that can be analyzed using the same {% data variables.product.prodname_code_scanning %} configuration. For example, all repositories that build Java artifacts using the production environment.
3428
1. Create and test a {% data variables.product.prodname_actions %} workflow to call the {% data variables.product.prodname_codeql %} action with the appropriate configuration. For more information, see [AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-advanced-setup-for-code-scanning#configuring-advanced-setup-for-code-scanning-with-codeql).
3529
1. Use one of the example scripts or create a custom script to add the workflow to each repository in the group.
@@ -38,10 +32,8 @@ For repositories that are not eligible for default setup, you can use a bulk con
3832
* NodeJS example: [`nickliffen/ghas-enablement`](https://github.com/NickLiffen/ghas-enablement) repository
3933
* PowerShell example: [`jhutchings1/Create-ActionsPRs`](https://github.com/jhutchings1/Create-ActionsPRs) repository
4034

41-
### Extending {% data variables.product.prodname_codeql %} coverage with model packs
35+
## Next steps
4236

4337
{% data reusables.code-scanning.beta-model-packs %}
4438

4539
If your codebase depends on a library or framework that is not recognized by the standard queries in {% data variables.product.prodname_codeql %}, you can extend the {% data variables.product.prodname_codeql %} coverage in your bulk configuration script by specifying published {% data variables.product.prodname_codeql %} model packs. For more information, see [AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#extending-codeql-coverage-with-codeql-model-packs).
46-
47-
Alternatively, if you do not need granular control over the {% data variables.product.prodname_code_scanning %} configuration for many repositories in your organization, you can quickly and easily configure model packs with {% data variables.product.prodname_code_scanning %} at scale with default setup. For more information, see [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/editing-your-configuration-of-default-setup#extending-codeql-coverage-with-codeql-model-packs-in-default-setup).

0 commit comments

Comments
 (0)