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

Jump to bottom

Add content for the queries panel and language selector #14776

Merged
merged 14 commits into from Nov 15, 2023
Merged

Add content for the queries panel and language selector #14776

merged 14 commits into from Nov 15, 2023
+54 −3

Conversation

sabrowning1
Copy link
Contributor

This PR updates "Analyzing your projects" in the CodeQL for VS Code documentation to include info on the queries panel and language selector. The main changes are:

  • A new section on using the language selector called "Filtering databases and queries by language"
  • A new section on creating a query from the queries panel called "Creating a query"
  • Updates to "Running a query" so it now details running queries from the queries panel
  • Updates to "Running multiple queries":
    • A new subsection called "Running all queries in a directory" with info on running a directory of queries through the queries panel
    • A new subsection called "Running a selection of queries" containing the existing content

@sabrowning1 sabrowning1 self-assigned this Nov 13, 2023
@sabrowning1 sabrowning1 requested a review from a team as a code owner November 13, 2023 22:26
@sabrowning1 sabrowning1 added the ready-for-doc-review This PR requires and is ready for review from the GitHub docs team. label Nov 13, 2023
@sabrowning1
Copy link
Contributor Author

👋🏼 @jf205! Here's the PR adding content for the additions of the queries panel and language selector to CodeQL for VS Code. If you could take a look and leave any feedback, that would be great, thanks!

subatoi
subatoi previously approved these changes Nov 14, 2023
View reviewed changes
Copy link
Contributor

@subatoi subatoi left a comment

Choose a reason for hiding this comment

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

LGTM, just had a sprinkling of minor comments 👍

docs/codeql/codeql-for-visual-studio-code/analyzing-your-projects.rst Outdated Show resolved Hide resolved
docs/codeql/codeql-for-visual-studio-code/analyzing-your-projects.rst Outdated Show resolved Hide resolved
docs/codeql/codeql-for-visual-studio-code/analyzing-your-projects.rst Outdated Show resolved Hide resolved
jf205
jf205 reviewed Nov 15, 2023
View reviewed changes
Copy link
Contributor

@jf205 jf205 left a comment

Choose a reason for hiding this comment

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

Thanks @sabrowning1. Looks pretty good -- I suggest just one small addition.

docs/codeql/codeql-for-visual-studio-code/analyzing-your-projects.rst
Creating a custom query
------------------------

You can generate a query template for a specific language from the queries panel, then write your own code to quickly create a custom query.
Copy link
Contributor

Choose a reason for hiding this comment

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

One thing to add here: If you select an existing folder in the queries panel then the new query will be created there rather than creating a new folder.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, thanks for calling that out! I've tweaked the content to reflect that; let me know if those changes make sense to you 🙇🏼‍♂️

@sabrowning1
Copy link
Contributor Author

👋🏼 @github/codeql-vscode-reviewers, does someone mind taking a look at this and confirming it's ready to ship with the feature tomorrow? Thanks! 🙇🏼‍♂️

shati-patel
shati-patel approved these changes Nov 15, 2023
View reviewed changes
Copy link
Contributor

@shati-patel shati-patel left a comment •
edited

Choose a reason for hiding this comment

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

Thanks! This looks great to me ✨ (And yep, can confirm it's ready to ship tomorrow 🚢 )

@felicitymay
Copy link
Contributor

👋🏻 @sabrowning1 - do we know if this is shipping tomorrow, or with the next update to the CodeQL CLI?

Either way, we can merge this now. If it's shipping with the next CodeQL CLI, then the docs changes will be picked up and published automatically. If it's actually shipping tomorrow, then we'll need to publish just the CodeQL docs changes to the CodeQL docs site tomorrow. (That sounds a little confusing, let me know if that's too many tomorrows.)

@sabrowning1
Copy link
Contributor Author

sabrowning1 commented Nov 15, 2023 •
edited

👋🏼 @felicitymay, I believe it's shipping tomorrow based on Shati's comment above and her update on the engineering issue!

Sounds good—I'll merge this now, then keep an eye out for the timing of the release tomorrow to publish the changes to the CodeQL docs site 🚀

@sabrowning1 sabrowning1 merged commit 408ba51 into main Nov 15, 2023
7 checks passed
@sabrowning1 sabrowning1 deleted the sabrowning1/queries-panel-language-selector branch November 15, 2023 22:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jf205 jf205 jf205 approved these changes

@shati-patel shati-patel shati-patel approved these changes

@subatoi subatoi subatoi left review comments

Assignees

@sabrowning1 sabrowning1

Labels
documentation ready-for-doc-review This PR requires and is ready for review from the GitHub docs team.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@sabrowning1 @felicitymay @subatoi @jf205 @shati-patel