Skip to content
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

Merged
merged 20 commits into from
Oct 23, 2024
Merged

Produce qlpacks as a build artifact #743

merged 20 commits into from
Oct 23, 2024

Conversation

lcartey
Copy link
Collaborator

@lcartey lcartey commented Oct 9, 2024

Description

This PR amends our automation and release process to produce qlpacks in addition to the existing bundle:

  • The existing compilation of queries in .github/workflows/code-scanning-pack-gen.yml is modified to (a) perform all compilations in a single step (instead of separately for c and cpp), and (b) increases the compilation cache size to ensure we retain the cached compilations for all Coding Standards queries.
  • A new step is added to .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.
  • The new packs are uploaded as an artifact with the name 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 existing code-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

  • Release or process automation (GitHub workflows, internal scripts)
  • Internal documentation
  • External documentation
  • Query files (.ql, .qll, .qls or unit tests)
  • External scripts (analysis report or other code shipped as part of a release)

Rules with added or modified queries

  • No rules added
  • Queries have been added for the following rules:
    • rule number here
  • Queries have been modified for the following rules:
    • rule number here

Release change checklist

A change note (development_handbook.md#change-notes) is required for any pull request which modifies:

  • The structure or layout of the release artifacts.
  • The evaluation performance (memory, execution time) of an existing query.
  • The results of an existing query in any circumstance.

If you are only adding new rule queries, a change note is not required.

Author: Is a change note required?

  • Yes
  • No

🚨🚨🚨
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.

  • Confirmed

Reviewer: Confirm that either a change note is not required or the change note is required and has been added.

  • Confirmed

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

  • Have all the relevant rule package description files been checked in?
  • Have you verified that the metadata properties of each new query is set appropriately?
  • Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
  • Are the alert messages properly formatted and consistent with the style guide?
  • Have you run the queries on OpenPilot and verified that the performance and results are acceptable?
    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.
  • Does the query have an appropriate level of in-query comments/documentation?
  • Have you considered/identified possible edge cases?
  • Does the query not reinvent features in the standard library?
  • Can the query be simplified further (not golfed!)

Reviewer

  • Have all the relevant rule package description files been checked in?
  • Have you verified that the metadata properties of each new query is set appropriately?
  • Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
  • Are the alert messages properly formatted and consistent with the style guide?
  • Have you run the queries on OpenPilot and verified that the performance and results are acceptable?
    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.
  • Does the query have an appropriate level of in-query comments/documentation?
  • Have you considered/identified possible edge cases?
  • Does the query not reinvent features in the standard library?
  • Can the query be simplified further (not golfed!)

lcartey and others added 7 commits October 9, 2024 23:55
 - 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.
@lcartey lcartey added this to the 2.37.0 milestone Oct 22, 2024
@lcartey lcartey marked this pull request as ready for review October 22, 2024 09:47
Copy link
Contributor

@knewbury01 knewbury01 left a comment

Choose a reason for hiding this comment

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

few minor comments

.github/workflows/code-scanning-pack-gen.yml Outdated Show resolved Hide resolved
.github/workflows/code-scanning-pack-gen.yml Outdated Show resolved Hide resolved
scripts/release/release-layout.yml Outdated Show resolved Hide resolved
docs/user_manual.md Outdated Show resolved Hide resolved
@lcartey
Copy link
Collaborator Author

lcartey commented Oct 22, 2024

@knewbury01 I've updated to address your latest comment, and added a release note.

docs/user_manual.md Outdated Show resolved Hide resolved
Copy link
Contributor

@knewbury01 knewbury01 left a 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

Copy link
Contributor

@knewbury01 knewbury01 left a 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!

@knewbury01 knewbury01 added this pull request to the merge queue Oct 23, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Oct 23, 2024
@lcartey lcartey added this pull request to the merge queue Oct 23, 2024
Merged via the queue into main with commit d48d3f7 Oct 23, 2024
24 checks passed
@lcartey lcartey deleted the lcartey/produce-ql-packs branch October 23, 2024 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants