-
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
Produce qlpacks as a build artifact #743
Conversation
- Update pattern to capture .tgz qlpack files. - Add extra verbosity to the cert-cpp call to see what discrepancies occur with the autosar-cpp (as we see the autosar pack bundling retrigger compilation) - Combine the query compile calls in the earlier step to try to promote retaining all the cache.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
few minor comments
@knewbury01 I've updated to address your latest comment, and added a release note. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
one small fix on a url
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice work, looks good!
Description
This PR amends our automation and release process to produce qlpacks in addition to the existing bundle:
.github/workflows/code-scanning-pack-gen.yml
is modified to (a) perform all compilations in a single step (instead of separately forc
andcpp
), and (b) increases the compilation cache size to ensure we retain the cached compilations for all Coding Standards queries..github/workflows/code-scanning-pack-gen.yml
to generate qlpacks in a.tgz
format. This uses the cached compilations, and should be quick to complete.coding-standards-qlpacks
. This should be generated for every PR and push to main, as with the existing artifact.release-layout.yml
is updated to include the new artifact. This should ensure that the artifact is copied onto releases in a similar way to the existingcode-scanning-cpp-query-pack.ql
artifact.This PR does not attempt to change our release process to publish the generated packs - only add them as an artifact to the release page. For the next release I plan to manually push the packs to the registry, and look to automate for following releases.
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.