1
0
mirror of synced 2025-12-19 18:10:59 -05:00

Use Copilot to update scripts to add quality query tables (#58621)

Co-authored-by: Anne-Marie <102995847+am-stead@users.noreply.github.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: docs-bot <77750099+docs-bot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Óscar San José <oscarsj@github.com>
This commit is contained in:
Felicity Chapman
2025-12-11 16:39:46 +00:00
committed by GitHub
parent bb7e473a53
commit 18acec3172
27 changed files with 1098 additions and 97 deletions

View File

@@ -1,6 +1,7 @@
---
title: CodeQL detection of code quality problems
shortTitle: CodeQL detection
title: CodeQL-powered analysis for Code Quality
shortTitle: CodeQL analysis
allowTitleToDifferFromFilename: true
intro: 'Information on how CodeQL-powered analysis for {% data variables.product.prodname_code_quality_short %} works, the workflow used, and the status checks reported on pull requests.'
versions:
feature: code-quality
@@ -11,11 +12,30 @@ contentType: reference
{% data reusables.code-quality.code-quality-preview-note %}
## {% data variables.product.prodname_codeql %} detection
## {% data variables.product.prodname_codeql %}-powered analysis
{% data variables.product.prodname_code_quality_short %} performs rule-based analysis of pull requests and your default branch using {% data variables.product.prodname_codeql %}. Each rule is written as a query in {% data variables.product.prodname_codeql %} and then run using {% data variables.product.prodname_actions %}.
{% data variables.product.prodname_code_quality_short %} uses {% data variables.product.prodname_codeql %} to perform rule-based analysis of pull requests and your default branch.
The rules are continually refined by both {% data variables.product.github %} and open source developers. See [https://github.com/github/codeql](https://github.com/github/codeql).
* Findings for your **default branch** appear under the "{% data variables.code-quality.all_findings %}" dashboard under your repository's Security tab.
* Findings **on pull requests** appear as comments made by `{% data variables.code-quality.pr_commenter %}`.
{% data variables.copilot.copilot_autofix_short %} suggestions are provided for findings where possible.
### Query lists for supported languages
Each {% data variables.product.prodname_code_quality_short %} rule is written as a query in {% data variables.product.prodname_codeql %} and then run using {% data variables.product.prodname_actions %}.
The rules are continually refined by both {% data variables.product.github %} and open source developers.
* [AUTOTITLE](/code-security/code-quality/reference/codeql-queries/csharp-queries)
* [AUTOTITLE](/code-security/code-quality/reference/codeql-queries/go-queries)
* [AUTOTITLE](/code-security/code-quality/reference/codeql-queries/java-queries)
* [AUTOTITLE](/code-security/code-quality/reference/codeql-queries/javascript-queries)
* [AUTOTITLE](/code-security/code-quality/reference/codeql-queries/python-queries)
* [AUTOTITLE](/code-security/code-quality/reference/codeql-queries/ruby-queries)
For more information about the {% data variables.product.prodname_codeql %} project, see [https://codeql.github.com/](https://codeql.github.com/).
## Workflow used for code quality analysis

View File

@@ -0,0 +1,20 @@
---
title: C# CodeQL queries for Code Quality
shortTitle: C# queries
allowTitleToDifferFromFilename: true
intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code quality for code written in C#.'
versions:
feature: code-quality
topics:
- Code Quality
contentType: reference
---
{% data variables.product.prodname_code_quality_short %} uses the following {% data variables.product.prodname_codeql %} queries to analyze C# code and detect code quality issues on:
* Your **default branch**, with results shown on the repository's "{% data variables.code-quality.all_findings %}" dashboard
* **Pull requests**, with findings shown as comments made by `{% data variables.code-quality.pr_commenter %}`
{% data variables.copilot.copilot_autofix_short %} suggestions are provided for findings where possible.
{% data reusables.code-quality.codeql-query-tables.csharp %}

View File

@@ -0,0 +1,19 @@
---
title: Go CodeQL queries for Code Quality
shortTitle: Go queries
intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code quality for code written in Go.'
versions:
feature: code-quality
topics:
- Code Quality
contentType: reference
---
{% data variables.product.prodname_code_quality_short %} uses the following {% data variables.product.prodname_codeql %} queries to analyze Go code and detect code quality issues on:
* Your **default branch**, with results shown on the repository's "{% data variables.code-quality.all_findings %}" dashboard
* **Pull requests**, with findings shown as comments made by `{% data variables.code-quality.pr_commenter %}`
{% data variables.copilot.copilot_autofix_short %} suggestions are provided for findings where possible.
{% data reusables.code-quality.codeql-query-tables.go %}

View File

@@ -0,0 +1,17 @@
---
title: Queries for CodeQL detection
shortTitle: CodeQL queries
intro: 'Explore the {% data variables.product.prodname_codeql %} queries that {% data variables.product.prodname_code_quality_short %} uses to detect code quality issues in supported languages.'
versions:
feature: code-quality
topics:
- Code Quality
contentType: reference
children:
- csharp-queries
- go-queries
- java-queries
- javascript-queries
- python-queries
- ruby-queries
---

View File

@@ -0,0 +1,20 @@
---
title: Java CodeQL queries for Code Quality
shortTitle: Java queries
allowTitleToDifferFromFilename: true
intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code quality for code written in Java.'
versions:
feature: code-quality
topics:
- Code Quality
contentType: reference
---
{% data variables.product.prodname_code_quality_short %} uses the following {% data variables.product.prodname_codeql %} queries to analyze Java code and detect code quality issues on:
* Your **default branch**, with results shown on the repository's "{% data variables.code-quality.all_findings %}" dashboard
* **Pull requests**, with findings shown as comments made by `{% data variables.code-quality.pr_commenter %}`
{% data variables.copilot.copilot_autofix_short %} suggestions are provided for findings where possible.
{% data reusables.code-quality.codeql-query-tables.java %}

View File

@@ -0,0 +1,20 @@
---
title: JavaScript CodeQL queries for Code Quality
shortTitle: JavaScript queries
allowTitleToDifferFromFilename: true
intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code quality for code written in JavaScript.'
versions:
feature: code-quality
topics:
- Code Quality
contentType: reference
---
{% data variables.product.prodname_code_quality_short %} uses the following {% data variables.product.prodname_codeql %} queries to analyze JavaScript code and detect code quality issues on:
* Your **default branch**, with results shown on the repository's "{% data variables.code-quality.all_findings %}" dashboard
* **Pull requests**, with findings shown as comments made by `{% data variables.code-quality.pr_commenter %}`
{% data variables.copilot.copilot_autofix_short %} suggestions are provided for findings where possible.
{% data reusables.code-quality.codeql-query-tables.javascript %}

View File

@@ -0,0 +1,20 @@
---
title: Python CodeQL queries for Code Quality
shortTitle: Python queries
allowTitleToDifferFromFilename: true
intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code quality for code written in Python.'
versions:
feature: code-quality
topics:
- Code Quality
contentType: reference
---
{% data variables.product.prodname_code_quality_short %} uses the following {% data variables.product.prodname_codeql %} queries to analyze Python code and detect code quality issues on:
* Your **default branch**, with results shown on the repository's "{% data variables.code-quality.all_findings %}" dashboard
* **Pull requests**, with findings shown as comments made by `{% data variables.code-quality.pr_commenter %}`
{% data variables.copilot.copilot_autofix_short %} suggestions are provided for findings where possible.
{% data reusables.code-quality.codeql-query-tables.python %}

View File

@@ -0,0 +1,20 @@
---
title: Ruby CodeQL queries for Code Quality
shortTitle: Ruby queries
allowTitleToDifferFromFilename: true
intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code quality for code written in Ruby.'
versions:
feature: code-quality
topics:
- Code Quality
contentType: reference
---
{% data variables.product.prodname_code_quality_short %} uses the following {% data variables.product.prodname_codeql %} queries to analyze Ruby code and detect code quality issues on:
* Your **default branch**, with results shown on the repository's "{% data variables.code-quality.all_findings %}" dashboard
* **Pull requests**, with findings shown as comments made by `{% data variables.code-quality.pr_commenter %}`
{% data variables.copilot.copilot_autofix_short %} suggestions are provided for findings where possible.
{% data reusables.code-quality.codeql-query-tables.ruby %}

View File

@@ -10,4 +10,5 @@ contentType: reference
children:
- metrics-and-ratings
- codeql-detection
- codeql-queries
---