The pack creation process loads help files from an external repository during the build process. The existing process will try to find a matching branch in the external repository. For runs triggered by push to a branch (e.g. main, rc/2.37.1 etc.), we will try to find a branch of the same name in the external help repo. For merge groups, we find the base branch name. However, for PRs, we find the name of the PR branch instead. As many PRs do not have equivalent branches in the help repo, this means that pack creation on most PRs do not load any help at all. Therefore the artifacts built on PR check runs often do not have appropriate help.
This PR makes the following changes:
The external help ref lookup process now uses the base ref consistently. As per our release process, main and every rc/... branch should exist on the external help repository, thus avoiding failed lookups.
Makes not finding the ref in the external help repository a fatal error, to avoid accidentally creating packs without help files if we don't create the appropriate branch in the help repo.
Change request type
[x] 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
[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
The pack creation process loads help files from an external repository during the build process. The existing process will try to find a matching branch in the external repository. For runs triggered by push to a branch (e.g.
main,rc/2.37.1etc.), we will try to find a branch of the same name in the external help repo. For merge groups, we find the base branch name. However, for PRs, we find the name of the PR branch instead. As many PRs do not have equivalent branches in the help repo, this means that pack creation on most PRs do not load any help at all. Therefore the artifacts built on PR check runs often do not have appropriate help.This PR makes the following changes:
mainand everyrc/...branch should exist on the external help repository, thus avoiding failed lookups.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.