17444b74bd
* Clarify how to exclude files from analysis * Update content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com> * Update content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com> * Update content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com> Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>
33 lines
1.6 KiB
Markdown
33 lines
1.6 KiB
Markdown
This configuration file adds the `security-and-quality` query suite to the list of queries run by {% data variables.product.prodname_codeql %} when scanning your code. For more information about the query suites available for use, see "[Running additional queries](#running-additional-queries)."
|
|
|
|
``` yaml
|
|
name: "My {% data variables.product.prodname_codeql %} config"
|
|
|
|
queries:
|
|
- uses: security-and-quality
|
|
```
|
|
|
|
The following configuration file disables the default queries and specifies a set of custom queries to run instead. It also configures {% data variables.product.prodname_codeql %} to scan files in the _src_ directory (relative to the root), except for the _src/node_modules_ directory, and except for files whose name ends in _.test.js_. Files in _src/node_modules_ and files with names ending _.test.js_ are therefore excluded from analysis.
|
|
|
|
``` yaml
|
|
name: "My {% data variables.product.prodname_codeql %} config"
|
|
|
|
disable-default-queries: true
|
|
|
|
queries:
|
|
- name: Use an in-repository {% data variables.product.prodname_ql %} pack (run queries in the my-queries directory)
|
|
uses: ./my-queries
|
|
- name: Use an external JavaScript {% data variables.product.prodname_ql %} pack (run queries from an external repo)
|
|
uses: octo-org/javascript-qlpack@main
|
|
- name: Use an external query (run a single query from an external {% data variables.product.prodname_ql %} pack)
|
|
uses: octo-org/python-qlpack/show_ifs.ql@main
|
|
- name: Use a query suite file (run queries from a query suite in this repo)
|
|
uses: ./codeql-qlpacks/complex-python-qlpack/rootAndBar.qls
|
|
|
|
paths:
|
|
- src
|
|
paths-ignore:
|
|
- src/node_modules
|
|
- '**/*.test.js'
|
|
```
|