Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions content/admin/all-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ If you run analysis in an external CI system, we recommend using the same versio

| {% data variables.product.prodname_ghe_server %} version | Recommended {% data variables.product.prodname_codeql_cli %} version |
| ------------------------------------------------- | ---------------------- |
| 3.19 | 2.22.4 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.22.4/)) |
| 3.18 | 2.21.4 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.21.4/)) |
| 3.17 | 2.20.7 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.20.7/)) |
| 3.16 | 2.20.3 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.20.3/)) |
Expand All @@ -78,6 +79,7 @@ For instances with {% data variables.product.prodname_actions %} enabled, self-h

| {% data variables.product.prodname_ghe_server %} version | Minimum Runner version |
| ------------------------------------------------- | ---------------------- |
| 3.19 | 2.328.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.328.0)) |
| 3.18 | 2.324.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.324.0)) |
| 3.17 | 2.322.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.322.0)) |
| 3.16 | 2.321.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.321.0)) |
Expand Down
2 changes: 0 additions & 2 deletions content/code-security/code-quality/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,4 @@ topics:
children:
- /get-started
- /reference
- /responsible-use
---

12 changes: 0 additions & 12 deletions content/code-security/code-quality/responsible-use/index.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,5 @@ topics:
- Code Security
- Code scanning
children:
- /configuring-advanced-setup-for-code-scanning
- /customizing-your-advanced-setup-for-code-scanning
- /codeql-code-scanning-for-compiled-languages
- /recommended-hardware-resources-for-running-codeql
- /running-codeql-code-scanning-in-a-container
---

This file was deleted.

3 changes: 0 additions & 3 deletions content/code-security/code-scanning/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,9 @@ topics:
- Code scanning
- CodeQL
children:
- /enabling-code-scanning
- /creating-an-advanced-setup-for-code-scanning
- /managing-code-scanning-alerts
- /managing-your-code-scanning-configuration
- /integrating-with-code-scanning
- /troubleshooting-code-scanning
- /troubleshooting-sarif-uploads
- /reference
---
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ topics:
- Code scanning
- Integration
children:
- /using-code-scanning-with-your-existing-ci-system
- /uploading-a-sarif-file-to-github
- /sarif-support-for-code-scanning
---

Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ redirect_from:
- /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists
- /code-security/code-scanning/managing-code-scanning-alerts/tracking-code-scanning-alerts-in-issues-using-task-lists
children:
- /responsible-use-autofix-code-scanning
- /disabling-autofix-for-code-scanning
- /assessing-code-scanning-alerts-for-your-repository
- /resolving-code-scanning-alerts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,7 @@ topics:
- Code scanning
- CodeQL
children:
- /about-the-tool-status-page
- /editing-your-configuration-of-default-setup
- /set-code-scanning-merge-protection
- /enabling-delegated-alert-dismissal-for-code-scanning
- /configuring-larger-runners-for-default-setup
- /viewing-code-scanning-logs
---

This file was deleted.

This file was deleted.

