-
Notifications
You must be signed in to change notification settings - Fork 67
Modernize qlpacks #72
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
Closed
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jketema
reviewed
Aug 31, 2022
Co-authored-by: Jeroen Ketema <93738568+jketema@users.noreply.github.com>
The new qlpacks break the release automation |
Once this is revisited, this will also need the changes from #151 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Merges into
main
the PR #4This PR updates the qlpacks and related files to use CodeQL packaging to declare and resolve dependencies. Neither the
codeql_modules
submodule nor thecodeql_home/codeql-stdlib
checkout ofgithub/codeql
are required anymore. The necessary dependencies can be installed by runningpython3 scripts/install-packs.py
. This need only be run when we update to a new standard library version, but it doesn't hurt to run it after every pull.None of the
codeql
commands we run should require--search-path
or--additional-packs
any longer. References within our repo are resolved automatically because all of our packs are in the same "CodeQL Workspace" (defined by our.codeqlmanifest.json
file. References to the standard library are resolved from the package download cache.Details:
codeql/
scope to all pack names, which is necessary to publish packs to the pack registry. Note that we don't actually publish to the package registry yet.dependencies:
map instead oflibraryPathDependencies:
list. The'*'
version indicates that the referenced pack will be found in the local workspace, rather than downloaded from the registry..codeqlmanifest.json
in thecpp
directory into the root.codeqlmanifest.json
. All pack references should resolve automatically now, without a need for--search-path
.codeql
directories to.gitignore
..codeql
is where the output of building a query or library pack is placed.--search-path
and--additional-packs
from all of our CI workflows.qlpack.yml
files match the versions in thegithub/codeql
commit specified insupported_codeql_configs.json
. The script used by this workflow will also be used, in a future PR, in the workflow to update to a new toolset version.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 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.