-
Notifications
You must be signed in to change notification settings - Fork 59
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.
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
Add QL4QL to analyze the queries #511
base: main
Are you sure you want to change the base?
Conversation
Create a shell environment with a CodeQL CLI that includes the Ql extractor to create CodeQL databases of QL files.
The CLI was only used to format the generated library. We will skip that for now.
e63875c
to
29a353a
Compare
29a353a
to
b628c0c
Compare
This uses the same approach as the CodeQL derivative part of Nix packages https://github.com/NixOS/nixpkgs/blob/4299aee00ffcb68ecdc5c9a2befc244a61bec5be/pkgs/development/tools/analysis/codeql/default.nix
This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation. |
This allows us to address issues with caching within the workflow file.
1363d34
to
e1eeb03
Compare
Restoring the cache currently fails with permission issues. This is an attempt to address that.
e1eeb03
to
9537f6a
Compare
Description
This PR adds a workflow based on Nix to build a CodeQL CLI with support for QL so we can analyze our QL files for issues we want to report.
For now it runs the default suite on pushes and PRs to main.
Change request type
.ql
,.qll
,.qls
or unit tests)Rules with added or modified queries
Release change checklist
A change note (development_handbook.md#change-notes) is required for any pull request which modifies:
If you are only adding new rule queries, a change note is not required.
Author: Is a change note required?
🚨🚨🚨
Reviewer: Confirm that format of shared queries (not the .qll file, the
.ql file that imports it) is valid by running them within VS Code.
Reviewer: Confirm that either a change note is not required or the change note is required and has been added.
Query development review checklist
For PRs that add new queries or modify existing queries, the following checklist should be completed by both the author and reviewer:
Author
As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.
Reviewer
As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.