diff --git a/docs/codeql/codeql-cli/about-codeql-packs.rst b/docs/codeql/codeql-cli/about-codeql-packs.rst deleted file mode 100644 index 5aa0462e85d6..000000000000 --- a/docs/codeql/codeql-cli/about-codeql-packs.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. _about-codeql-packs: - -About CodeQL packs -================== - -.. pull-quote:: - This article was moved to "`About CodeQL packs `__" on the `GitHub Docs `__ site as of January 2023. - - .. include:: ../reusables/codeql-cli-articles-migration-note.rst - -.. include:: ../reusables/codeql-cli-migration-toc-note.rst - -* `CodeQL pack structure `__ - * `About published packs `__ -* `About qlpack.yml files `__ - * `qlpack.yml properties `__ -* `About codeql-pack.lock.yml files `__ -* `Examples of custom CodeQL packs `__ - * `CodeQL packs for custom libraries `__ - * `CodeQL packs for custom queries `__ - * `CodeQL packs for custom tests `__ -* `Examples of CodeQL packs in the CodeQL repository `__ - * `Core library pack `__ - * `Core query pack `__ - * `Tests for the core CodeQL pack `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/about-codeql-workspaces.rst b/docs/codeql/codeql-cli/about-codeql-workspaces.rst deleted file mode 100644 index 3faa45d7d72d..000000000000 --- a/docs/codeql/codeql-cli/about-codeql-workspaces.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _about-codeql-workspaces: - -About CodeQL workspaces -======================= - -.. pull-quote:: - This article was moved to "`About CodeQL workspaces `__" on the `GitHub Docs `__ site as of January 2023. - - .. include:: ../reusables/codeql-cli-articles-migration-note.rst - -.. include:: ../reusables/codeql-cli-migration-toc-note.rst - -* `The codeql-workspace.yml file `__ -* `Source dependencies `__ -* `CodeQL workspaces and query resolution `__ - * `Example `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/about-ql-packs.rst b/docs/codeql/codeql-cli/about-ql-packs.rst deleted file mode 100644 index f34e50c57076..000000000000 --- a/docs/codeql/codeql-cli/about-ql-packs.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _about-ql-packs: - -About QL packs -============== - -.. pull-quote:: - This page was moved to "`About CodeQL packs `__" on the `GitHub Docs `__ site as of January 2023. - - .. include:: ../reusables/codeql-cli-articles-migration-note.rst - -.. toctree:: - :hidden: - - about-ql-packs diff --git a/docs/codeql/codeql-cli/about-the-codeql-cli.rst b/docs/codeql/codeql-cli/about-the-codeql-cli.rst deleted file mode 100644 index e155d5f12e0b..000000000000 --- a/docs/codeql/codeql-cli/about-the-codeql-cli.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _about-the-codeql-cli: - -About the CodeQL CLI -==================== - -.. pull-quote:: - This article was moved to "`About the CodeQL CLI `__" on the `GitHub Docs `__ site as of January 2023. - - .. include:: ../reusables/codeql-cli-articles-migration-note.rst - -.. include:: ../reusables/codeql-cli-migration-toc-note.rst - -* `CodeQL CLI commands `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst b/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst deleted file mode 100644 index 0739abccdeae..000000000000 --- a/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. _analyzing-databases-with-the-codeql-cli: - -Analyzing databases with the CodeQL CLI -======================================= - -.. pull-quote:: - This article was moved to "`Analyzing databases with the CodeQL CLI `__" on the `GitHub Docs `__ site as of January 2023. - - .. include:: ../reusables/codeql-cli-articles-migration-note.rst - -.. include:: ../reusables/codeql-cli-migration-toc-note.rst - -* `Running codeql database analyze `__ -* `Specifying which queries to run in a CodeQL pack `__ - * `Example query specifiers `__ -* `Examples of running database analyses `__ - * `Running a CodeQL query pack `__ - * `Running a single query `__ - * `Running all queries in a directory `__ - * `Running a subset of queries in a CodeQL pack `__ - * `Running query suites `__ - * `Diagnostic and summary information `__ - * `Integrating a CodeQL pack into a code scanning workflow in GitHub `__ - * `Including query help for custom CodeQL queries in SARIF files `__ -* `Results `__ diff --git a/docs/codeql/codeql-cli/codeql-cli-reference.rst b/docs/codeql/codeql-cli/codeql-cli-reference.rst deleted file mode 100644 index 2a58aece28b3..000000000000 --- a/docs/codeql/codeql-cli/codeql-cli-reference.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. _codeql-cli-reference: - -:orphan: - -CodeQL CLI reference -==================== - -.. pull-quote:: - This category was moved to "`CodeQL CLI reference `__" on the `GitHub Docs `__ site as of January 2023. - - .. include:: ../reusables/codeql-cli-articles-migration-note.rst - -.. toctree:: - :titlesonly: - :hidden: - - about-codeql-packs - about-codeql-workspaces - query-reference-files - sarif-output - exit-codes - extractor-options \ No newline at end of file diff --git a/docs/codeql/codeql-cli/creating-and-working-with-codeql-packs.rst b/docs/codeql/codeql-cli/creating-and-working-with-codeql-packs.rst deleted file mode 100644 index 5354a9eabd10..000000000000 --- a/docs/codeql/codeql-cli/creating-and-working-with-codeql-packs.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. _creating-and-working-with-codeql-packs: - -Creating and working with CodeQL packs -====================================== - -.. pull-quote:: - This article was moved to "`Creating and working with CodeQL packs `__" on the `GitHub Docs `__ site as of January 2023. - - .. include:: ../reusables/codeql-cli-articles-migration-note.rst - -.. include:: ../reusables/codeql-cli-migration-toc-note.rst - -* `About CodeQL packs and the CodeQL CLI `__ -* `Creating a CodeQL pack `__ -* `Modifying an existing legacy QL pack to create a CodeQL pack `__ -* `Adding and installing dependencies to a CodeQL pack `__ -* `Customizing a downloaded CodeQL pack `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/creating-codeql-databases.rst b/docs/codeql/codeql-cli/creating-codeql-databases.rst deleted file mode 100644 index be57b0827589..000000000000 --- a/docs/codeql/codeql-cli/creating-codeql-databases.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. _creating-codeql-databases: - -Creating CodeQL databases -========================= - -.. pull-quote:: - This article was moved to "`Creating CodeQL databases `__" on the `GitHub Docs `__ site as of January 2023. - - .. include:: ../reusables/codeql-cli-articles-migration-note.rst - -.. include:: ../reusables/codeql-cli-migration-toc-note.rst - -* `Running codeql database create `__ -* `Progress and results `__ -* `Creating databases for non-compiled languages `__ - * `JavaScript and TypeScript `__ - * `Python `__ - * `Ruby `__ -* `Creating databases for compiled languages `__ - * `Detecting the build system `__ - * `Specifying build commands `__ - * `Using indirect build tracing `__ - * `Example of creating a CodeQL database using indirect build tracing `__ -* `Downloading databases from GitHub.com `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/creating-codeql-query-suites.rst b/docs/codeql/codeql-cli/creating-codeql-query-suites.rst deleted file mode 100644 index fc1980970bb3..000000000000 --- a/docs/codeql/codeql-cli/creating-codeql-query-suites.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. _creating-codeql-query-suites: - -Creating CodeQL query suites -============================ - -.. pull-quote:: - This article was moved to "`Creating CodeQL query suites `__" on the `GitHub Docs `__ site as of January 2023. - - .. include:: ../reusables/codeql-cli-articles-migration-note.rst - -.. include:: ../reusables/codeql-cli-migration-toc-note.rst - -* `Locating queries to add to a query suite `__ -* `Filtering the queries in a query suite `__ - * `Examples of filtering which queries are run `__ -* `Reusing existing query suite definitions `__ - * `Reusability Examples `__ -* `Naming a query suite `__ -* `Saving a query suite `__ -* `Specifying well-known query suites `__ -* `Using query suites with CodeQL `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/exit-codes.rst b/docs/codeql/codeql-cli/exit-codes.rst deleted file mode 100644 index 2bb115e6d812..000000000000 --- a/docs/codeql/codeql-cli/exit-codes.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. _exit-codes: - -Exit codes -========== - -.. pull-quote:: - This article was moved to "`Exit codes `__" on the `GitHub Docs `__ site as of January 2023. - - .. include:: ../reusables/codeql-cli-articles-migration-note.rst diff --git a/docs/codeql/codeql-cli/extractor-options.rst b/docs/codeql/codeql-cli/extractor-options.rst deleted file mode 100644 index 76728426ffdb..000000000000 --- a/docs/codeql/codeql-cli/extractor-options.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. extractor-options: - -Extractor options -================= - -.. pull-quote:: - This article was moved to "`Extractor options `__" on the `GitHub Docs `__ site as of January 2023. - - .. include:: ../reusables/codeql-cli-articles-migration-note.rst - -.. include:: ../reusables/codeql-cli-migration-toc-note.rst - -* `About extractor options `__ -* `Setting extractor options with the CodeQL CLI `__ -* `Setting extractor options from files `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst b/docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst deleted file mode 100644 index 1d2a37957e52..000000000000 --- a/docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. _getting-started-with-the-codeql-cli: - -Getting started with the CodeQL CLI -=================================== - -.. pull-quote:: - This article was moved to "`Getting started with the CodeQL CLI `__" on the `GitHub Docs `__ site as of January 2023. - - .. include:: ../reusables/codeql-cli-articles-migration-note.rst - -.. include:: ../reusables/codeql-cli-migration-toc-note.rst - -* `Setting up the CodeQL CLI `__ - * `1. Download the CodeQL CLI zip package `__ - * `2. Extract the zip archive `__ - * `3. Launch codeql `__ - * `4. Verify your CodeQL CLI setup `__ -* `Checking out the CodeQL source code directly `__ - * `1. Download the CodeQL CLI zip `__ - * `2. Create a new CodeQL directory `__ - * `3. Obtain a local copy of the CodeQL queries `__ - * `4. Extract the zip archive `__ - * `5. Launch codeql `__ - * `6. Verify your CodeQL CLI setup `__ -* `Using two versions of the CodeQL CLI `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/index.rst b/docs/codeql/codeql-cli/index.rst deleted file mode 100644 index b5a13f3425ca..000000000000 --- a/docs/codeql/codeql-cli/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. _codeql-cli: - -CodeQL CLI -========== - -.. include:: ../reusables/codeql-cli-overview.rst - -- `Using the CodeQL CLI `__: Software - developers and security researchers can secure their code using the CodeQL CLI. - -- `CodeQL CLI reference `__: Learn more about the files you can use when running CodeQL processes and the results format and exit codes that CodeQL generates. - -- `CodeQL CLI manual `__: Detailed information about all the commands available with the CodeQL CLI. - -.. toctree:: - :titlesonly: - :hidden: - diff --git a/docs/codeql/codeql-cli/publishing-and-using-codeql-packs.rst b/docs/codeql/codeql-cli/publishing-and-using-codeql-packs.rst deleted file mode 100644 index 9eefe82cf6f1..000000000000 --- a/docs/codeql/codeql-cli/publishing-and-using-codeql-packs.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. _publishing-and-using-codeql-packs: - -Publishing and using CodeQL packs -================================= - -.. pull-quote:: - This article was moved to "`Publishing and using CodeQL packs `__" on the `GitHub Docs `__ site as of January 2023. - - .. include:: ../reusables/codeql-cli-articles-migration-note.rst - -.. include:: ../reusables/codeql-cli-migration-toc-note.rst - -* `Configuring the qlpack.yml file before publishing `__ -* `Running codeql pack publish `__ -* `Running codeql pack download / `__ -* `Using a CodeQL pack to analyze a CodeQL database `__ -* `About CodeQL pack compatibility `__ -* `Working with CodeQL packs on GitHub Enterprise Server `__ -* `Authenticating to GitHub Container registries `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/query-reference-files.rst b/docs/codeql/codeql-cli/query-reference-files.rst deleted file mode 100644 index 1958f0c34ea1..000000000000 --- a/docs/codeql/codeql-cli/query-reference-files.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _query-reference-files: - -Query reference files -===================== - -.. pull-quote:: - This article was moved to "`Query reference files `__" on the `GitHub Docs `__ site as of January 2023. - - .. include:: ../reusables/codeql-cli-articles-migration-note.rst - -.. include:: ../reusables/codeql-cli-migration-toc-note.rst - -* `Defining a query reference file `__ - * `Example `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/sarif-output.rst b/docs/codeql/codeql-cli/sarif-output.rst deleted file mode 100644 index 7a134f32ace9..000000000000 --- a/docs/codeql/codeql-cli/sarif-output.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. _sarif-output: - -SARIF output -============ - -.. pull-quote:: - This article was moved to "`CodeQL CLI SARIF output `__" on the `GitHub Docs `__ site as of January 2023. - - .. include:: ../reusables/codeql-cli-articles-migration-note.rst - -.. include:: ../reusables/codeql-cli-migration-toc-note.rst - -* `SARIF specification and schema `__ -* `Change notes `__ - * `Changes between versions `__ - * `Future changes to the output `__ -* `Generated SARIF objects `__ - * `sarifLog object `__ - * `run object `__ - * `tool object `__ - * `toolComponent object `__ - * `reportingDescriptor object for rule `__ - * `artifact object `__ - * `artifactLocation object `__ - * `result object `__ - * `location object `__ - * `physicalLocation object `__ - * `region object `__ - * `codeFlow object `__ - * `threadFlow object `__ - * `threadFlowLocation object `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/specifying-command-options-in-a-codeql-configuration-file.rst b/docs/codeql/codeql-cli/specifying-command-options-in-a-codeql-configuration-file.rst deleted file mode 100644 index 5b88acb86a82..000000000000 --- a/docs/codeql/codeql-cli/specifying-command-options-in-a-codeql-configuration-file.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _specifying-command-options-in-a-codeql-configuration-file: - -Specifying command options in a CodeQL configuration file -========================================================= - -.. pull-quote:: - This article was moved to "`Specifying command options in a CodeQL configuration file `__" on the `GitHub Docs `__ site as of January 2023. - - .. include:: ../reusables/codeql-cli-articles-migration-note.rst - - .. include:: ../reusables/codeql-cli-migration-toc-note.rst - -* `Using a CodeQL configuration file `__ - * `Examples `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/testing-custom-queries.rst b/docs/codeql/codeql-cli/testing-custom-queries.rst deleted file mode 100644 index 65560597d784..000000000000 --- a/docs/codeql/codeql-cli/testing-custom-queries.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. _testing-custom-queries: - -Testing custom queries -====================== - -.. pull-quote:: - This article was moved to "`Testing custom queries `__" on the `GitHub Docs `__ site as of January 2023. - - .. include:: ../reusables/codeql-cli-articles-migration-note.rst - -.. include:: ../reusables/codeql-cli-migration-toc-note.rst - -* `Setting up a test CodeQL pack for custom queries `__ -* `Setting up the test files for a query `__ -* `Running codeql test run `__ -* `Example `__ - * `Prepare a query and test files `__ - * `Execute the test `__ - * `View the query test output `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/testing-query-help-files.rst b/docs/codeql/codeql-cli/testing-query-help-files.rst deleted file mode 100644 index 01f5521f8066..000000000000 --- a/docs/codeql/codeql-cli/testing-query-help-files.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _testing-query-help-files: - -Testing query help files -======================== - -.. pull-quote:: - This article was moved to "`Testing query help files `__" on the `GitHub Docs `__ site as of January 2023. - - .. include:: ../reusables/codeql-cli-articles-migration-note.rst - -.. include:: ../reusables/codeql-cli-migration-toc-note.rst - -* `Prerequisites `__ -* `Running codeql generate query-help `__ -* `Results `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst b/docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst deleted file mode 100644 index 393a94f7ec92..000000000000 --- a/docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _using-custom-queries-with-the-codeql-cli: - -Using custom queries with the CodeQL CLI -========================================= - -.. pull-quote:: - This article was moved to "`Using custom queries with the CodeQL CLI `__" on the `GitHub Docs `__ site as of January 2023. - - .. include:: ../reusables/codeql-cli-articles-migration-note.rst - -.. include:: ../reusables/codeql-cli-migration-toc-note.rst - -* `Writing a valid query `__ -* `Including query metadata `__ -* `Packaging custom QL queries `__ -* `Contributing to the CodeQL repository `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/using-the-codeql-cli.rst b/docs/codeql/codeql-cli/using-the-codeql-cli.rst deleted file mode 100644 index 2d60e8c2d12e..000000000000 --- a/docs/codeql/codeql-cli/using-the-codeql-cli.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. _using-the-codeql-cli: - -:orphan: - -Using the CodeQL CLI -==================== - -.. pull-quote:: - This category was moved to "`Using the CodeQL CLI `__" on the `GitHub Docs `__ site as of January 2023. - - .. include:: ../reusables/codeql-cli-articles-migration-note.rst - -.. toctree:: - :titlesonly: - :hidden: - - about-the-codeql-cli - getting-started-with-the-codeql-cli - creating-codeql-databases - extractor-options - analyzing-databases-with-the-codeql-cli - using-custom-queries-with-the-codeql-cli - creating-codeql-query-suites - testing-custom-queries - testing-query-help-files - creating-and-working-with-codeql-packs - publishing-and-using-codeql-packs - Specifying command options diff --git a/docs/codeql/contents.rst b/docs/codeql/contents.rst index 1a772c7263c4..8ecc0ca73043 100644 --- a/docs/codeql/contents.rst +++ b/docs/codeql/contents.rst @@ -4,11 +4,9 @@ CodeQL documentation .. toctree:: :includehidden: :maxdepth: 3 - + codeql-overview/index codeql-for-visual-studio-code/index - codeql-cli/index writing-codeql-queries/index codeql-language-guides/index ql-language-reference/index - diff --git a/docs/codeql/index.html b/docs/codeql/index.html index f369c3c7cb84..0d3ff357b4b5 100644 --- a/docs/codeql/index.html +++ b/docs/codeql/index.html @@ -39,7 +39,7 @@ CodeQL tools
  • CodeQL for VS Code -
  • CodeQL CLI +
  • CodeQL CLI
  • - +
    CodeQL CLI
    The CodeQL command-line interface (CLI) is used @@ -138,7 +138,7 @@

    + href="https://docs.github.com/en/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning">
    Code scanning with CodeQL
    Use code scanning with CodeQL to analyze the code in a GitHub @@ -356,7 +356,7 @@

    Company

      -
    • © +
    • © GitHub, Inc.
    • Company
    - \ No newline at end of file +