jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-01 18:05:46 -05:00
Code Issues Projects Releases Wiki Activity

AI-powered autofixes for CodeQL alerts (including historical ones) (#51524)

Browse Source 
Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com>
Co-authored-by: Max Schaefer <max-schaefer@github.com>
This commit is contained in:
Ben Ahmady
2024-07-16 19:28:31 +01:00
committed by GitHub
parent 86e2a33100
commit a1996a1b1b
20 changed files with 104 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
src/code-scanning/scripts/generate-code-scanning-query-list.ts
View File

@@ -58,28 +58,6 @@ import { program } from 'commander'
import { getSupportedQueries } from '@github/cocofix/dist/querySuites.js' // eslint-disable-line import/no-extraneous-dependencies
import { type Language } from '@github/cocofix/dist/codeql' // eslint-disable-line import/no-extraneous-dependencies
/**
* The list of languages for which autofix support has (publicly) shipped.
*
* We don't want to add documentation about autofix support for languages that have not shipped.
*
* Note that this is conceptually different from the list of languages for which we support autofix:
* some languages are supported, but only staff-shipped internally (currently, `go` and `ruby`).
*
* Supporting a language is a technical decision, and reflected in the list of supported queries
* returned by `getSupportedQueries`. Shipping a language, on the other hand, is a product decision,
* and is implemented by a feature flag in the monolith, so we cannot easily check it here.
*
* Instead we hard-code the list of shipped languages here and manually keep it in sync with
* https://docs.github.com/en/code-security/code-scanning/managing-code-scanning-alerts/about-autofix-for-codeql-code-scanning#supported-languages.
* This sounds worse than it is, since CodeQL only supports a total of eight languages
* and we are on track to ship autofix support for all of them in the next few months.
*
* Note that we never publicly ship a language for which we don't have autofix support, so if a language
* has been shipped, we know for sure that it is supported.
*/
const AUTOFIX_SHIPPED_LANGUAGES = ['csharp', 'java', 'javascript', 'python', 'go', 'ruby', 'cpp']
program
.description('Generate a reusable Markdown for for a code scanning query language')
.option('--verbose', 'Verbose outputs')
@@ -213,20 +191,14 @@ async function main(options: Options, language: string) {
return a.name.localeCompare(b.name)
})
// Omit the 'Autofix' column if the language has not been shipped
const includeAutofix = AUTOFIX_SHIPPED_LANGUAGES.includes(language)
console.warn(`${includeAutofix ? 'Including' : 'Excluding'} 'Autofix' column for ${language}`)
printQueries(options, entries, includeAutofix)
printQueries(options, entries)
}
function printQueries(options: Options, queries: QueryExtended[], includeAutofix: boolean) {
function printQueries(options: Options, queries: QueryExtended[]) {
const markdown: string[] = []
markdown.push('{% rowheaders %}')
markdown.push('') // blank line
const header = ['Query name', 'Related CWEs', 'Default', 'Extended']
if (includeAutofix) {
header.push('Autofix')
}
const header = ['Query name', 'Related CWEs', 'Default', 'Extended', 'Autofix']
markdown.push(`| ${header.join(' | ')} |`)
markdown.push(`| ${header.map(() => '---').join(' | ')} |`)
@@ -238,10 +210,7 @@ function printQueries(options: Options, queries: QueryExtended[], includeAutofix
const defaultIcon = query.inDefault ? includedOcticon : notIncludedOcticon
const extendedIcon = query.inExtended ? includedOcticon : notIncludedOcticon
const autofixIcon = query.inAutofix ? includedOcticon : notIncludedOcticon
const row = [markdownLink, query.cwes.join(', '), defaultIcon, extendedIcon]
if (includeAutofix) {
row.push(autofixIcon)
}
const row = [markdownLink, query.cwes.join(', '), defaultIcon, extendedIcon, autofixIcon]
markdown.push(`| ${row.join(' | ')} |`)
}
markdown.push('') // blank line