From 32ced8c9013ff2ff6f9652ab98596f494ca4ac1a Mon Sep 17 00:00:00 2001 From: David Verdeguer Date: Wed, 29 Apr 2020 14:05:40 +0200 Subject: [PATCH] Update README --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 219864679..916cc8302 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,8 @@ 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 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: - Scans each folder that's defined as `paths` in turn, traversing subfolders and looking for relevant files. @@ -98,6 +100,8 @@ A config file looks like this: ```yaml name: "My CodeQL config" +ignore-default-queries: true + queries: - name: In-repo queries (Runs the queries located in the my-queries folder of the repo) uses: ./my-queries