Skip to content

Commit aab5da0

Browse files
authored
Merge pull request github#16320 from github/subatoi/deprecate-codeql-for-vs-code
[8th May 2024] Add deprecation notices to CodeQL for VS Code documentation
2 parents 279b2c7 + c529988 commit aab5da0

Some content is hidden

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

45 files changed

+69
-34
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
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

Lines changed: 1 addition & 1 deletion
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 about the [CodeQL language](https://codeql.github.com/docs/), writing CodeQL using the [CodeQL extension for Visual Studio Code](https://docs.github.com/en/code-security/codeql-for-vs-code/) and using the [CodeQL CLI](https://docs.github.com/en/code-security/codeql-cli).
88

99
## Contributing
1010

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
About CodeQL for Visual Studio Code
66
=================================================
77

8+
.. include:: ../reusables/vs-code-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

Lines changed: 2 additions & 0 deletions
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/vs-code-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

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

8+
.. include:: ../reusables/vs-code-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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
Customizing settings
66
====================
77

8+
.. include:: ../reusables/vs-code-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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
Exploring data flow with path queries
66
=====================================
77

8+
.. include:: ../reusables/vs-code-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

Lines changed: 2 additions & 0 deletions
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/vs-code-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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
CodeQL for Visual Studio Code
44
=============================
55

6+
.. include:: ../reusables/vs-code-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

Lines changed: 2 additions & 0 deletions
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/vs-code-deprecation-note.rst
9+
810
.. include:: ../reusables/beta-note-mrva.rst
911

1012
About multi-repository variant analysis

0 commit comments

Comments
 (0)