-
Notifications
You must be signed in to change notification settings - Fork 67
Remove LGTM references and update query pack name #321
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
Conversation
Remove the LGTM reference from the manual, and correct the query pack name and supported versions list name.
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.
there seem to be some lgtm references in other places in the repo too ,
like the iso doc. while some of those describe historical process (should not be scrubbed?), some refer to future process so are no longer accurate? not totally sure.
there are some mentions in the dev handbook too
and a deprecated lgtm url in a query
just a suggestion, but maybe we could clean them all up at the same time, unless the user manual is the most important to not have those, in that case lgtm! (pun intended!)
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.
If we are changing this for good it might be a good idea to also update the bump script? https://github.com/github/codeql-coding-standards/blob/main/scripts/bump_version.sh#L17
LGTM.com is no longer used for testing of CodeQL releases.
Thanks @jsinglet @knewbury01 - good spots. Comments addressed:
Ready for re-review. |
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.
Thanks @lcartey!
Description
Remove the LGTM reference from the manual, and correct the query pack name and supported versions list name.
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.