mirror of
https://github.com/github/codeql.git
synced 2025-12-23 20:26:32 +01:00
Tweaks to mention variant analysis in related articles
This commit is contained in:
Felicity Chapman
@@ -14,7 +14,7 @@ CodeQL for Visual Studio Code provides an easy way to run queries from the large
|
||||
With these queries, or your own custom queries, you can analyze databases generated from source code to find errors and security vulnerabilities.
|
||||
The Results view shows the flow of data through the results of path queries, which is essential for triaging security results.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
The extension provides standard `IntelliSense <https://code.visualstudio.com/docs/editor/intellisense>`__
|
||||
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
|
||||
-------------------
|
||||
|
||||
- ":doc:`Setting up CodeQL in Visual Studio Code <setting-up-codeql-in-visual-studio-code>`"
|
||||
- ":doc:`Analyzing your projects <analyzing-your-projects>`"
|
||||
- ":doc:`Analyzing your projects <analyzing-your-projects>`"
|
||||
- ":doc:`Running CodeQL queries at scale with multi-repository variant analysis <running-codeql-queries-at-scale-with-mrva>`"
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
Analyzing your projects
|
||||
=================================================
|
||||
|
||||
You can run queries on CodeQL databases and view the results in Visual Studio Code.
|
||||
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>`."
|
||||
|
||||
Choosing a database
|
||||
------------------------
|
||||
@@ -24,8 +24,8 @@ To analyze a project, you need to add a :ref:`CodeQL database <codeql-database>`
|
||||
|
||||
#. 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**.
|
||||
|
||||
Obtaining a local database
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Importing a local database
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
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.
|
||||
|
||||
@@ -37,6 +37,9 @@ If you have a CodeQL database saved locally, as an unarchived folder or as a ZIP
|
||||
|
||||
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.
|
||||
|
||||
Downloading a database from GitHub
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. include:: ../reusables/download-github-database.rst
|
||||
|
||||
Running a query
|
||||
|
||||
@@ -20,8 +20,8 @@ You can also modify the existing queries to model data flow more precisely for t
|
||||
To ensure that your path query uses the correct format and metadata, follow the instructions in ":ref:`Creating path queries <creating-path-queries>`."
|
||||
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.
|
||||
|
||||
Running path queries in VS Code
|
||||
-----------------------------------
|
||||
Running path queries in VS Code locally
|
||||
---------------------------------------
|
||||
|
||||
#. Open a path query in the editor.
|
||||
#. 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
|
||||
#. Click each step to jump to it in the source code and investigate the problem further.
|
||||
#. To navigate the results from your keyboard, you can bind shortcuts to the **CodeQL: Navigate Up/Down/Left/Right in Result Viewer** commands.
|
||||
|
||||
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>`."
|
||||
|
||||
Further reading
|
||||
-----------------
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
Testing CodeQL queries in Visual Studio Code
|
||||
============================================
|
||||
|
||||
You can run unit tests for CodeQL queries using the Visual Studio Code extension.
|
||||
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>`."
|
||||
|
||||
About testing queries in VS Code
|
||||
---------------------------------
|
||||
|
||||
Reference in New Issue
Block a user