Skip to content

Commit 874c362

Browse files
committed
Add basic framework of new articles
1 parent 44dc5a1 commit 874c362

File tree

5 files changed

+79
-2
lines changed

5 files changed

+79
-2
lines changed

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

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,11 @@ The CodeQL extension for Visual Studio Code adds rich language support for CodeQ
2727
VS Code to help you track the flow of data through a program, highlighting
2828
areas that are potential security vulnerabilities.
2929

30+
- :doc:`Running CodeQL queries at scale with multi-repository variant analysis
31+
<running-codeql-queries-at-scale-with-mrva>`: You can run queries against groups
32+
of repositories on GitHub.com and view results in Visual Studio Code as each analysis
33+
finishes.
34+
3035
- :doc:`Testing CodeQL queries in Visual Studio Code
3136
<testing-codeql-queries-in-visual-studio-code>`: You can run unit tests for
3237
CodeQL queries using the Visual Studio Code extension.
@@ -40,7 +45,13 @@ The CodeQL extension for Visual Studio Code adds rich language support for CodeQ
4045

4146
- :doc:`Troubleshooting CodeQL for Visual Studio Code
4247
<troubleshooting-codeql-for-visual-studio-code>`: You can use the detailed
43-
information written to the extension's log files if you need to troubleshoot problems.
48+
information written to the extension's log files if you need to troubleshoot problems with
49+
analysis of local CodeQL databases.
50+
51+
- :doc:`Troubleshooting variant analysis
52+
<troubleshooting-variant-analysis>`: You can use the detailed
53+
information written to workflow log files in your controller repository if you need to
54+
troubleshoot problems with analysis of CodeQL databases stored on GitHub.com.
4455

4556
- :doc:`About telemetry in CodeQL for Visual Studio Code <about-telemetry-in-codeql-for-visual-studio-code>`: If you specifically opt in to permit GitHub to do so, GitHub will collect usage data and metrics for the purposes of helping the core developers to improve the CodeQL extension for VS Code.
4657

@@ -53,8 +64,10 @@ The CodeQL extension for Visual Studio Code adds rich language support for CodeQ
5364
analyzing-your-projects
5465
exploring-the-structure-of-your-source-code
5566
exploring-data-flow-with-path-queries
67+
running-codeql-queries-at-scale-with-mrva
5668
testing-codeql-queries-in-visual-studio-code
5769
working-with-codeql-packs-in-visual-studio-code
5870
customizing-settings
5971
troubleshooting-codeql-for-visual-studio-code
72+
troubleshooting-variant-analysis
6073
about-telemetry-in-codeql-for-visual-studio-code
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
:tocdepth: 1
2+
3+
.. _running-codeql-queries-at-scale-with-mrva:
4+
5+
Running CodeQL queries at scale with multi-repository variant analysis
6+
======================================================================
7+
8+
.. include:: ../reusables/beta-note-mrva.rst
9+
10+
About multi-repository variant analysis
11+
---------------------------------------
12+
13+
Explain what MVRA is, when it's useful, and basic billing (uses actions minutes for private repos).
14+
15+
.. _controller-repository:
16+
17+
About the controller repository
18+
-------------------------------
19+
Explain what a controller repository is, how to choose a good repository, can a team use a single repository, and any other questions that came up during the private beta test. Note that if you want to run MRVA on private repositories, you need to use a private controller repository to enable analysis.
20+
21+
Getting started with variant analysis
22+
-------------------------------------
23+
Explain how to set it up for the first time.
24+
Explain how to run variant analysis.
25+
Explain how the results view works.
26+
27+
Configuring variant analysis
28+
----------------------------
29+
Explain how to create your own list of repositories.
30+
Explain how to change your controller repository.
31+
32+
Troubleshooting variant analysis
33+
--------------------------------
34+
35+
For information on troubleshooting variant analysis, see
36+
":ref:`Troubleshooting variant analysis <troubleshooting-variant-analysis>`."
37+

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,12 @@
55
Troubleshooting CodeQL for Visual Studio Code
66
=============================================
77

8-
You can use the detailed information written to the extension's log files if you need to troubleshoot problems.
8+
This article explains how to debug problems with the analysis of CodeQL databases that are stored on your local
9+
machine. For information on troubleshooting variant analysis, where the CodeQL dataabases are on GitHub.com, see
10+
":ref:`Troubleshooting variant analysis <troubleshooting-variant-analysis>`."
11+
12+
You can use the detailed information written to the extension's log files if you need to troubleshoot problems
13+
analysing CodeQL databases that are stored locally.
914

1015
About the log files
1116
--------------------
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
:tocdepth: 1
2+
3+
.. _troubleshooting-variant-analysis:
4+
5+
Troubleshooting variant analysis
6+
================================
7+
8+
.. include:: ../reusables/beta-note-mrva.rst
9+
10+
This article explains how to debug problems with variant analysis. That is, analysis where the
11+
CodeQL databases are on GitHub.com and not locally on your machine.
12+
For information on troubleshooting local analysis, see
13+
":ref:`Troubleshooting CodeQL for Visual Studio Code <troubleshooting-codeql-for-visual-studio-code>`."
14+
15+
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. pull-quote::
2+
3+
Note
4+
5+
Multi-repository variant analysis is currently available as a beta release and is subject to change. To use this feature you must upgrade the CodeQL extension for Visual Studio Code to a minimum of version 1.8.0.
6+
7+
To provide feedback on the feature, see TODO-community-feedback-link.

0 commit comments

Comments
 (0)