Skip to content

Commit 8cba276

Browse files
subatoisubatoi
committed
Deprecate the CodeQL for VS Code docs in favour of docs.github.com version
1 parent 17e0cc5 commit 8cba276

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+68
-32
lines changed

‎CONTRIBUTING.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ We welcome contributions to our CodeQL libraries and queries. Got an idea for a
44

55
There is lots of useful documentation to help you write queries, ranging from information about query file structure to tutorials for specific target languages. For more information on the documentation available, see [CodeQL queries](https://codeql.github.com/docs/writing-codeql-queries/codeql-queries) on [codeql.github.com](https://codeql.github.com).
66

7+
Note that the CodeQL for Visual Studio Code documentation has been migrated to https://docs.github.com/en/code-security/codeql-for-vs-code/, but you can still contribute to it via a different repository. For more information, see [Contributing to GitHub Docs documentation](https://docs.github.com/en/contributing)."
8+
79
## Change notes
810

911
Any nontrivial user-visible change to a query pack or library pack should have a change note. For details on how to add a change note for your change, see [this guide](docs/change-notes.md).
@@ -43,7 +45,7 @@ If you have an idea for a query that you would like to share with other CodeQL u
4345

4446
3. **Formatting**
4547

46-
- The queries and libraries must be autoformatted, for example using the "Format Document" command in [CodeQL for Visual Studio Code](https://codeql.github.com/docs/codeql-for-visual-studio-code/about-codeql-for-visual-studio-code).
48+
- The queries and libraries must be autoformatted, for example using the "Format Document" command in [CodeQL for Visual Studio Code](https://docs.github.com/en/code-security/codeql-for-vs-code/).
4749

4850
If you prefer, you can either:
4951
1. install the [pre-commit framework](https://pre-commit.com/) and install the configured hooks on this repo via `pre-commit install`, or

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This open source repository contains the standard CodeQL libraries and queries t
44

55
## How do I learn CodeQL and run queries?
66

7-
There is [extensive documentation](https://codeql.github.com/docs/) on getting started with writing CodeQL using the [CodeQL extension for Visual Studio Code](https://codeql.github.com/docs/codeql-for-visual-studio-code/) and the [CodeQL CLI](https://codeql.github.com/docs/codeql-cli/).
7+
There is [extensive documentation](https://codeql.github.com/docs/) on getting started with writing CodeQL using the [CodeQL extension for Visual Studio Code](https://docs.github.com/en/code-security/codeql-for-vs-code/) and the [CodeQL CLI](https://codeql.github.com/docs/codeql-cli/).
88

99
## Contributing
1010

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

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
About CodeQL for Visual Studio Code
66
=================================================
77

8+
.. include:: ../reusables/deprecation-note.rst
9+
810
CodeQL for Visual Studio Code is an extension that lets you write, run, and test CodeQL queries in Visual Studio Code.
911

1012
Features

‎docs/codeql/codeql-for-visual-studio-code/about-telemetry-in-codeql-for-visual-studio-code.rst

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
About telemetry in CodeQL for Visual Studio Code
66
=================================================
77

8+
.. include:: ../reusables/deprecation-note.rst
9+
810
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.
911

1012
This data will not be shared with any parties outside of GitHub. IP addresses and installation IDs will be retained for a maximum of 30 days. Anonymous data will be retained for a maximum of 180 days.

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

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
Analyzing your projects
66
=================================================
77

8+
.. include:: ../reusables/deprecation-note.rst
9+
810
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>`."
911

1012
Choosing a database

‎docs/codeql/codeql-for-visual-studio-code/customizing-settings.rst

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
Customizing settings
66
====================
77

8+
.. include:: ../reusables/deprecation-note.rst
9+
810
You can edit the settings for the CodeQL extension to suit your needs.
911

1012
About CodeQL extension settings

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

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
Exploring data flow with path queries
66
=====================================
77

8+
.. include:: ../reusables/deprecation-note.rst
9+
810
You can run CodeQL queries in VS Code to help you track the flow of data through a program, highlighting areas that are potential security vulnerabilities.
911

1012
About path queries

‎docs/codeql/codeql-for-visual-studio-code/exploring-the-structure-of-your-source-code.rst

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
Exploring the structure of your source code
66
=================================================
77

8+
.. include:: ../reusables/deprecation-note.rst
9+
810
You can use the AST viewer to display the abstract syntax tree of a CodeQL database.
911

1012
About the abstract syntax tree

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

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
CodeQL for Visual Studio Code
44
=============================
55

6+
.. include:: ../reusables/deprecation-note.rst
7+
68
The CodeQL extension for Visual Studio Code adds rich language support for CodeQL and allows you to easily find problems in codebases.
79

810
- :doc:`About CodeQL for Visual Studio Code

‎docs/codeql/codeql-for-visual-studio-code/running-codeql-queries-at-scale-with-mrva.rst

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
Running CodeQL queries at scale with multi-repository variant analysis
66
======================================================================
77

8+
.. include:: ../reusables/deprecation-note.rst
9+
810
.. include:: ../reusables/beta-note-mrva.rst
911

1012
About multi-repository variant analysis

‎docs/codeql/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code.rst

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
Setting up CodeQL in Visual Studio Code
66
=================================================
77

8+
.. include:: ../reusables/deprecation-note.rst
9+
810
You can install and configure the CodeQL extension in Visual Studio Code.
911

1012
.. include:: ../reusables/license-note.rst

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

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
Testing CodeQL queries in Visual Studio Code
66
============================================
77

8+
.. include:: ../reusables/deprecation-note.rst
9+
810
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>`."
911

1012
About testing queries in VS Code

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

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
Troubleshooting CodeQL for Visual Studio Code
66
=============================================
77

8+
.. include:: ../reusables/deprecation-note.rst
9+
810
This article explains how to debug problems with the analysis of CodeQL databases that are stored on your local
911
machine. For information on troubleshooting variant analysis, which runs on GitHub.com, see
1012
":ref:`Troubleshooting variant analysis <troubleshooting-variant-analysis>`."

‎docs/codeql/codeql-for-visual-studio-code/troubleshooting-variant-analysis.rst

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
Troubleshooting variant analysis
66
================================
77

8+
.. include:: ../reusables/deprecation-note.rst
9+
810
.. include:: ../reusables/beta-note-mrva.rst
911

1012
This article explains how to debug problems with variant analysis, that is, analysis run using GitHub Actions

‎docs/codeql/codeql-for-visual-studio-code/using-the-codeql-model-editor.rst

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
Using the CodeQL model editor
66
=============================
77

8+
.. include:: ../reusables/deprecation-note.rst
9+
810
.. include:: ../reusables/beta-note-model-pack-editor-vsc.rst
911

1012
You can view, write, and edit CodeQL packs in Visual Studio Code using the CodeQL extension. The model editor is designed to help you model external dependencies of your codebase that are not supported by the standard CodeQL Libraries.

‎docs/codeql/codeql-for-visual-studio-code/working-with-codeql-packs-in-visual-studio-code.rst

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
Working with CodeQL packs in Visual Studio Code
66
===============================================
77

8+
.. include:: ../reusables/deprecation-note.rst
9+
810
.. include:: ../reusables/beta-note-package-management.rst
911

1012
You can view, write, and edit all types of CodeQL packs in Visual Studio Code using the CodeQL extension.

‎docs/codeql/codeql-language-guides/codeql-library-for-ruby.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ The CodeQL examples in this article are only excerpts and are not meant to repre
7373
Abstract syntax
7474
---------------
7575

76-
The abstract syntax tree (AST) represents the elements of the source code organized into a tree. The `AST viewer <https://codeql.github.com/docs/codeql-for-visual-studio-code/exploring-the-structure-of-your-source-code/>`__
76+
The abstract syntax tree (AST) represents the elements of the source code organized into a tree. The `AST viewer <https://docs.github.com/en/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/exploring-the-structure-of-your-source-code>`__
7777
in Visual Studio Code shows the AST nodes, including the relevant CodeQL classes and predicates.
7878

7979
All CodeQL AST classes inherit from the `AstNode` class, which provides the following member predicates

‎docs/codeql/codeql-overview/about-codeql.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ Query execution
7070
After you've created a CodeQL database, one or more queries are executed
7171
against it. CodeQL queries are written in a specially-designed object-oriented
7272
query language called QL. You can run the queries checked out from the CodeQL
73-
repo (or custom queries that you've written yourself) using the :ref:`CodeQL
74-
for VS Code extension <codeql-for-visual-studio-code>` or the `CodeQL CLI
73+
repo (or custom queries that you've written yourself) using the `CodeQL
74+
for VS Code extension <https://docs.github.com/en/code-security/codeql-for-vs-code/>` or the `CodeQL CLI
7575
<https://docs.github.com/en/code-security/codeql-cli>`__. For more information about queries, see ":ref:`About CodeQL queries <about-codeql-queries>`."
7676

7777
.. _interpret-query-results:

‎docs/codeql/codeql-overview/codeql-changelog/codeql-cli-2.8.1.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Bug Fixes
8282
Python
8383
""""""
8484

85-
* The `View AST functionality <https://codeql.github.com/docs/codeql-for-visual-studio-code/exploring-the-structure-of-your-source-code/>`__ no longer prints detailed information about regular expressions, greatly improving performance.
85+
* The `View AST functionality <https://docs.github.com/en/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/exploring-the-structure-of-your-source-code>`__ no longer prints detailed information about regular expressions, greatly improving performance.
8686

8787
Minor Analysis Improvements
8888
~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎docs/codeql/codeql-overview/codeql-tools.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -53,5 +53,5 @@ CodeQL for Visual Studio Code
5353

5454
You can analyze CodeQL databases in Visual Studio Code using the CodeQL
5555
extension, which provides an enhanced environment for writing and running custom
56-
queries and viewing the results. For more information, see ":ref:`CodeQL
57-
for Visual Studio Code <codeql-for-visual-studio-code>`."
56+
queries and viewing the results. For more information, see "`CodeQL
57+
for Visual Studio Code <https://docs.github.com/en/code-security/codeql-for-vs-code/>`."

‎docs/codeql/ql-training/cpp/bad-overflow-guard.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ CodeQL for C/C++
99
Setup
1010
=====
1111

12-
For this example you need to set up `CodeQL for Visual Studio Code <https://codeql.github.com/docs/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code/>`__ and download the CodeQL database for `ChakraCore <https://github.com/Chakra-Core/ChakraCore/>`__ from GitHub.
12+
For this example you need to set up `CodeQL for Visual Studio Code <https://docs.github.com/en/code-security/codeql-for-vs-code/>`__ and download the CodeQL database for `ChakraCore <https://github.com/Chakra-Core/ChakraCore/>`__ from GitHub.
1313

1414
Checking for overflow in C
1515
==========================

‎docs/codeql/ql-training/cpp/control-flow-cpp.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ CodeQL for C/C++
1111
Setup
1212
=====
1313

14-
For this example you need to set up `CodeQL for Visual Studio Code <https://codeql.github.com/docs/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code/>`__ and download the CodeQL database for `ChakraCore <https://github.com/Chakra-Core/ChakraCore/>`__ from GitHub.
14+
For this example you need to set up `CodeQL for Visual Studio Code <https://docs.github.com/en/code-security/codeql-for-vs-code/>`__ and download the CodeQL database for `ChakraCore <https://github.com/Chakra-Core/ChakraCore/>`__ from GitHub.
1515

1616

1717
.. rst-class:: agenda

‎docs/codeql/ql-training/cpp/data-flow-cpp.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Finding string formatting vulnerabilities in C/C++
99
Setup
1010
=====
1111

12-
For this example you need to set up `CodeQL for Visual Studio Code <https://codeql.github.com/docs/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code/>`__ and download the CodeQL database for `dotnet/coreclr <https://github.com/dotnet/coreclr>`__ from GitHub.
12+
For this example you need to set up `CodeQL for Visual Studio Code <https://docs.github.com/en/code-security/codeql-for-vs-code/>`__ and download the CodeQL database for `dotnet/coreclr <https://github.com/dotnet/coreclr>`__ from GitHub.
1313

1414
.. rst-class:: agenda
1515

‎docs/codeql/ql-training/cpp/global-data-flow-cpp.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ CodeQL for C/C++
99
Setup
1010
=====
1111

12-
For this example you need to set up `CodeQL for Visual Studio Code <https://codeql.github.com/docs/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code/>`__ and download the CodeQL database for `dotnet/coreclr <https://github.com/dotnet/coreclr>`__ from GitHub.
12+
For this example you need to set up `CodeQL for Visual Studio Code <https://docs.github.com/en/code-security/codeql-for-vs-code/>`__ and download the CodeQL database for `dotnet/coreclr <https://github.com/dotnet/coreclr>`__ from GitHub.
1313

1414
.. rst-class:: agenda
1515

‎docs/codeql/ql-training/cpp/intro-ql-cpp.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ CodeQL for C/C++
99
Setup
1010
=====
1111

12-
For this example you need to set up `CodeQL for Visual Studio Code <https://codeql.github.com/docs/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code/>`__ and download the CodeQL database for `exiv2 <https://github.com/Exiv2/exiv2>`__ from GitHub.
12+
For this example you need to set up `CodeQL for Visual Studio Code <https://docs.github.com/en/code-security/codeql-for-vs-code/>`__ and download the CodeQL database for `exiv2 <https://github.com/Exiv2/exiv2>`__ from GitHub.
1313

1414
.. Include language-agnostic section here
1515

‎docs/codeql/ql-training/cpp/snprintf.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ CodeQL for C/C++
99
Setup
1010
=====
1111

12-
For this example you need to set up `CodeQL for Visual Studio Code <https://codeql.github.com/docs/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code/>`__ and download the CodeQL database for `rsyslog <https://github.com/rsyslog/rsyslog>`__ from GitHub.
12+
For this example you need to set up `CodeQL for Visual Studio Code <https://docs.github.com/en/code-security/codeql-for-vs-code/>`__ and download the CodeQL database for `rsyslog <https://github.com/rsyslog/rsyslog>`__ from GitHub.
1313

1414
``snprintf``
1515
============

‎docs/codeql/ql-training/java/apache-struts-java.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Exercise: Apache Struts
1313
Setup
1414
=====
1515

16-
For this example you need to set up `CodeQL for Visual Studio Code <https://codeql.github.com/docs/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code/>`__ and download the CodeQL database for `Apache Struts <https://github.com/apache/struts>`__ from GitHub.
16+
For this example you need to set up `CodeQL for Visual Studio Code <https://docs.github.com/en/code-security/codeql-for-vs-code/>`__ and download the CodeQL database for `Apache Struts <https://github.com/apache/struts>`__ from GitHub.
1717

1818
Unsafe deserialization in Struts
1919
================================

‎docs/codeql/ql-training/java/data-flow-java.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Finding SPARQL injection vulnerabilities in Java
99
Setup
1010
=====
1111

12-
For this example you need to set up `CodeQL for Visual Studio Code <https://codeql.github.com/docs/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code/>`__ and download the CodeQL database for `VIVO Vitro <https://github.com/vivo-project/Vitro>`__ from GitHub.
12+
For this example you need to set up `CodeQL for Visual Studio Code <https://docs.github.com/en/code-security/codeql-for-vs-code/>`__ and download the CodeQL database for `VIVO Vitro <https://github.com/vivo-project/Vitro>`__ from GitHub.
1313

1414
.. rst-class:: agenda
1515

‎docs/codeql/ql-training/java/global-data-flow-java.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ CodeQL for Java
99
Setup
1010
=====
1111

12-
For this example you need to set up `CodeQL for Visual Studio Code <https://codeql.github.com/docs/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code/>`__ and download the CodeQL database for `Apache Struts <https://github.com/apache/struts>`__ from GitHub.
12+
For this example you need to set up `CodeQL for Visual Studio Code <https://docs.github.com/en/code-security/codeql-for-vs-code/>`__ and download the CodeQL database for `Apache Struts <https://github.com/apache/struts>`__ from GitHub.
1313

1414
.. rst-class:: agenda
1515

‎docs/codeql/ql-training/java/intro-ql-java.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ CodeQL for Java
99
Setup
1010
=====
1111

12-
For this example you need to set up `CodeQL for Visual Studio Code <https://codeql.github.com/docs/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code/>`__ and download the CodeQL database for `Apache Struts <https://github.com/apache/struts>`__ from GitHub.
12+
For this example you need to set up `CodeQL for Visual Studio Code <https://docs.github.com/en/code-security/codeql-for-vs-code/>`__ and download the CodeQL database for `Apache Struts <https://github.com/apache/struts>`__ from GitHub.
1313

1414
.. Include language-agnostic section here
1515

‎docs/codeql/ql-training/java/query-injection-java.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ CodeQL for Java
99
Setup
1010
=====
1111

12-
For this example you need to set up `CodeQL for Visual Studio Code <https://codeql.github.com/docs/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code/>`__ and download the CodeQL database for `VIVO Vitro <https://github.com/vivo-project/Vitro>`__ from GitHub.
12+
For this example you need to set up `CodeQL for Visual Studio Code <https://docs.github.com/en/code-security/codeql-for-vs-code/>`__ and download the CodeQL database for `VIVO Vitro <https://github.com/vivo-project/Vitro>`__ from GitHub.
1313

1414
SQL injection
1515
=============

‎docs/codeql/ql-training/template.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Setup
3636

3737
For this example you should download:
3838

39-
- `CodeQL for Visual Studio Code <https://codeql.github.com/docs/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code/>`__
39+
- `CodeQL for Visual Studio Code <https://docs.github.com/en/code-security/codeql-for-vs-code/>`__
4040
- A CodeQL database
4141

4242
.. note::

‎docs/codeql/reusables/deprecation-note.rst

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.. pull-quote::
2+
3+
Note
4+
5+
This documentation has been migrated to docs.github.com/en/code-security/codeql-for-vs-code. This version is no longer maintained, and it will be removed on TODOCS.
6+

0 commit comments

Comments
 (0)