hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-23 20:26:32 +01:00
Code Issues Packages Projects Releases Wiki Activity

Revise troubleshooting article

Browse Source
This commit is contained in:
Felicity Chapman
2023-02-27 16:42:07 +00:00
parent 8e4eb9ad46
commit 1d13811e46
1 changed files with 0 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/codeql/codeql-for-visual-studio-code/troubleshooting-variant-analysis.rst
View File

@@ -28,26 +28,3 @@ If there are problems with the variant analysis run, you will see a warning bann
In this example, the user ran variant analysis on a custom list of two repositories. One of the repositories was a private repository and could not be analyzed because they had a public controller repository. Only the public repository was analyzed. To analyze both repositories, they need to edit their settings and update the controller repository to a private repository. For information on how to edit the controller repository, see ":ref:`Customizing settings <customizing-settings>`."
CodeQL extension error: Bundling pack failed
--------------------------------------------
If the CodeQL extension fails to create the CodeQL pack, you will see an error message in the bottom right corner of Visual Studio Code. For example:
.. image:: ../images/codeql-for-visual-studio-code/variant-analysis-cli-error.png
:width: 450
:alt: Screenshot of a Visual Studio Code error shown in the bottom right corner of the application. The error message "Bundling pack failed" is visible. The "Show log" button is highlighted with a dark orange outline.
TODO: Ask James to check this is a reasonable example, or to create a better screenshot for this example.
The most likely cause of this type of error is that your current workspace does not contain the CodeQL workspace.
You can update your environment to fix this problem as follows.
#. Change the root of your workspace for Visual Studio Code to be the same as your CodeQL workspace.
TODO: Ask for more information about this step above.
#. Add an extra folder in your workspace (**File > Add Folder to Workspace**) for the suite-helpers: ``codeql/misc/suite-helpers``.
#. Using the terminal in Visual Studio Code, use the CodeQL CLI to download the ``codeql/suite-helpers`` pack: ``codeql pack download codeql/suite-helpers``.