From 831c686d9b708f38e486df56458dc92b2f494692 Mon Sep 17 00:00:00 2001 From: Sam Partington Date: Fri, 28 Aug 2020 16:58:15 +0100 Subject: [PATCH] Add details of queries property to README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index dfca171ca..17f4caaf1 100644 --- a/README.md +++ b/README.md @@ -100,6 +100,22 @@ Use the `config-file` parameter of the `init` action to enable the configuration The configuration file must be located within the local repository. For information on how to write a configuration file, see "[Using a custom configuration](https://help.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#using-a-custom-configuration)." +If you only want to customise the queries used, you can specify them in your workflow instead of creating a config file, using the `queries` property of the `init` action: + +```yaml +- uses: github/codeql-action/init@v1 + with: + queries: , +``` + +By default, this will override any queries specified in a config file. If you wish to use both sets of queries, prefix the list of queries in the workflow with `+`: + +```yaml +- uses: github/codeql-action/init@v1 + with: + queries: +, +``` + ## Troubleshooting Read about [troubleshooting code scanning](https://help.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-code-scanning).