Skip to content

Add more info about dot syntax to the readme #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Daverlo merged 4 commits into from
May 22, 2020
Merged

Add more info about dot syntax to the readme #42

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
25e5256
Add more info about dot syntax
Daverlo May 17, 2020
90c07ef
Update README
Daverlo May 18, 2020
7b32c3c
Merge branch 'master' into dot-syntax
Daverlo May 18, 2020
080dc8c
Merge branch 'master' into dot-syntax
Daverlo May 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,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).
Copy link
Contributor

@robertbrignull robertbrignull May 18, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo in "locatio". I personally would also rewrite the last sentence as "Note that when using local queries starting with ./, the path is relative to the root of the repository and not to the location of the config file."

I think it flows a bit better. I know what you mean currently but constructions like "Note that for using" are a little bit odd, and I think flipping the order of the last two cases makes it more clear.

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 stored in your repository or 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). Note that when using local queries starting with `./`, the path is relative to the root of the repository and not to the location of the config file.

You can disable the default queries using `disable-default-queries: true`.

Expand Down