5 changes: 2 additions & 3 deletions content/code-security/codeql-cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Use the CodeQL CLI to secure your code
shortTitle: CodeQL CLI
allowTitleToDifferFromFilename: true
intro: 'Use {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_codeql %} analyses locally.'
intro: Use {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_codeql %} analyses locally.
product: '{% data reusables.gated-features.codeql %}'
versions:
fpt: '*'
Expand All @@ -13,7 +13,6 @@ topics:
- Code scanning
- CodeQL
children:
- /getting-started-with-the-codeql-cli
- /using-the-advanced-functionality-of-the-codeql-cli
- /codeql-cli-manual
---

Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,10 @@ topics:
- Code scanning
- CodeQL
children:
- /advanced-setup-of-the-codeql-cli
- /using-custom-queries-with-the-codeql-cli
- /creating-codeql-query-suites
- /testing-custom-queries
- /testing-query-help-files
- /creating-and-working-with-codeql-packs
- /publishing-and-using-codeql-packs
- /specifying-command-options-in-a-codeql-configuration-file
- /sarif-output
- /csv-output
- /extractor-options
- /exit-codes
- /creating-database-bundle-for-troubleshooting
redirect_from:
- /code-security/codeql-cli/codeql-cli-reference
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,6 @@ topics:
- Code Security
- Code scanning
- CodeQL
children:
- /installing-codeql-for-vs-code
- /managing-codeql-databases
- /running-codeql-queries
- /exploring-data-flow-with-path-queries
- /running-codeql-queries-at-scale-with-multi-repository-variant-analysis
redirect_from:
- /code-security/codeql-for-vs-code/setting-up-codeql-in-visual-studio-code
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Using the advanced functionality of the {% data variables.product.prodname_codeql %} for VS Code extension
shortTitle: Advanced functionality
intro: 'The {% data variables.product.prodname_codeql %} extension for {% data variables.product.prodname_vscode %} adds rich language support for {% data variables.product.prodname_codeql %} and supports writing queries to find problems in codebases.'
intro: The {% data variables.product.prodname_codeql %} extension for {% data variables.product.prodname_vscode %} adds rich language support for {% data variables.product.prodname_codeql %} and supports writing queries to find problems in codebases.
product: '{% data reusables.gated-features.codeql %}'
versions:
fpt: '*'
Expand All @@ -12,13 +12,6 @@ topics:
- Code scanning
- CodeQL
children:
- /using-the-codeql-model-editor
- /creating-a-custom-query
- /managing-codeql-packs
- /exploring-the-structure-of-your-source-code
- /testing-codeql-queries-in-vs-code
- /customizing-settings
- /setting-up-a-codeql-workspace
- /configuring-access-to-the-codeql-cli
- /telemetry-in-codeql-for-visual-studio-code
---

1 change: 1 addition & 0 deletions content/code-security/how-tos/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ contentType: how-tos
children:
- /secure-at-scale
- /secure-your-supply-chain
- /scan-code-for-vulnerabilities
- /maintain-quality-code
- /report-and-fix-vulnerabilities
---
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
---
title: Configuring advanced setup for code scanning
shortTitle: Configure advanced setup
intro: 'You can configure advanced setup for a repository to find security vulnerabilities in your code using a highly customizable {% data variables.product.prodname_code_scanning %} configuration.'
intro: You can configure advanced setup for a repository to find security vulnerabilities in your code using a highly customizable {% data variables.product.prodname_code_scanning %} configuration.
permissions: '{% data reusables.permissions.security-repo-enable %}'
product: '{% data reusables.gated-features.code-scanning %}'
redirect_from:
- /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-advanced-setup-for-code-scanning
- /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-advanced-setup-for-code-scanning
- /code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning
versions:
fpt: '*'
ghes: '*'
ghec: '*'
type: how_to
topics:
- Code Security
- Code scanning
- Actions
- Repositories
allowTitleToDifferFromFilename: true
contentType: how-tos
---

{% data reusables.code-scanning.enterprise-enable-code-scanning-actions %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Configuring default setup for code scanning
shortTitle: Configure code scanning
intro: 'Quickly set up {% data variables.product.prodname_code_scanning %} to find {% ifversion fpt or ghec %}and fix {% endif %}vulnerable code automatically.'
intro: Quickly set up {% data variables.product.prodname_code_scanning %} to find {% ifversion fpt or ghec %}and fix {% endif %}vulnerable code automatically.
redirect_from:
- /github/managing-security-vulnerabilities/configuring-automated-code-scanning
- /github/finding-security-vulnerabilities-and-errors-in-your-code/enabling-code-scanning
Expand All @@ -14,16 +14,17 @@ redirect_from:
- /github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository
- /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-for-a-repository
- /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-default-setup-for-code-scanning
- /code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning
permissions: '{% data reusables.permissions.security-repo-enable %}'
product: '{% data reusables.gated-features.code-scanning %}'
type: how_to
topics:
- Code Security
- Code scanning
versions:
fpt: '*'
ghes: '*'
ghec: '*'
contentType: how-tos
---

## About default setup
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Customizing your advanced setup for code scanning
intro: 'You can customize how your advanced setup scans the code in your project for vulnerabilities and errors.'
intro: You can customize how your advanced setup scans the code in your project for vulnerabilities and errors.
permissions: '{% data reusables.permissions.code-scanning-all-alerts %} if [advanced setup](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning) is already enabled'
redirect_from:
- /github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning
Expand All @@ -9,6 +9,7 @@ redirect_from:
- /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning
- /github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning
- /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/customizing-code-scanning
- /code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning
versions:
fpt: '*'
ghes: '*'
Expand All @@ -24,6 +25,7 @@ topics:
- Python
shortTitle: Customize advanced setup
allowTitleToDifferFromFilename: true
contentType: how-tos
---
<!--The CodeQL CLI man pages include a link to a section of the article. If you rename this article,
make sure that you also update the MS short link: https://aka.ms/code-scanning-docs/config-file.-->
Expand Down Expand Up @@ -370,11 +372,8 @@ In the following example, the `+` symbol ensures that the specified additional p
queries: +security-and-quality,octo-org/python-qlpack/show_ifs.ql@main
packs: +scope/pack1,scope/pack2@1.2.3,scope/pack3@4.5.6:path/to/queries
```
<!-- Anchor to maintain the current CodeQL CLI manual pages link: https://aka.ms/code-scanning-docs/config-file -->
<a name="using-a-custom-configuration-file"></a>

<!-- Anchor to maintain the old CodeQL CLI manual pages link: https://aka.ms/docs-config-file -->
<a name="example-configuration-files"></a>
<!-- Anchor to maintain the current CodeQL CLI manual pages link: https://aka.ms/code-scanning-docs/config-file -->

## Using a custom configuration file

Expand Down Expand Up @@ -517,6 +516,8 @@ For analysis where code is built, if you want to limit {% data variables.product

You can quickly analyze small portions of a monorepo when you modify code in specific directories. You'll need to both exclude directories in your build steps and use the `paths-ignore` and `paths` keywords for [`on.<push|pull_request>`](/actions/using-workflows/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore) in your workflow.

<!-- Anchor to maintain the old CodeQL CLI manual pages link: https://aka.ms/docs-config-file -->

### Example configuration files

{% data reusables.code-scanning.example-configuration-files %}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Configure code scanning
intro: Configure {% data variables.product.prodname_code_scanning %} for your repositories by choosing between default or advanced setup and customizing advanced settings as needed.
versions:
fpt: '*'
ghes: '*'
ghec: '*'
contentType: how-tos
topics:
- Code Security
- Code scanning
- Actions
- Repositories
children:
- /configuring-default-setup-for-code-scanning
- /configuring-advanced-setup-for-code-scanning
- /customizing-your-advanced-setup-for-code-scanning
redirect_from:
- /code-security/code-scanning/enabling-code-scanning
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Scan code for vulnerabilities
intro: Scan your code for vulnerabilities by configuring code scanning, managing configurations, running scans locally or in your editor, integrating with existing tools, and troubleshooting issues.
versions:
fpt: '*'
ghes: '*'
ghec: '*'
contentType: how-tos
children:
- /configure-code-scanning
- /manage-your-configuration
- /scan-from-the-command-line
- /scan-from-vs-code
- /integrate-with-existing-tools
- /troubleshooting
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Integrate with existing tools
intro: Integrate {% data variables.product.prodname_code_scanning %} with your existing tools and workflows by running scans in your CI system or uploading results to {% data variables.product.github %} using Static Analysis Results Interchange Format (SARIF).
versions:
fpt: '*'
ghes: '*'
ghec: '*'
contentType: how-tos
topics:
- Code Security
- Code scanning
- CodeQL
- Repositories
- Pull requests
- Integration
- CI
- SARIF
children:
- /using-code-scanning-with-your-existing-ci-system
- /uploading-a-sarif-file-to-github
---
Loading
Loading