Docs: Mention packaging commands in CodeQL extension #7661
Conversation
shati-patel
added
the
ready-for-doc-review
adityasharad
left a comment
adityasharad
left a comment
There was a problem hiding this comment.
Good stuff. Couple of minor suggestions.
docs/codeql/codeql-for-visual-studio-code/working-with-codeql-packs-in-visual-studio-code.rst
Outdated
Show resolved
Hide resolved
docs/codeql/codeql-for-visual-studio-code/working-with-codeql-packs-in-visual-studio-code.rst
Outdated
Show resolved
Hide resolved
felicitymay
left a comment
felicitymay
left a comment
There was a problem hiding this comment.
@shati-patel - thank you so much for updating the documentation for these new commands. 💖
I've made various suggestions for possible improvements, but these are based just on viewing your gifs as I haven't been able to use the commands. Feel free to ignore any that don't make sense.
I think this change should be merged into the CLI 2.7.6 branch, assuming that we'll want to update the docs to include this change when we release 2.7.6? Otherwise it won't be published until a new CLI branch is taken from main and that CLI version released.
| Viewing CodeQL packs and their dependencies in Visual Studio Code | ||
| ----------------------------------------------------------------- | ||
| Whether you have used the CodeQL CLI to download a CodeQL pack that someone else has created, or created your own, you can open the ``qlpack.yml`` file in the root of a CodeQL pack directory in Visual Studio Code and view the dependencies section to see what libraries the pack depends on. | ||
| To download a CodeQL pack that someone else has created, run the **CodeQL: Download Packs** command from the Command Palette. |
There was a problem hiding this comment.
Having watched the gif (thanks), I wonder if we need to mention that you'll need to enter the full pack name and give an example. This may be obvious to the user but I wanted to check.
There was a problem hiding this comment.
Also - potentially, this deserves its own heading, even though it will be a very short section, to make it easier for users to find when they scan this article.
There was a problem hiding this comment.
Thanks! I've added a bit of clarification and an example in 1462565 ⚡
Haven't added a new heading just yet, since we don't expect too many users to use this command at the moment. Once we've added a way to directly run queries from a downloaded pack, we can make this more discoverable! (Currently, they'd have to find the queries in their package cache, which isn't ideal...)
|
|
||
| Installing dependencies for CodeQL packs in Visual Studio Code | ||
| -------------------------------------------------------------- | ||
| To install dependencies for a CodeQL pack in your Visual Studio Code workspace, run the **CodeQL: Install Pack Dependencies** command from the Command Palette and select the packs you want to install dependencies for. |
There was a problem hiding this comment.
In the demo gif, this is called CodeQL: Install Packs - I assume that the name changed since you recorded that?
There was a problem hiding this comment.
Yes. sorry about that - the GIF is slightly outdated! We decided to change the command name to be more explicit 😺
docs/codeql/codeql-for-visual-studio-code/working-with-codeql-packs-in-visual-studio-code.rst
Outdated
Show resolved
Hide resolved
docs/codeql/codeql-for-visual-studio-code/working-with-codeql-packs-in-visual-studio-code.rst
Outdated
Show resolved
Hide resolved
Co-authored-by: Felicity Chapman <felicitymay@github.com>
Thanks for the review! ✨ 🎉 This feature hasn't been released yet in the extension so merging into |
felicitymay
left a comment
felicitymay
left a comment
There was a problem hiding this comment.
Thanks for the clarifications and assurance about the target branch. This LGTM 🚀
3 participants
We've introduced two new commands in github/vscode-codeql#1076 which will make it easier to work with CodeQL packs from within VS Code. You can download packs and install pack dependencies. I think this is a suitable place to document the new commands, but other suggestions are welcome! 📝
The linked PR also has some demo GIFs for reference 😊
No real rush to get this reviewed/merged, since the commands should be fairly self-explanatory. Just whenever the next CLI release happens!