Skip to content

Commit 8e4eb9a

Browse files
committed
Tweaks to mention variant analysis in related articles
1 parent 49ec539 commit 8e4eb9a

File tree

4 files changed

+14
-8
lines changed

4 files changed

+14
-8
lines changed

docs/codeql/codeql-for-visual-studio-code/about-codeql-for-visual-studio-code.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ CodeQL for Visual Studio Code provides an easy way to run queries from the large
1414
With these queries, or your own custom queries, you can analyze databases generated from source code to find errors and security vulnerabilities.
1515
The Results view shows the flow of data through the results of path queries, which is essential for triaging security results.
1616

17-
The CodeQL extension also adds a **CodeQL** sidebar view to VS Code. This contains a list of databases, and an overview of the queries that you have run in the current session.
17+
The CodeQL extension also adds a **CodeQL** sidebar view to VS Code. This contains a list of local CodeQL databases, an overview of the queries that you have run in the current session, and a variant analysis view for large scale analysis.
1818

1919
The extension provides standard `IntelliSense <https://code.visualstudio.com/docs/editor/intellisense>`__
2020
features for query files (extension ``.ql``) and library files (extension ``.qll``) that you open in the Visual Studio Code editor.
@@ -36,4 +36,5 @@ Further reading
3636
-------------------
3737

3838
- ":doc:`Setting up CodeQL in Visual Studio Code <setting-up-codeql-in-visual-studio-code>`"
39-
- ":doc:`Analyzing your projects <analyzing-your-projects>`"
39+
- ":doc:`Analyzing your projects <analyzing-your-projects>`"
40+
- ":doc:`Running CodeQL queries at scale with multi-repository variant analysis <running-codeql-queries-at-scale-with-mrva>`"

docs/codeql/codeql-for-visual-studio-code/analyzing-your-projects.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Analyzing your projects
66
=================================================
77

8-
You can run queries on CodeQL databases and view the results in Visual Studio Code.
8+
You can run queries on CodeQL databases and view the results in Visual Studio Code. This article explains how to get a CodeQL database and analyze it on your local machine. For information on running analysis at scale across many CodeQL databases, see ":ref:`Running CodeQL queries at scale with multi-repository variant analysis <running-codeql-queries-at-scale-with-mrva>`."
99

1010
Choosing a database
1111
------------------------
@@ -24,8 +24,8 @@ To analyze a project, you need to add a :ref:`CodeQL database <codeql-database>`
2424

2525
#. Once you've chosen a database, it is displayed in the Databases view. To see the menu options for interacting with a database, right-click an entry in the list. You can select multiple databases using **Ctrl/Cmd+click**.
2626

27-
Obtaining a local database
28-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
27+
Importing a local database
28+
~~~~~~~~~~~~~~~~~~~~~~~~~~
2929

3030
If you have a CodeQL database saved locally, as an unarchived folder or as a ZIP file, you can add it to Visual Studio Code. There are several ways to obtain a local CodeQL database.
3131

@@ -37,6 +37,9 @@ If you have a CodeQL database saved locally, as an unarchived folder or as a ZIP
3737

3838
For more information about running query tests, see "`Testing custom queries <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/testing-custom-queries>`__" in the CodeQL CLI help.
3939

40+
Downloading a database from GitHub
41+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
42+
4043
.. include:: ../reusables/download-github-database.rst
4144

4245
Running a query

docs/codeql/codeql-for-visual-studio-code/exploring-data-flow-with-path-queries.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ You can also modify the existing queries to model data flow more precisely for t
2020
To ensure that your path query uses the correct format and metadata, follow the instructions in ":ref:`Creating path queries <creating-path-queries>`."
2121
This topic also contains detailed information about how to define new sources and sinks, as well as templates and examples of how to extend the CodeQL libraries to suit your analysis.
2222

23-
Running path queries in VS Code
24-
-----------------------------------
23+
Running path queries in VS Code locally
24+
---------------------------------------
2525

2626
#. Open a path query in the editor.
2727
#. Right-click in the query window and select **CodeQL: Run Query on Selected Database**. (Alternatively, run the command from the Command Palette.)
@@ -30,6 +30,8 @@ Running path queries in VS Code
3030
#. Click each step to jump to it in the source code and investigate the problem further.
3131
#. To navigate the results from your keyboard, you can bind shortcuts to the **CodeQL: Navigate Up/Down/Left/Right in Result Viewer** commands.
3232

33+
When you are ready to run a path query at scale, you can use the Variant Analysis Repositories panel to run the query against up to 1000 repositories on GitHub.com. For information on running analysis at scale across many CodeQL databases, see ":ref:`Running CodeQL queries at scale with multi-repository variant analysis <running-codeql-queries-at-scale-with-mrva>`."
34+
3335
Further reading
3436
-----------------
3537

docs/codeql/codeql-for-visual-studio-code/testing-codeql-queries-in-visual-studio-code.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Testing CodeQL queries in Visual Studio Code
66
============================================
77

8-
You can run unit tests for CodeQL queries using the Visual Studio Code extension.
8+
You can run unit tests for CodeQL queries using the Visual Studio Code extension. When you are sure that your query finds the results you want to identify, you can use variant analysis to run it at scale. For information on running analysis at scale across many CodeQL databases, see ":ref:`Running CodeQL queries at scale with multi-repository variant analysis <running-codeql-queries-at-scale-with-mrva>`."
99

1010
About testing queries in VS Code
1111
---------------------------------

0 commit comments

Comments
 (0)