diff --git a/README.md b/README.md index 916cc8302..68030b5e1 100644 --- a/README.md +++ b/README.md @@ -79,7 +79,7 @@ The CodeQL action should be run on `push` events, and on a `schedule`. `Push` ev ### Configuration You may optionally specify additional queries for CodeQL to execute by using a config file. The queries must belong to a [QL pack](https://help.semmle.com/codeql/codeql-cli/reference/qlpack-overview.html) and can be in your repository or any public repository. You can choose a single .ql file, a folder containing multiple .ql files, a .qls [query suite](https://help.semmle.com/codeql/codeql-cli/procedures/query-suites.html) file, or any combination of the above. To use queries from other repositories use the same syntax as when [using an action](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsuses). -You can disable the default queries using `ignore-default-queries: true`. +You can disable the default queries using `disable-default-queries: true`. You can choose to ignore some files or folders from the analysis, or include additional files/folders for analysis. This *only* works for Javascript and Python analysis. Identifying potential files for extraction: diff --git a/lib/config-utils.js b/lib/config-utils.js index ce032a2da..df70c6283 100644 --- a/lib/config-utils.js +++ b/lib/config-utils.js @@ -23,7 +23,7 @@ exports.ExternalQuery = ExternalQuery; class Config { constructor() { this.name = ""; - this.ignoreDefaultQueries = false; + this.disableDefaultQueries = false; this.additionalQueries = []; this.externalQueries = []; this.pathsIgnore = []; @@ -76,8 +76,8 @@ function initConfig() { if (parsedYAML.name && typeof parsedYAML.name === "string") { config.name = parsedYAML.name; } - if (parsedYAML['ignore-default-queries'] && typeof parsedYAML['ignore-default-queries'] === "boolean") { - config.ignoreDefaultQueries = parsedYAML['ignore-default-queries']; + if (parsedYAML['disable-default-queries'] && typeof parsedYAML['disable-default-queries'] === "boolean") { + config.disableDefaultQueries = parsedYAML['disable-default-queries']; } const queries = parsedYAML.queries; if (queries && queries instanceof Array) { diff --git a/lib/finalize-db.js b/lib/finalize-db.js index b2c607c5a..b9a33f155 100644 --- a/lib/finalize-db.js +++ b/lib/finalize-db.js @@ -89,7 +89,7 @@ async function runQueries(codeqlCmd, databaseFolder, sarifFolder, config) { for (let database of fs.readdirSync(databaseFolder)) { core.startGroup('Analyzing ' + database); const queries = []; - if (!config.ignoreDefaultQueries) { + if (!config.disableDefaultQueries) { queries.push(database + '-code-scanning.qls'); } queries.push(...queriesPerLanguage[database]); diff --git a/src/config-utils.ts b/src/config-utils.ts index 71d5edc12..fb74c4228 100644 --- a/src/config-utils.ts +++ b/src/config-utils.ts @@ -17,7 +17,7 @@ export class ExternalQuery { export class Config { public name = ""; - public ignoreDefaultQueries = false; + public disableDefaultQueries = false; public additionalQueries: string[] = []; public externalQueries: ExternalQuery[] = []; public pathsIgnore: string[] = []; @@ -82,8 +82,8 @@ function initConfig(): Config { config.name = parsedYAML.name; } - if (parsedYAML['ignore-default-queries'] && typeof parsedYAML['ignore-default-queries'] === "boolean") { - config.ignoreDefaultQueries = parsedYAML['ignore-default-queries']; + if (parsedYAML['disable-default-queries'] && typeof parsedYAML['disable-default-queries'] === "boolean") { + config.disableDefaultQueries = parsedYAML['disable-default-queries']; } const queries = parsedYAML.queries; diff --git a/src/finalize-db.ts b/src/finalize-db.ts index e1cc1fc3e..f0f60e828 100644 --- a/src/finalize-db.ts +++ b/src/finalize-db.ts @@ -103,7 +103,7 @@ async function runQueries(codeqlCmd: string, databaseFolder: string, sarifFolder core.startGroup('Analyzing ' + database); const queries: string[] = []; - if (!config.ignoreDefaultQueries) { + if (!config.disableDefaultQueries) { queries.push(database + '-code-scanning.qls'); } queries.push(...queriesPerLanguage[database]);