This PR adds a GitHub Action to the repository for processing the coding-standards.yml configuration files in the repository.
Once this is merged, users will be able to add the following to their workflows to automatically process and index CodeQL Coding Standard configuration files in their repository:
The @v2 would pick up the latest v2 release. Customers could also specify a particular version.
I have not added a change note or changed the documentation yet - the intention is to update those once we have this merged and tested in a range of scenarios, and also released the qlpacks.
Change request type
[x] Release or process automation (GitHub workflows, internal scripts)
[ ] Internal documentation
[ ] External documentation
[ ] Query files (.ql, .qll, .qls or unit tests)
[x] External scripts (analysis report or other code shipped as part of a release)
Rules with added or modified queries
[x] No rules added
[ ] Queries have been added for the following rules:
rule number here
[ ] Queries have been modified for the following rules:
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
[x] 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.
[x] 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!)
Description
This PR adds a GitHub Action to the repository for processing the
coding-standards.ymlconfiguration files in the repository.Once this is merged, users will be able to add the following to their workflows to automatically process and index CodeQL Coding Standard configuration files in their repository:
The
@v2would pick up the latestv2release. Customers could also specify a particular version.I have not added a change note or changed the documentation yet - the intention is to update those once we have this merged and tested in a range of scenarios, and also released the qlpacks.
Change request type
.ql,.qll,.qlsor 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.