Skip to content

Commit 12b1c7a

Browse files
am-steadhubwriter
andauthored
[Improvement]: Create "Reference" category for code scanning for CodeQL queries #20670 (#58874)
Co-authored-by: hubwriter <[email protected]>
1 parent a10899f commit 12b1c7a

File tree

20 files changed

+138
-75
lines changed

20 files changed

+138
-75
lines changed

content/code-security/code-scanning/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,5 @@ children:
2525
- /integrating-with-code-scanning
2626
- /troubleshooting-code-scanning
2727
- /troubleshooting-sarif-uploads
28+
- /reference
2829
---

content/code-security/code-scanning/managing-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ Anyone with push access to a pull request can fix a {% data variables.product.pr
127127
When {% data variables.copilot.copilot_autofix_short %} is enabled for a repository, alerts are displayed in pull requests as normal and information from any alerts found by {% data variables.product.prodname_code_scanning %} is automatically sent to the LLM for processing. When LLM analysis is complete, any results are published as comments on relevant alerts. For more information, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning).
128128

129129
> [!NOTE]
130-
> * {% data variables.copilot.copilot_autofix_short %} supports a subset of {% data variables.product.prodname_codeql %} queries. For information about the availability of {% data variables.copilot.copilot_autofix_short %}, see the query tables linked from [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/codeql-query-suites#query-lists-for-the-default-query-suites).
130+
> * {% data variables.copilot.copilot_autofix_short %} supports a subset of {% data variables.product.prodname_codeql %} queries. For information about the availability of {% data variables.copilot.copilot_autofix_short %}, see the query tables linked from [AUTOTITLE](/code-security/code-scanning/reference/code-ql-built-in-queries).
131131
> * When analysis is complete, all relevant results are published to the pull request at once. If at least one alert in your pull request has an {% data variables.copilot.copilot_autofix_short %} suggestion, you should assume that the LLM has finished identifying potential fixes for your code.
132132
> * On alerts generated from queries that are not supported by {% data variables.copilot.copilot_autofix_short %}, you will see a note telling you that the query is not supported. If a suggestion for a supported query fails to generate, you will see a note on the alert prompting you to try pushing another commit or to contact support.
133133
> * {% data variables.copilot.copilot_autofix_short %} for {% data variables.product.prodname_code_scanning %} alerts won't be able to generate a fix for every alert in every situation. The feature operates on a best-effort basis and is not guaranteed to succeed 100% of the time. For information about the limitations of automatically generated fixes, see [Limitations of suggestions](/code-security/code-scanning/managing-code-scanning-alerts/about-autofix-for-codeql-code-scanning#limitations-of-suggestions).

content/code-security/code-scanning/managing-your-code-scanning-configuration/codeql-query-suites.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: CodeQL query suites
33
shortTitle: CodeQL query suites
4-
intro: 'You can choose from different built-in {% data variables.product.prodname_codeql %} query suites to use in your {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} setup.'
4+
intro: You can choose from different built-in {% data variables.product.prodname_codeql %} query suites to use in your {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} setup.
55
product: '{% data reusables.gated-features.codeql %}'
66
versions:
77
fpt: '*'
@@ -14,6 +14,7 @@ type: reference
1414
topics:
1515
- Code scanning
1616
- CodeQL
17+
contentType: other
1718
---
1819

1920
## About {% data variables.product.prodname_codeql %} query suites
@@ -43,11 +44,7 @@ The built-in {% data variables.product.prodname_codeql %} query suites, `default
4344
* Relative to the `default` query suite, the `security-extended` suite may return a greater number of false positive {% data variables.product.prodname_code_scanning %} results.
4445
* This query suite is available for use with default setup for {% data variables.product.prodname_code_scanning %}, and is referred to as the "Extended" query suite on {% data variables.product.prodname_dotcom %}.
4546

46-
## Query lists for the default query suites
47-
48-
For each language, the following article lists which queries are included in the `default` and the `security-extended` suites. {% ifversion code-scanning-autofix %}Where {% data variables.copilot.copilot_autofix_short %} is available for a language, details of which queries are supported are also included.{% endif %}
49-
50-
{% data reusables.code-scanning.codeql-query-tables.links-to-all-tables %}
47+
For a complete list of queries included in each query suite for every language, see [AUTOTITLE](/code-security/code-scanning/reference).
5148

5249
## Further reading
5350

content/code-security/code-scanning/managing-your-code-scanning-configuration/github-actions-built-in-queries.md

Lines changed: 0 additions & 23 deletions
This file was deleted.
Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Managing your code scanning configuration
33
shortTitle: Manage code scanning
4-
intro: 'You can manage your existing {% data variables.product.prodname_code_scanning %} configuration with the help of metrics and logging outputs generated by your analysis.'
4+
intro: You can manage your existing {% data variables.product.prodname_code_scanning %} configuration with the help of metrics and logging outputs generated by your analysis.
55
product: '{% data reusables.gated-features.code-scanning %}'
66
versions:
77
fpt: '*'
@@ -14,20 +14,10 @@ topics:
1414
children:
1515
- /about-the-tool-status-page
1616
- /editing-your-configuration-of-default-setup
17+
- /codeql-query-suites
1718
- /set-code-scanning-merge-protection
1819
- /enabling-delegated-alert-dismissal-for-code-scanning
19-
- /codeql-query-suites
2020
- /configuring-larger-runners-for-default-setup
2121
- /viewing-code-scanning-logs
22-
- /actions-built-in-queries
23-
- /c-cpp-built-in-queries
24-
- /csharp-built-in-queries
25-
- /github-actions-built-in-queries
26-
- /go-built-in-queries
27-
- /java-kotlin-built-in-queries
28-
- /javascript-typescript-built-in-queries
29-
- /python-built-in-queries
30-
- /ruby-built-in-queries
31-
- /rust-built-in-queries
32-
- /swift-built-in-queries
3322
---
23+
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: About built-in CodeQL queries
3+
shortTitle: About built-in queries
4+
allowTitleToDifferFromFilename: true
5+
intro: Learn about the CodeQL queries that code scanning uses to analyze code.
6+
product: '{% data reusables.gated-features.code-scanning %}'
7+
versions:
8+
fpt: '*'
9+
ghec: '*'
10+
ghes: '*'
11+
type: overview
12+
topics:
13+
- Code Security
14+
- Code scanning
15+
- CodeQL
16+
contentType: other
17+
---
18+
19+
## About built-in queries for CodeQL analysis
20+
21+
For each language, the following articles list which queries are included in the `default` and the `security-extended` suites. {% ifversion code-scanning-autofix %}Where {% data variables.copilot.copilot_autofix_short %} is available for a language, details of which queries are supported are also included.{% endif %}
22+
23+
{% data reusables.code-scanning.codeql-query-tables.links-to-all-tables %}
24+
25+
For more information about CodeQL query suites, see [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/codeql-query-suites).

content/code-security/code-scanning/managing-your-code-scanning-configuration/actions-built-in-queries.md renamed to content/code-security/code-scanning/reference/code-ql-built-in-queries/actions-built-in-queries.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Actions queries for CodeQL analysis
3-
shortTitle: Actions CodeQL queries
4-
intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code written in {% data variables.product.prodname_actions %} workflow files when you select the `default` or the `security-extended` query suite.'
2+
title: GitHub Actions queries for CodeQL analysis
3+
shortTitle: Actions queries
4+
intro: Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code written in {% data variables.product.prodname_actions %} workflow files when you select the `default` or the `security-extended` query suite.
55
product: '{% data reusables.gated-features.codeql %}'
66
allowTitleToDifferFromFilename: true
77
versions:
@@ -12,6 +12,10 @@ type: reference
1212
topics:
1313
- Code scanning
1414
- CodeQL
15+
redirect_from:
16+
- /code-security/code-scanning/managing-your-code-scanning-configuration/actions-built-in-queries
17+
- /code-security/code-scanning/managing-your-code-scanning-configuration/github-actions-built-in-queries
18+
contentType: other
1519
---
1620

1721
{% data variables.product.prodname_codeql %} includes many queries for analyzing {% data variables.product.prodname_actions %} workflows. {% data reusables.code-scanning.codeql-query-tables.query-suite-behavior %}

content/code-security/code-scanning/managing-your-code-scanning-configuration/c-cpp-built-in-queries.md renamed to content/code-security/code-scanning/reference/code-ql-built-in-queries/c-cpp-built-in-queries.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: C and C++ queries for CodeQL analysis
3-
shortTitle: C and C++ CodeQL queries
4-
intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code written in C or C++ when you select the `default` or the `security-extended` query suite.'
3+
shortTitle: C and C++ queries
4+
intro: Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code written in C or C++ when you select the `default` or the `security-extended` query suite.
55
product: '{% data reusables.gated-features.codeql %}'
66
allowTitleToDifferFromFilename: true
77
versions:
@@ -12,6 +12,9 @@ type: reference
1212
topics:
1313
- Code scanning
1414
- CodeQL
15+
redirect_from:
16+
- /code-security/code-scanning/managing-your-code-scanning-configuration/c-cpp-built-in-queries
17+
contentType: other
1518
---
1619

1720
{% data variables.product.prodname_codeql %} includes many queries for analyzing C and C++ code. {% data reusables.code-scanning.codeql-query-tables.query-suite-behavior %}

content/code-security/code-scanning/managing-your-code-scanning-configuration/csharp-built-in-queries.md renamed to content/code-security/code-scanning/reference/code-ql-built-in-queries/csharp-built-in-queries.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: C# queries for CodeQL analysis
3-
shortTitle: C# CodeQL queries
4-
intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code written in C# when you select the `default` or the `security-extended` query suite.'
3+
shortTitle: C# queries
4+
intro: Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code written in C# when you select the `default` or the `security-extended` query suite.
55
product: '{% data reusables.gated-features.codeql %}'
66
allowTitleToDifferFromFilename: true
77
versions:
@@ -12,6 +12,9 @@ type: reference
1212
topics:
1313
- Code scanning
1414
- CodeQL
15+
redirect_from:
16+
- /code-security/code-scanning/managing-your-code-scanning-configuration/csharp-built-in-queries
17+
contentType: other
1518
---
1619

1720
{% data variables.product.prodname_codeql %} includes many queries for analyzing C# code. {% data reusables.code-scanning.codeql-query-tables.query-suite-behavior %}

content/code-security/code-scanning/managing-your-code-scanning-configuration/go-built-in-queries.md renamed to content/code-security/code-scanning/reference/code-ql-built-in-queries/go-built-in-queries.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Go queries for CodeQL analysis
3-
shortTitle: Go CodeQL queries
4-
intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code written in Go (Golang) when you select the `default` or the `security-extended` query suite.'
3+
shortTitle: Go queries
4+
intro: Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code written in Go (Golang) when you select the `default` or the `security-extended` query suite.
55
product: '{% data reusables.gated-features.codeql %}'
66
allowTitleToDifferFromFilename: true
77
versions:
@@ -12,6 +12,9 @@ type: reference
1212
topics:
1313
- Code scanning
1414
- CodeQL
15+
redirect_from:
16+
- /code-security/code-scanning/managing-your-code-scanning-configuration/go-built-in-queries
17+
contentType: other
1518
---
1619

1720
{% data variables.product.prodname_codeql %} includes many queries for analyzing Go code. {% data reusables.code-scanning.codeql-query-tables.query-suite-behavior %}

0 commit comments

Comments
 (0)