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

VS Code extension docs: Changes to database downloads #14668

Merged
merged 3 commits into from
Nov 8, 2023

Conversation

shati-patel
Copy link
Contributor

@shati-patel shati-patel commented Nov 2, 2023

After github/vscode-codeql#3047 gets released, we'll no longer add database source archives to the workspace by default (since this caused bugs in certain workspaces).

The main feature that's affected is the "AST viewer", so I've added an extra step to the instructions there.

I've also described a new setting in "Customizing settings", in case users want to restore the old behavior:

image

@@ -39,7 +39,7 @@ Changing the labels of query history items

The query history **Format** setting controls how the extension lists queries in the query history. By default, each item has a label with the following format::

%q on %d - %s, %r result count [%t]
%q on %d - %s %r [%t]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Unrelated change: I just spotted that this was out of date.

1. Open a source file from a CodeQL database. For example, you can navigate to a source file in the File Explorer.
1. Open the CodeQL Databases view and right-click the database that you want to explore. Click **Add Database Source to Workspace**.

.. image:: ../images/codeql-for-visual-studio-code/add-database-source-to-workspace.png
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've stuck with a dark mode screenshot, for consistency with the rest of this doc.

@shati-patel shati-patel marked this pull request as ready for review November 2, 2023 17:26
@shati-patel shati-patel requested a review from a team as a code owner November 2, 2023 17:26
charisk
charisk previously approved these changes Nov 3, 2023
Copy link
Contributor

@charisk charisk left a comment

Choose a reason for hiding this comment

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

LGTM

@shati-patel shati-patel added the ready-for-doc-review This PR requires and is ready for review from the GitHub docs team. label Nov 6, 2023
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.

Thank you, looks great!

@shati-patel shati-patel merged commit 3586231 into main Nov 8, 2023
5 checks passed
@shati-patel shati-patel deleted the shati-patel/docs-databases branch November 8, 2023 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation ready-for-doc-review This PR requires and is ready for review from the GitHub docs team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants