From 707751b8f408acfbce9af5f0194c838e6f18b905 Mon Sep 17 00:00:00 2001 From: Sophie <29382425+sophietheking@users.noreply.github.com> Date: Tue, 13 Jan 2026 13:49:56 +0100 Subject: [PATCH 1/7] [EDI] Create a new "Scan code for vulnerabilities" map topic within "How-tos" (#59097) --- .../index.md | 4 --- .../enabling-code-scanning/index.md | 17 --------- content/code-security/code-scanning/index.md | 3 -- .../integrating-with-code-scanning/index.md | 2 -- .../index.md | 4 --- .../troubleshooting-sarif-uploads/index.md | 21 ----------- .../index.md | 1 - .../index.md | 5 --- .../index.md | 6 ---- .../index.md | 11 ++---- content/code-security/how-tos/index.md | 1 + ...guring-advanced-setup-for-code-scanning.md | 7 ++-- ...iguring-default-setup-for-code-scanning.md | 5 +-- ...g-your-advanced-setup-for-code-scanning.md | 11 +++--- .../configure-code-scanning/index.md | 20 +++++++++++ .../scan-code-for-vulnerabilities/index.md | 16 +++++++++ .../integrate-with-existing-tools/index.md | 21 +++++++++++ .../uploading-a-sarif-file-to-github.md | 3 +- ...e-scanning-with-your-existing-ci-system.md | 5 ++- .../about-the-tool-status-page.md | 3 +- ...ql-code-scanning-for-compiled-languages.md | 5 +-- ...guring-larger-runners-for-default-setup.md | 5 ++- ...ing-your-configuration-of-default-setup.md | 6 ++-- .../manage-your-configuration/index.md | 25 +++++++++++++ .../set-code-scanning-merge-protection.md | 6 ++-- .../advanced-setup-of-the-codeql-cli.md | 5 ++- ...ing-database-bundle-for-troubleshooting.md | 6 +++- .../scan-from-the-command-line/index.md | 20 +++++++++++ .../setting-up-the-codeql-cli.md | 6 ++-- ...-options-in-a-codeql-configuration-file.md | 5 ++- .../testing-query-help-files.md | 5 ++- ...sing-custom-queries-with-the-codeql-cli.md | 5 ++- .../configuring-access-to-the-codeql-cli.md | 6 ++-- .../creating-a-custom-query.md | 6 ++-- .../customizing-settings.md | 5 +-- .../exploring-data-flow-with-path-queries.md | 5 +-- ...oring-the-structure-of-your-source-code.md | 5 +-- .../scan-from-vs-code/index.md | 27 ++++++++++++++ .../installing-codeql-for-vs-code.md | 6 ++-- .../managing-codeql-databases.md | 6 ++-- .../managing-codeql-packs.md | 5 +-- ...-with-multi-repository-variant-analysis.md | 13 +++---- .../running-codeql-queries.md | 5 +-- .../setting-up-a-codeql-workspace.md | 6 ++-- .../testing-codeql-queries-in-vs-code.md | 5 +-- .../using-the-codeql-model-editor.md | 7 ++-- .../troubleshooting/index.md | 21 +++++++++++ .../advanced-security-must-be-enabled.md | 6 ++-- .../alerts-in-generated-code.md | 4 ++- .../analysis-takes-too-long.md | 4 ++- .../automatic-build-failed.md | 4 ++- .../c-sharp-compiler-unexpectedly-failing.md | 9 +++-- ...t-enable-codeql-in-a-private-repository.md | 6 ++-- .../enabling-default-setup-takes-too-long.md | 7 ++-- .../extraction-errors-in-the-database.md | 7 ++-- .../fewer-lines-scanned-than-expected.md | 4 ++- .../troubleshooting-analysis-errors}/index.md | 36 ++++++++++--------- .../kotlin-detected-in-no-build.md | 3 ++ .../logs-not-detailed-enough.md | 4 ++- .../no-source-code-seen-during-build.md | 7 ++-- .../not-recognized.md | 3 ++ .../out-of-disk-or-memory.md | 7 ++-- .../resource-not-accessible.md | 4 ++- .../results-different-than-expected.md | 4 ++- .../server-error.md | 7 ++-- .../some-languages-not-analyzed.md | 4 ++- .../two-codeql-workflows.md | 7 ++-- .../unclear-what-triggered-a-workflow.md | 4 ++- .../unnecessary-step-found.md | 7 ++-- .../default-setup-enabled.md | 7 ++-- .../file-too-large.md | 7 ++-- .../ghas-required.md | 7 ++-- .../troubleshooting-sarif-uploads/index.md | 22 ++++++++++++ .../missing-token.md | 7 ++-- .../results-exceed-limit.md | 7 ++-- .../sarif-invalid.md | 5 +-- content/code-security/index.md | 4 +-- data/learning-tracks/code-security.yml | 12 +++---- .../lib/static/redirect-exceptions.txt | 3 -- 79 files changed, 417 insertions(+), 205 deletions(-) delete mode 100644 content/code-security/code-scanning/enabling-code-scanning/index.md delete mode 100644 content/code-security/code-scanning/troubleshooting-sarif-uploads/index.md rename content/code-security/{code-scanning/creating-an-advanced-setup-for-code-scanning => how-tos/scan-code-for-vulnerabilities/configure-code-scanning}/configuring-advanced-setup-for-code-scanning.md (96%) rename content/code-security/{code-scanning/enabling-code-scanning => how-tos/scan-code-for-vulnerabilities/configure-code-scanning}/configuring-default-setup-for-code-scanning.md (97%) rename content/code-security/{code-scanning/creating-an-advanced-setup-for-code-scanning => how-tos/scan-code-for-vulnerabilities/configure-code-scanning}/customizing-your-advanced-setup-for-code-scanning.md (99%) create mode 100644 content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/index.md create mode 100644 content/code-security/how-tos/scan-code-for-vulnerabilities/index.md create mode 100644 content/code-security/how-tos/scan-code-for-vulnerabilities/integrate-with-existing-tools/index.md rename content/code-security/{code-scanning/integrating-with-code-scanning => how-tos/scan-code-for-vulnerabilities/integrate-with-existing-tools}/uploading-a-sarif-file-to-github.md (98%) rename content/code-security/{code-scanning/integrating-with-code-scanning => how-tos/scan-code-for-vulnerabilities/integrate-with-existing-tools}/using-code-scanning-with-your-existing-ci-system.md (92%) rename content/code-security/{code-scanning/managing-your-code-scanning-configuration => how-tos/scan-code-for-vulnerabilities/manage-your-configuration}/about-the-tool-status-page.md (98%) rename content/code-security/{code-scanning/creating-an-advanced-setup-for-code-scanning => how-tos/scan-code-for-vulnerabilities/manage-your-configuration}/codeql-code-scanning-for-compiled-languages.md (99%) rename content/code-security/{code-scanning/managing-your-code-scanning-configuration => how-tos/scan-code-for-vulnerabilities/manage-your-configuration}/configuring-larger-runners-for-default-setup.md (94%) rename content/code-security/{code-scanning/managing-your-code-scanning-configuration => how-tos/scan-code-for-vulnerabilities/manage-your-configuration}/editing-your-configuration-of-default-setup.md (96%) create mode 100644 content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/index.md rename content/code-security/{code-scanning/managing-your-code-scanning-configuration => how-tos/scan-code-for-vulnerabilities/manage-your-configuration}/set-code-scanning-merge-protection.md (93%) rename content/code-security/{codeql-cli/using-the-advanced-functionality-of-the-codeql-cli => how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line}/advanced-setup-of-the-codeql-cli.md (94%) rename content/code-security/{codeql-cli/using-the-advanced-functionality-of-the-codeql-cli => how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line}/creating-database-bundle-for-troubleshooting.md (87%) create mode 100644 content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/index.md rename content/code-security/{codeql-cli/getting-started-with-the-codeql-cli => how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line}/setting-up-the-codeql-cli.md (95%) rename content/code-security/{codeql-cli/using-the-advanced-functionality-of-the-codeql-cli => how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line}/specifying-command-options-in-a-codeql-configuration-file.md (90%) rename content/code-security/{codeql-cli/using-the-advanced-functionality-of-the-codeql-cli => how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line}/testing-query-help-files.md (93%) rename content/code-security/{codeql-cli/using-the-advanced-functionality-of-the-codeql-cli => how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line}/using-custom-queries-with-the-codeql-cli.md (95%) rename content/code-security/{codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension => how-tos/scan-code-for-vulnerabilities/scan-from-vs-code}/configuring-access-to-the-codeql-cli.md (88%) rename content/code-security/{codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension => how-tos/scan-code-for-vulnerabilities/scan-from-vs-code}/creating-a-custom-query.md (90%) rename content/code-security/{codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension => how-tos/scan-code-for-vulnerabilities/scan-from-vs-code}/customizing-settings.md (96%) rename content/code-security/{codeql-for-vs-code/getting-started-with-codeql-for-vs-code => how-tos/scan-code-for-vulnerabilities/scan-from-vs-code}/exploring-data-flow-with-path-queries.md (88%) rename content/code-security/{codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension => how-tos/scan-code-for-vulnerabilities/scan-from-vs-code}/exploring-the-structure-of-your-source-code.md (89%) create mode 100644 content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/index.md rename content/code-security/{codeql-for-vs-code/getting-started-with-codeql-for-vs-code => how-tos/scan-code-for-vulnerabilities/scan-from-vs-code}/installing-codeql-for-vs-code.md (91%) rename content/code-security/{codeql-for-vs-code/getting-started-with-codeql-for-vs-code => how-tos/scan-code-for-vulnerabilities/scan-from-vs-code}/managing-codeql-databases.md (93%) rename content/code-security/{codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension => how-tos/scan-code-for-vulnerabilities/scan-from-vs-code}/managing-codeql-packs.md (91%) rename content/code-security/{codeql-for-vs-code/getting-started-with-codeql-for-vs-code => how-tos/scan-code-for-vulnerabilities/scan-from-vs-code}/running-codeql-queries-at-scale-with-multi-repository-variant-analysis.md (95%) rename content/code-security/{codeql-for-vs-code/getting-started-with-codeql-for-vs-code => how-tos/scan-code-for-vulnerabilities/scan-from-vs-code}/running-codeql-queries.md (97%) rename content/code-security/{codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension => how-tos/scan-code-for-vulnerabilities/scan-from-vs-code}/setting-up-a-codeql-workspace.md (93%) rename content/code-security/{codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension => how-tos/scan-code-for-vulnerabilities/scan-from-vs-code}/testing-codeql-queries-in-vs-code.md (93%) rename content/code-security/{codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension => how-tos/scan-code-for-vulnerabilities/scan-from-vs-code}/using-the-codeql-model-editor.md (97%) create mode 100644 content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/index.md rename content/code-security/{code-scanning/troubleshooting-code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors}/advanced-security-must-be-enabled.md (94%) rename content/code-security/{code-scanning/troubleshooting-code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors}/alerts-in-generated-code.md (60%) rename content/code-security/{code-scanning/troubleshooting-code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors}/analysis-takes-too-long.md (96%) rename content/code-security/{code-scanning/troubleshooting-code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors}/automatic-build-failed.md (79%) rename content/code-security/{code-scanning/troubleshooting-code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors}/c-sharp-compiler-unexpectedly-failing.md (84%) rename content/code-security/{code-scanning/troubleshooting-code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors}/cannot-enable-codeql-in-a-private-repository.md (94%) rename content/code-security/{code-scanning/troubleshooting-code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors}/enabling-default-setup-takes-too-long.md (82%) rename content/code-security/{code-scanning/troubleshooting-code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors}/extraction-errors-in-the-database.md (77%) rename content/code-security/{code-scanning/troubleshooting-code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors}/fewer-lines-scanned-than-expected.md (93%) rename content/code-security/{code-scanning/troubleshooting-code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors}/index.md (77%) rename content/code-security/{code-scanning/troubleshooting-code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors}/kotlin-detected-in-no-build.md (97%) rename content/code-security/{code-scanning/troubleshooting-code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors}/logs-not-detailed-enough.md (94%) rename content/code-security/{code-scanning/troubleshooting-code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors}/no-source-code-seen-during-build.md (93%) rename content/code-security/{code-scanning/troubleshooting-code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors}/not-recognized.md (89%) rename content/code-security/{code-scanning/troubleshooting-code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors}/out-of-disk-or-memory.md (85%) rename content/code-security/{code-scanning/troubleshooting-code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors}/resource-not-accessible.md (93%) rename content/code-security/{code-scanning/troubleshooting-code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors}/results-different-than-expected.md (88%) rename content/code-security/{code-scanning/troubleshooting-code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors}/server-error.md (66%) rename content/code-security/{code-scanning/troubleshooting-code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors}/some-languages-not-analyzed.md (86%) rename content/code-security/{code-scanning/troubleshooting-code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors}/two-codeql-workflows.md (75%) rename content/code-security/{code-scanning/troubleshooting-code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors}/unclear-what-triggered-a-workflow.md (82%) rename content/code-security/{code-scanning/troubleshooting-code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors}/unnecessary-step-found.md (89%) rename content/code-security/{code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting}/troubleshooting-sarif-uploads/default-setup-enabled.md (82%) rename content/code-security/{code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting}/troubleshooting-sarif-uploads/file-too-large.md (96%) rename content/code-security/{code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting}/troubleshooting-sarif-uploads/ghas-required.md (77%) create mode 100644 content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/index.md rename content/code-security/{code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting}/troubleshooting-sarif-uploads/missing-token.md (86%) rename content/code-security/{code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting}/troubleshooting-sarif-uploads/results-exceed-limit.md (96%) rename content/code-security/{code-scanning => how-tos/scan-code-for-vulnerabilities/troubleshooting}/troubleshooting-sarif-uploads/sarif-invalid.md (92%) diff --git a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/index.md b/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/index.md index 13bc52dd2200..e49f07ca4534 100644 --- a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/index.md +++ b/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/index.md @@ -11,10 +11,6 @@ topics: - Code Security - Code scanning children: - - /configuring-advanced-setup-for-code-scanning - - /customizing-your-advanced-setup-for-code-scanning - - /codeql-code-scanning-for-compiled-languages - /recommended-hardware-resources-for-running-codeql - /running-codeql-code-scanning-in-a-container --- - diff --git a/content/code-security/code-scanning/enabling-code-scanning/index.md b/content/code-security/code-scanning/enabling-code-scanning/index.md deleted file mode 100644 index b3ce27d7ba78..000000000000 --- a/content/code-security/code-scanning/enabling-code-scanning/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Enabling code scanning -shortTitle: Enable code scanning -intro: You can quickly and easily secure your code with default setup for {% data variables.product.prodname_code_scanning %}. -product: '{% data reusables.gated-features.code-scanning %}' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Code Security - - Code scanning - - CodeQL -children: - - /configuring-default-setup-for-code-scanning ---- - diff --git a/content/code-security/code-scanning/index.md b/content/code-security/code-scanning/index.md index da6ebff993a2..ea780fa4904f 100644 --- a/content/code-security/code-scanning/index.md +++ b/content/code-security/code-scanning/index.md @@ -17,12 +17,9 @@ topics: - Code scanning - CodeQL children: - - /enabling-code-scanning - /creating-an-advanced-setup-for-code-scanning - /managing-code-scanning-alerts - /managing-your-code-scanning-configuration - /integrating-with-code-scanning - - /troubleshooting-code-scanning - - /troubleshooting-sarif-uploads - /reference --- diff --git a/content/code-security/code-scanning/integrating-with-code-scanning/index.md b/content/code-security/code-scanning/integrating-with-code-scanning/index.md index ecb777d9bebf..cc6159405c20 100644 --- a/content/code-security/code-scanning/integrating-with-code-scanning/index.md +++ b/content/code-security/code-scanning/integrating-with-code-scanning/index.md @@ -16,8 +16,6 @@ topics: - Code scanning - Integration children: - - /using-code-scanning-with-your-existing-ci-system - - /uploading-a-sarif-file-to-github - /sarif-support-for-code-scanning --- diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/index.md b/content/code-security/code-scanning/managing-your-code-scanning-configuration/index.md index a949ccda25ad..3301b3d6baae 100644 --- a/content/code-security/code-scanning/managing-your-code-scanning-configuration/index.md +++ b/content/code-security/code-scanning/managing-your-code-scanning-configuration/index.md @@ -12,11 +12,7 @@ topics: - Code scanning - CodeQL children: - - /about-the-tool-status-page - - /editing-your-configuration-of-default-setup - - /set-code-scanning-merge-protection - /enabling-delegated-alert-dismissal-for-code-scanning - - /configuring-larger-runners-for-default-setup - /viewing-code-scanning-logs --- diff --git a/content/code-security/code-scanning/troubleshooting-sarif-uploads/index.md b/content/code-security/code-scanning/troubleshooting-sarif-uploads/index.md deleted file mode 100644 index 1c0149b8e2a6..000000000000 --- a/content/code-security/code-scanning/troubleshooting-sarif-uploads/index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Troubleshooting SARIF uploads -intro: 'Learn how to resolve problems uploading SARIF files of {% data variables.product.prodname_code_scanning %} results to {% data variables.product.prodname_dotcom %}.' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Code Security - - Code scanning - - Integration -children: - - /ghas-required - - /default-setup-enabled - - /missing-token - - /sarif-invalid - - /file-too-large - - /results-exceed-limit -redirect_from: - - /code-security/code-scanning/troubleshooting-sarif ---- diff --git a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/index.md b/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/index.md index bd6aa7781210..5508b657c897 100644 --- a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/index.md +++ b/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/index.md @@ -12,7 +12,6 @@ topics: - Code scanning - CodeQL children: - - /setting-up-the-codeql-cli - /preparing-your-code-for-codeql-analysis - /analyzing-your-code-with-codeql-queries - /uploading-codeql-analysis-results-to-github diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/index.md b/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/index.md index c5ef5a83802e..06b78fed5999 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/index.md +++ b/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/index.md @@ -12,19 +12,14 @@ topics: - Code scanning - CodeQL children: - - /advanced-setup-of-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-in-a-codeql-configuration-file - /sarif-output - /csv-output - /extractor-options - /exit-codes - - /creating-database-bundle-for-troubleshooting redirect_from: - /code-security/codeql-cli/codeql-cli-reference --- diff --git a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/index.md b/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/index.md index d0a5aa7a3337..b0646f349c81 100644 --- a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/index.md +++ b/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/index.md @@ -11,12 +11,6 @@ topics: - Code Security - Code scanning - CodeQL -children: - - /installing-codeql-for-vs-code - - /managing-codeql-databases - - /running-codeql-queries - - /exploring-data-flow-with-path-queries - - /running-codeql-queries-at-scale-with-multi-repository-variant-analysis redirect_from: - /code-security/codeql-for-vs-code/setting-up-codeql-in-visual-studio-code --- diff --git a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/index.md b/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/index.md index 83b89930ee8c..8b875694ab5e 100644 --- a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/index.md +++ b/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/index.md @@ -1,7 +1,7 @@ --- title: Using the advanced functionality of the {% data variables.product.prodname_codeql %} for VS Code extension shortTitle: Advanced functionality -intro: 'The {% data variables.product.prodname_codeql %} extension for {% data variables.product.prodname_vscode %} adds rich language support for {% data variables.product.prodname_codeql %} and supports writing queries to find problems in codebases.' +intro: The {% data variables.product.prodname_codeql %} extension for {% data variables.product.prodname_vscode %} adds rich language support for {% data variables.product.prodname_codeql %} and supports writing queries to find problems in codebases. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -12,13 +12,6 @@ topics: - Code scanning - CodeQL children: - - /using-the-codeql-model-editor - - /creating-a-custom-query - - /managing-codeql-packs - - /exploring-the-structure-of-your-source-code - - /testing-codeql-queries-in-vs-code - - /customizing-settings - - /setting-up-a-codeql-workspace - - /configuring-access-to-the-codeql-cli - /telemetry-in-codeql-for-visual-studio-code --- + diff --git a/content/code-security/how-tos/index.md b/content/code-security/how-tos/index.md index fff26b2b9e65..c381c53e21b8 100644 --- a/content/code-security/how-tos/index.md +++ b/content/code-security/how-tos/index.md @@ -18,6 +18,7 @@ contentType: how-tos children: - /secure-at-scale - /secure-your-supply-chain + - /scan-code-for-vulnerabilities - /maintain-quality-code - /report-and-fix-vulnerabilities --- diff --git a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/configuring-advanced-setup-for-code-scanning.md similarity index 96% rename from content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/configuring-advanced-setup-for-code-scanning.md index 20c7e22d955c..8358a3a84de3 100644 --- a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/configuring-advanced-setup-for-code-scanning.md @@ -1,22 +1,23 @@ --- title: Configuring advanced setup for code scanning shortTitle: Configure advanced setup -intro: 'You can configure advanced setup for a repository to find security vulnerabilities in your code using a highly customizable {% data variables.product.prodname_code_scanning %} configuration.' +intro: You can configure advanced setup for a repository to find security vulnerabilities in your code using a highly customizable {% data variables.product.prodname_code_scanning %} configuration. permissions: '{% data reusables.permissions.security-repo-enable %}' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-advanced-setup-for-code-scanning + - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-advanced-setup-for-code-scanning + - /code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to topics: - Code Security - Code scanning - Actions - Repositories allowTitleToDifferFromFilename: true +contentType: how-tos --- {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %} diff --git a/content/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/configuring-default-setup-for-code-scanning.md similarity index 97% rename from content/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/configuring-default-setup-for-code-scanning.md index 505f1bdd94ef..abda1f3f0dfd 100644 --- a/content/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/configuring-default-setup-for-code-scanning.md @@ -1,7 +1,7 @@ --- title: Configuring default setup for code scanning shortTitle: Configure code scanning -intro: 'Quickly set up {% data variables.product.prodname_code_scanning %} to find {% ifversion fpt or ghec %}and fix {% endif %}vulnerable code automatically.' +intro: Quickly set up {% data variables.product.prodname_code_scanning %} to find {% ifversion fpt or ghec %}and fix {% endif %}vulnerable code automatically. redirect_from: - /github/managing-security-vulnerabilities/configuring-automated-code-scanning - /github/finding-security-vulnerabilities-and-errors-in-your-code/enabling-code-scanning @@ -14,9 +14,9 @@ redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-for-a-repository - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-default-setup-for-code-scanning + - /code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning permissions: '{% data reusables.permissions.security-repo-enable %}' product: '{% data reusables.gated-features.code-scanning %}' -type: how_to topics: - Code Security - Code scanning @@ -24,6 +24,7 @@ versions: fpt: '*' ghes: '*' ghec: '*' +contentType: how-tos --- ## About default setup diff --git a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/customizing-your-advanced-setup-for-code-scanning.md similarity index 99% rename from content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/customizing-your-advanced-setup-for-code-scanning.md index 75952a094a3c..a698fdb51382 100644 --- a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/customizing-your-advanced-setup-for-code-scanning.md @@ -1,6 +1,6 @@ --- title: Customizing your advanced setup for code scanning -intro: 'You can customize how your advanced setup scans the code in your project for vulnerabilities and errors.' +intro: You can customize how your advanced setup scans the code in your project for vulnerabilities and errors. permissions: '{% data reusables.permissions.code-scanning-all-alerts %} if [advanced setup](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning) is already enabled' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning @@ -9,6 +9,7 @@ redirect_from: - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning - /github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/customizing-code-scanning + - /code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning versions: fpt: '*' ghes: '*' @@ -24,6 +25,7 @@ topics: - Python shortTitle: Customize advanced setup allowTitleToDifferFromFilename: true +contentType: how-tos --- @@ -370,11 +372,8 @@ In the following example, the `+` symbol ensures that the specified additional p queries: +security-and-quality,octo-org/python-qlpack/show_ifs.ql@main packs: +scope/pack1,scope/pack2@1.2.3,scope/pack3@4.5.6:path/to/queries ``` - - - - + ## Using a custom configuration file @@ -517,6 +516,8 @@ For analysis where code is built, if you want to limit {% data variables.product You can quickly analyze small portions of a monorepo when you modify code in specific directories. You'll need to both exclude directories in your build steps and use the `paths-ignore` and `paths` keywords for [`on.`](/actions/using-workflows/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore) in your workflow. + + ### Example configuration files {% data reusables.code-scanning.example-configuration-files %} diff --git a/content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/index.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/index.md new file mode 100644 index 000000000000..5c3a30ec5cec --- /dev/null +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/index.md @@ -0,0 +1,20 @@ +--- +title: Configure code scanning +intro: Configure {% data variables.product.prodname_code_scanning %} for your repositories by choosing between default or advanced setup and customizing advanced settings as needed. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +topics: + - Code Security + - Code scanning + - Actions + - Repositories +children: + - /configuring-default-setup-for-code-scanning + - /configuring-advanced-setup-for-code-scanning + - /customizing-your-advanced-setup-for-code-scanning +redirect_from: + - /code-security/code-scanning/enabling-code-scanning +--- diff --git a/content/code-security/how-tos/scan-code-for-vulnerabilities/index.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/index.md new file mode 100644 index 000000000000..8f35384c0e65 --- /dev/null +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/index.md @@ -0,0 +1,16 @@ +--- +title: Scan code for vulnerabilities +intro: Scan your code for vulnerabilities by configuring code scanning, managing configurations, running scans locally or in your editor, integrating with existing tools, and troubleshooting issues. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +children: + - /configure-code-scanning + - /manage-your-configuration + - /scan-from-the-command-line + - /scan-from-vs-code + - /integrate-with-existing-tools + - /troubleshooting +--- diff --git a/content/code-security/how-tos/scan-code-for-vulnerabilities/integrate-with-existing-tools/index.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/integrate-with-existing-tools/index.md new file mode 100644 index 000000000000..2a05783283c3 --- /dev/null +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/integrate-with-existing-tools/index.md @@ -0,0 +1,21 @@ +--- +title: Integrate with existing tools +intro: Integrate {% data variables.product.prodname_code_scanning %} with your existing tools and workflows by running scans in your CI system or uploading results to {% data variables.product.github %} using Static Analysis Results Interchange Format (SARIF). +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +topics: + - Code Security + - Code scanning + - CodeQL + - Repositories + - Pull requests + - Integration + - CI + - SARIF +children: + - /using-code-scanning-with-your-existing-ci-system + - /uploading-a-sarif-file-to-github +--- diff --git a/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/integrate-with-existing-tools/uploading-a-sarif-file-to-github.md similarity index 98% rename from content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/integrate-with-existing-tools/uploading-a-sarif-file-to-github.md index ade94508c8d9..9ea7803d9507 100644 --- a/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/integrate-with-existing-tools/uploading-a-sarif-file-to-github.md @@ -10,11 +10,11 @@ redirect_from: - /code-security/secure-coding/uploading-a-sarif-file-to-github - /code-security/secure-coding/integrating-with-code-scanning/uploading-a-sarif-file-to-github - /github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning/uploading-a-sarif-file-to-github + - /code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to topics: - Code Security - Code scanning @@ -23,6 +23,7 @@ topics: - Repositories - CI - SARIF +contentType: how-tos --- {% data reusables.code-scanning.enterprise-enable-code-scanning %} diff --git a/content/code-security/code-scanning/integrating-with-code-scanning/using-code-scanning-with-your-existing-ci-system.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/integrate-with-existing-tools/using-code-scanning-with-your-existing-ci-system.md similarity index 92% rename from content/code-security/code-scanning/integrating-with-code-scanning/using-code-scanning-with-your-existing-ci-system.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/integrate-with-existing-tools/using-code-scanning-with-your-existing-ci-system.md index a15ee3936d02..16a3d14c8e8a 100644 --- a/content/code-security/code-scanning/integrating-with-code-scanning/using-code-scanning-with-your-existing-ci-system.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/integrate-with-existing-tools/using-code-scanning-with-your-existing-ci-system.md @@ -1,12 +1,14 @@ --- title: Using code scanning with your existing CI system -intro: 'You can analyze your code with the {% data variables.product.prodname_codeql_cli %} or another tool in a third-party continuous integration system and upload the results to {% data variables.product.github %}. The resulting {% data variables.product.prodname_code_scanning %} alerts are shown alongside any alerts generated within {% data variables.product.github %}.' +shortTitle: Use with existing CI system +intro: You can analyze your code with the {% data variables.product.prodname_codeql_cli %} or another tool in a third-party continuous integration system and upload the results to {% data variables.product.github %}. The resulting {% data variables.product.prodname_code_scanning %} alerts are shown alongside any alerts generated within {% data variables.product.github %}. permissions: '{% data reusables.permissions.code-scanning-all-alerts %}' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/using-codeql-code-scanning-with-your-existing-ci-system - /code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system - /code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system + - /code-security/code-scanning/integrating-with-code-scanning/using-code-scanning-with-your-existing-ci-system versions: fpt: '*' ghes: '*' @@ -21,6 +23,7 @@ topics: - Integration - CI - SARIF +contentType: how-tos --- {% data reusables.code-scanning.enterprise-enable-code-scanning %} diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/about-the-tool-status-page.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/about-the-tool-status-page.md similarity index 98% rename from content/code-security/code-scanning/managing-your-code-scanning-configuration/about-the-tool-status-page.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/about-the-tool-status-page.md index d56aaba40e9c..3579b562a0f5 100644 --- a/content/code-security/code-scanning/managing-your-code-scanning-configuration/about-the-tool-status-page.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/about-the-tool-status-page.md @@ -11,11 +11,12 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-the-tool-status-page -type: overview + - /code-security/code-scanning/managing-your-code-scanning-configuration/about-the-tool-status-page topics: - Code Security - Code scanning - CodeQL +contentType: how-tos --- {% data reusables.code-scanning.enterprise-enable-code-scanning %} diff --git a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/codeql-code-scanning-for-compiled-languages.md similarity index 99% rename from content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/codeql-code-scanning-for-compiled-languages.md index 531d9a8c4528..eb329969f224 100644 --- a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/codeql-code-scanning-for-compiled-languages.md @@ -1,7 +1,7 @@ --- title: CodeQL code scanning for compiled languages shortTitle: CodeQL for compiled languages -intro: 'Understand how {% data variables.product.prodname_codeql %} analyzes compiled languages, the build options available, and learn how you can customize the database generation process if you need to.' +intro: Understand how {% data variables.product.prodname_codeql %} analyzes compiled languages, the build options available, and learn how you can customize the database generation process if you need to. permissions: '{% data reusables.permissions.code-scanning-all-alerts %} if [advanced setup](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning) is already enabled' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: @@ -13,11 +13,11 @@ redirect_from: - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages - /github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/codeql-code-scanning-for-compiled-languages + - /code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to topics: - Code Security - Code scanning @@ -28,6 +28,7 @@ topics: - C# - Java - Kotlin +contentType: how-tos --- {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %} diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/configuring-larger-runners-for-default-setup.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/configuring-larger-runners-for-default-setup.md similarity index 94% rename from content/code-security/code-scanning/managing-your-code-scanning-configuration/configuring-larger-runners-for-default-setup.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/configuring-larger-runners-for-default-setup.md index 1bec77e0582a..73b28ff5486e 100644 --- a/content/code-security/code-scanning/managing-your-code-scanning-configuration/configuring-larger-runners-for-default-setup.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/configuring-larger-runners-for-default-setup.md @@ -1,7 +1,7 @@ --- title: Configuring larger runners for default setup shortTitle: Configure larger runners -intro: 'You can run {% data variables.product.prodname_code_scanning %} default setup more quickly on bigger codebases using {% data variables.actions.hosted_runners %}.' +intro: You can run {% data variables.product.prodname_code_scanning %} default setup more quickly on bigger codebases using {% data variables.actions.hosted_runners %}. product: '{% data reusables.actions.larger-runner-permissions %}' versions: feature: default-setup-larger-runners @@ -9,6 +9,9 @@ topics: - Code scanning - CodeQL - Actions +redirect_from: + - /code-security/code-scanning/managing-your-code-scanning-configuration/configuring-larger-runners-for-default-setup +contentType: how-tos --- {% data reusables.code-scanning.beta-larger-runners-support %} diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/editing-your-configuration-of-default-setup.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/editing-your-configuration-of-default-setup.md similarity index 96% rename from content/code-security/code-scanning/managing-your-code-scanning-configuration/editing-your-configuration-of-default-setup.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/editing-your-configuration-of-default-setup.md index c3f2e343b6bd..8392399ef89f 100644 --- a/content/code-security/code-scanning/managing-your-code-scanning-configuration/editing-your-configuration-of-default-setup.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/editing-your-configuration-of-default-setup.md @@ -1,16 +1,18 @@ --- title: Editing your configuration of default setup shortTitle: Edit default setup -intro: 'You can edit your existing configuration of default setup for {% data variables.product.prodname_code_scanning %} to better meet your needs.' +intro: You can edit your existing configuration of default setup for {% data variables.product.prodname_code_scanning %} to better meet your needs. permissions: '{% data reusables.permissions.security-org-enable %}' versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to topics: - Code scanning - CodeQL +redirect_from: + - /code-security/code-scanning/managing-your-code-scanning-configuration/editing-your-configuration-of-default-setup +contentType: how-tos --- ## About editing your configuration of default setup diff --git a/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/index.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/index.md new file mode 100644 index 000000000000..a3428193fdbf --- /dev/null +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/index.md @@ -0,0 +1,25 @@ +--- +title: Manage your configuration +intro: Manage and refine your {% data variables.product.prodname_code_scanning %} configuration by monitoring tool status, updating default setup settings, and enforcing protections as your needs evolve. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +topics: + - Code Security + - Code scanning + - CodeQL + - Actions + - Repositories + - C/C++ + - C# + - Java + - Kotlin +children: + - /about-the-tool-status-page + - /editing-your-configuration-of-default-setup + - /set-code-scanning-merge-protection + - /configuring-larger-runners-for-default-setup + - /codeql-code-scanning-for-compiled-languages +--- diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/set-code-scanning-merge-protection.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/set-code-scanning-merge-protection.md similarity index 93% rename from content/code-security/code-scanning/managing-your-code-scanning-configuration/set-code-scanning-merge-protection.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/set-code-scanning-merge-protection.md index 7dab7afdb78c..c938f77c5ec8 100644 --- a/content/code-security/code-scanning/managing-your-code-scanning-configuration/set-code-scanning-merge-protection.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/set-code-scanning-merge-protection.md @@ -1,17 +1,19 @@ --- title: Set code scanning merge protection shortTitle: Set merge protection -intro: 'You can use rulesets to set {% data variables.product.prodname_code_scanning %} merge protection for pull requests.' +intro: You can use rulesets to set {% data variables.product.prodname_code_scanning %} merge protection for pull requests. permissions: '{% data reusables.permissions.security-org-enable %}' product: '{% data reusables.gated-features.code-scanning %}' versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to topics: - Code scanning - CodeQL +redirect_from: + - /code-security/code-scanning/managing-your-code-scanning-configuration/set-code-scanning-merge-protection +contentType: how-tos --- ## About using rulesets for {% data variables.product.prodname_code_scanning %} merge protection diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/advanced-setup-of-the-codeql-cli.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/advanced-setup-of-the-codeql-cli.md similarity index 94% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/advanced-setup-of-the-codeql-cli.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/advanced-setup-of-the-codeql-cli.md index e669f8e79337..89197bdf9849 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/advanced-setup-of-the-codeql-cli.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/advanced-setup-of-the-codeql-cli.md @@ -1,6 +1,6 @@ --- title: Advanced setup of the CodeQL CLI -intro: 'You can modify your {% data variables.product.prodname_codeql_cli %} setup to use a local checkout of the {% data variables.product.prodname_codeql %} repository for analysis, set up multiple versions of the {% data variables.product.prodname_codeql_cli %}, and analyze databases you have downloaded from {% data variables.product.github %}.' +intro: You can modify your {% data variables.product.prodname_codeql_cli %} setup to use a local checkout of the {% data variables.product.prodname_codeql %} repository for analysis, set up multiple versions of the {% data variables.product.prodname_codeql_cli %}, and analyze databases you have downloaded from {% data variables.product.github %}. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -10,6 +10,9 @@ topics: - Code Security - Code scanning - CodeQL +redirect_from: + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/advanced-setup-of-the-codeql-cli +contentType: how-tos --- ## About advanced setup of the {% data variables.product.prodname_codeql_cli %} diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-database-bundle-for-troubleshooting.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/creating-database-bundle-for-troubleshooting.md similarity index 87% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-database-bundle-for-troubleshooting.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/creating-database-bundle-for-troubleshooting.md index c497493490cd..bf18a811578b 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-database-bundle-for-troubleshooting.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/creating-database-bundle-for-troubleshooting.md @@ -1,6 +1,7 @@ --- title: Creating CodeQL CLI database bundles -intro: 'You can create a database bundle with {% data variables.product.prodname_codeql %} troubleshooting information.' +shortTitle: Createting CodeQL CLI database bundles +intro: You can create a database bundle with {% data variables.product.prodname_codeql %} troubleshooting information. allowTitleToDifferFromFilename: true product: '{% data reusables.gated-features.codeql %}' versions: @@ -11,6 +12,9 @@ topics: - Code Security - Code scanning - CodeQL +redirect_from: + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-database-bundle-for-troubleshooting +contentType: how-tos --- {% data reusables.code-scanning.codeql-database-archive-contains-source-code %} diff --git a/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/index.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/index.md new file mode 100644 index 000000000000..0114db6b0fff --- /dev/null +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/index.md @@ -0,0 +1,20 @@ +--- +title: Scan from the command line +intro: Run code scanning from the command line using the {% data variables.product.prodname_codeql_cli %} to configure scans, customize queries, and troubleshoot results. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +topics: + - Code Security + - Code scanning + - CodeQL +children: + - /setting-up-the-codeql-cli + - /advanced-setup-of-the-codeql-cli + - /using-custom-queries-with-the-codeql-cli + - /testing-query-help-files + - /specifying-command-options-in-a-codeql-configuration-file + - /creating-database-bundle-for-troubleshooting +--- diff --git a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/setting-up-the-codeql-cli.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/setting-up-the-codeql-cli.md similarity index 95% rename from content/code-security/codeql-cli/getting-started-with-the-codeql-cli/setting-up-the-codeql-cli.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/setting-up-the-codeql-cli.md index 8b49b7bbc73c..8b93cd1271e1 100644 --- a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/setting-up-the-codeql-cli.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/setting-up-the-codeql-cli.md @@ -1,6 +1,7 @@ --- title: Setting up the CodeQL CLI -intro: 'To get started with the {% data variables.product.prodname_codeql_cli %}, you need to download and set up the CLI so that it can access the tools and libraries required to create and analyze databases.' +shortTitle: Set up the CodeQL CLI +intro: To get started with the {% data variables.product.prodname_codeql_cli %}, you need to download and set up the CLI so that it can access the tools and libraries required to create and analyze databases. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -16,7 +17,8 @@ redirect_from: - /code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-cli-in-your-ci-system - /code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system - /code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system - + - /code-security/codeql-cli/getting-started-with-the-codeql-cli/setting-up-the-codeql-cli +contentType: how-tos --- ## Setting up the {% data variables.product.prodname_codeql_cli %} diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/specifying-command-options-in-a-codeql-configuration-file.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/specifying-command-options-in-a-codeql-configuration-file.md similarity index 90% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/specifying-command-options-in-a-codeql-configuration-file.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/specifying-command-options-in-a-codeql-configuration-file.md index 195cfc4bae53..8d9cf03e396f 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/specifying-command-options-in-a-codeql-configuration-file.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/specifying-command-options-in-a-codeql-configuration-file.md @@ -1,6 +1,7 @@ --- title: Specifying command options in a CodeQL configuration file -intro: 'You can save default command options in a {% data variables.product.prodname_codeql %} configuration file.' +shortTitle: Specify command options in a CodeQL configuration file +intro: You can save default command options in a {% data variables.product.prodname_codeql %} configuration file. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -13,6 +14,8 @@ topics: redirect_from: - /code-security/codeql-cli/specifying-command-options-in-a-codeql-configuration-file - /code-security/codeql-cli/using-the-codeql-cli/specifying-command-options-in-a-codeql-configuration-file + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/specifying-command-options-in-a-codeql-configuration-file +contentType: how-tos --- ## About specifying command options in a {% data variables.product.prodname_codeql %} configuration file diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/testing-query-help-files.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/testing-query-help-files.md similarity index 93% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/testing-query-help-files.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/testing-query-help-files.md index 09134f44276f..272b09a716b7 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/testing-query-help-files.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/testing-query-help-files.md @@ -1,6 +1,7 @@ --- title: Testing query help files -intro: 'You can use the {% data variables.product.prodname_codeql_cli %} to preview your query help files as Markdown and ensure they are valid.' +shortTitle: Test query help files +intro: You can use the {% data variables.product.prodname_codeql_cli %} to preview your query help files as Markdown and ensure they are valid. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -13,6 +14,8 @@ topics: redirect_from: - /code-security/codeql-cli/testing-query-help-files - /code-security/codeql-cli/using-the-codeql-cli/testing-query-help-files + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/testing-query-help-files +contentType: how-tos --- ## About testing query help files diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/using-custom-queries-with-the-codeql-cli.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/using-custom-queries-with-the-codeql-cli.md similarity index 95% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/using-custom-queries-with-the-codeql-cli.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/using-custom-queries-with-the-codeql-cli.md index 88c241fbfc78..e6fa4adbcb6d 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/using-custom-queries-with-the-codeql-cli.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/using-custom-queries-with-the-codeql-cli.md @@ -1,6 +1,7 @@ --- title: Using custom queries with the CodeQL CLI -intro: 'You can write your own {% data variables.product.prodname_codeql %} queries to find specific vulnerabilities and errors.' +shortTitle: Use custom queries with the CodeQL CLI +intro: You can write your own {% data variables.product.prodname_codeql %} queries to find specific vulnerabilities and errors. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -13,6 +14,8 @@ topics: redirect_from: - /code-security/codeql-cli/using-custom-queries-with-the-codeql-cli - /code-security/codeql-cli/using-the-codeql-cli/using-custom-queries-with-the-codeql-cli + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/using-custom-queries-with-the-codeql-cli +contentType: how-tos --- ## About custom queries and the {% data variables.product.prodname_codeql_cli %} diff --git a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/configuring-access-to-the-codeql-cli.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/configuring-access-to-the-codeql-cli.md similarity index 88% rename from content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/configuring-access-to-the-codeql-cli.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/configuring-access-to-the-codeql-cli.md index e8e2f97c566a..1ce5abc3c947 100644 --- a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/configuring-access-to-the-codeql-cli.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/configuring-access-to-the-codeql-cli.md @@ -9,9 +9,11 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'The {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode %} extension uses the {% data variables.product.prodname_codeql_cli %} to compile and run queries.' +intro: The {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode %} extension uses the {% data variables.product.prodname_codeql_cli %} to compile and run queries. allowTitleToDifferFromFilename: true +redirect_from: + - /code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/configuring-access-to-the-codeql-cli +contentType: how-tos --- ## Configuring access to the {% data variables.product.prodname_codeql_cli %} diff --git a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/creating-a-custom-query.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/creating-a-custom-query.md similarity index 90% rename from content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/creating-a-custom-query.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/creating-a-custom-query.md index 1aaae688a008..c27899995a68 100644 --- a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/creating-a-custom-query.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/creating-a-custom-query.md @@ -9,8 +9,10 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'You can work from a template to write your own code to create a custom query to analyze a specific language.' +intro: You can work from a template to write your own code to create a custom query to analyze a specific language. +redirect_from: + - /code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/creating-a-custom-query +contentType: how-tos --- ## About custom queries diff --git a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/customizing-settings.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/customizing-settings.md similarity index 96% rename from content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/customizing-settings.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/customizing-settings.md index 9f5819b3872b..856e276e543b 100644 --- a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/customizing-settings.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/customizing-settings.md @@ -9,10 +9,11 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'You can edit the settings for the {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode %} extension to suit your needs.' +intro: You can edit the settings for the {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode %} extension to suit your needs. redirect_from: - /code-security/codeql-for-vs-code/customizing-settings + - /code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/customizing-settings +contentType: how-tos --- ## About settings in the {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode %} extension diff --git a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/exploring-data-flow-with-path-queries.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/exploring-data-flow-with-path-queries.md similarity index 88% rename from content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/exploring-data-flow-with-path-queries.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/exploring-data-flow-with-path-queries.md index 4e388ae43285..53bfe43e1737 100644 --- a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/exploring-data-flow-with-path-queries.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/exploring-data-flow-with-path-queries.md @@ -9,10 +9,11 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'You can run {% data variables.product.prodname_codeql %} queries in {% data variables.product.prodname_vscode %} to help you track the flow of data through a program, highlighting areas that are potential security vulnerabilities.' +intro: You can run {% data variables.product.prodname_codeql %} queries in {% data variables.product.prodname_vscode %} to help you track the flow of data through a program, highlighting areas that are potential security vulnerabilities. redirect_from: - /code-security/codeql-for-vs-code/exploring-data-flow-with-path-queries + - /code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/exploring-data-flow-with-path-queries +contentType: how-tos --- ## About path queries diff --git a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/exploring-the-structure-of-your-source-code.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/exploring-the-structure-of-your-source-code.md similarity index 89% rename from content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/exploring-the-structure-of-your-source-code.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/exploring-the-structure-of-your-source-code.md index 178f46e84a33..bbcf99b28a2c 100644 --- a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/exploring-the-structure-of-your-source-code.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/exploring-the-structure-of-your-source-code.md @@ -9,10 +9,11 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'You can use the AST viewer to display the abstract syntax tree of a {% data variables.product.prodname_codeql %} database.' +intro: You can use the AST viewer to display the abstract syntax tree of a {% data variables.product.prodname_codeql %} database. redirect_from: - /code-security/codeql-for-vs-code/exploring-the-structure-of-your-source-code + - /code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/exploring-the-structure-of-your-source-code +contentType: how-tos --- ## About the abstract syntax tree diff --git a/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/index.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/index.md new file mode 100644 index 000000000000..ee4dc06cef90 --- /dev/null +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/index.md @@ -0,0 +1,27 @@ +--- +title: Scan from VS Code +intro: Scan and analyze code from {% data variables.product.prodname_vscode %} using {% data variables.product.prodname_codeql %} to write, test, and run queries, explore code structure, and manage databases and packs. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +topics: + - Code Security + - Code scanning + - CodeQL +children: + - /installing-codeql-for-vs-code + - /managing-codeql-databases + - /running-codeql-queries + - /exploring-data-flow-with-path-queries + - /running-codeql-queries-at-scale-with-multi-repository-variant-analysis + - /using-the-codeql-model-editor + - /creating-a-custom-query + - /managing-codeql-packs + - /exploring-the-structure-of-your-source-code + - /testing-codeql-queries-in-vs-code + - /customizing-settings + - /setting-up-a-codeql-workspace + - /configuring-access-to-the-codeql-cli +--- diff --git a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/installing-codeql-for-vs-code.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/installing-codeql-for-vs-code.md similarity index 91% rename from content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/installing-codeql-for-vs-code.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/installing-codeql-for-vs-code.md index abb8f7c21051..6e79166cd0ac 100644 --- a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/installing-codeql-for-vs-code.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/installing-codeql-for-vs-code.md @@ -10,9 +10,11 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'To get started with {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode %}, you need to install and set up the extension.' +intro: To get started with {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode %}, you need to install and set up the extension. allowTitleToDifferFromFilename: true +redirect_from: + - /code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/installing-codeql-for-vs-code +contentType: how-tos --- ## Prerequisites diff --git a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/managing-codeql-databases.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/managing-codeql-databases.md similarity index 93% rename from content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/managing-codeql-databases.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/managing-codeql-databases.md index 851f94d5fcb9..ffd53cb10306 100644 --- a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/managing-codeql-databases.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/managing-codeql-databases.md @@ -9,8 +9,10 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'You can work with {% data variables.product.prodname_codeql %} databases using the extension.' +intro: You can work with {% data variables.product.prodname_codeql %} databases using the extension. +redirect_from: + - /code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/managing-codeql-databases +contentType: how-tos --- ## About {% data variables.product.prodname_codeql %} databases diff --git a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/managing-codeql-packs.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/managing-codeql-packs.md similarity index 91% rename from content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/managing-codeql-packs.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/managing-codeql-packs.md index 911defcbc970..c21c795626be 100644 --- a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/managing-codeql-packs.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/managing-codeql-packs.md @@ -9,11 +9,12 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'You can view, write, and edit {% data variables.product.prodname_codeql %} query and library packs in {% data variables.product.prodname_vscode %} using the {% data variables.product.prodname_codeql %} extension.' +intro: You can view, write, and edit {% data variables.product.prodname_codeql %} query and library packs in {% data variables.product.prodname_vscode %} using the {% data variables.product.prodname_codeql %} extension. allowTitleToDifferFromFilename: true redirect_from: - /code-security/codeql-for-vs-code/working-with-codeql-packs-in-visual-studio-code + - /code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/managing-codeql-packs +contentType: how-tos --- ## Benefits of using the {% data variables.product.prodname_codeql %} extension for {% data variables.product.prodname_vscode %} to work with packs diff --git a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis.md similarity index 95% rename from content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis.md index 6bc0bfcc030d..524f3f4ccf9d 100644 --- a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis.md @@ -1,16 +1,17 @@ --- title: Running CodeQL queries at scale with multi-repository variant analysis -shortTitle: Queries at scale +shortTitle: Run queries at scale versions: - feature: codeql-vs-code-mrva + feature: codeql-vs-code-mrva topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'You can run {% data variables.product.prodname_codeql %} queries on a large number of repositories on {% data variables.product.github %} from {% data variables.product.prodname_vscode %}.' +intro: You can run {% data variables.product.prodname_codeql %} queries on a large number of repositories on {% data variables.product.github %} from {% data variables.product.prodname_vscode %}. redirect_from: - /code-security/codeql-for-vs-code/running-codeql-queries-at-scale-with-mrva + - /code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis +contentType: how-tos --- ## About running {% data variables.product.prodname_codeql %} queries at scale with multi-repository variant analysis @@ -19,7 +20,7 @@ With multi-repository variant analysis (MRVA), you can run {% data variables.pro When you run MRVA against a list of repositories, your query is run against each repository that has a {% data variables.product.prodname_codeql %} database available to analyze. {% data variables.product.github %} creates and stores the latest {% data variables.product.prodname_codeql %} database for the default branch of thousands of public repositories, including every repository that runs {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_codeql %}. -You need to enable {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_codeql %} on {% data variables.product.github %}, using either default setup or advanced setup, before adding your repository to a list for analysis. For information about enabling {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_codeql %}, see [AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-for-a-repository#configuring-code-scanning-automatically). +You need to enable {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_codeql %} on {% data variables.product.github %}, using either default setup or advanced setup, before adding your repository to a list for analysis. For information about enabling {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_codeql %}, see [AUTOTITLE](/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/configuring-default-setup-for-code-scanning). ### How MRVA runs queries against {% data variables.product.prodname_codeql %} databases on {% data variables.product.prodname_dotcom_the_website %} @@ -125,7 +126,7 @@ You can export your results for further analysis or to discuss them with collabo ## Creating a custom list of repositories > [!NOTE] -> {% data variables.product.prodname_codeql %} analysis always requires a {% data variables.product.prodname_codeql %} database to run queries against. When you run variant analysis against a list of repositories, your query will only be executed against the repositories that currently have a {% data variables.product.prodname_codeql %} database available to download. The best way to make a repository available for variant analysis is to enable {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}. For information about enabling {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_codeql %}, see [AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-for-a-repository#configuring-code-scanning-automatically). +> {% data variables.product.prodname_codeql %} analysis always requires a {% data variables.product.prodname_codeql %} database to run queries against. When you run variant analysis against a list of repositories, your query will only be executed against the repositories that currently have a {% data variables.product.prodname_codeql %} database available to download. The best way to make a repository available for variant analysis is to enable {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}. For information about enabling {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_codeql %}, see [AUTOTITLE](/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/configuring-default-setup-for-code-scanning). 1. In the "Variant Analysis Repositories" view, click the "Add list" icon. diff --git a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/running-codeql-queries.md similarity index 97% rename from content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/running-codeql-queries.md index 1f9b6dc73795..ad0532d2da46 100644 --- a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/running-codeql-queries.md @@ -9,11 +9,12 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'You can run queries on {% data variables.product.prodname_codeql %} databases and view the results in {% data variables.product.prodname_vscode %}.' +intro: You can run queries on {% data variables.product.prodname_codeql %} databases and view the results in {% data variables.product.prodname_vscode %}. allowTitleToDifferFromFilename: true redirect_from: - /code-security/codeql-for-vs-code/analyzing-your-projects + - /code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries +contentType: how-tos --- ## About running {% data variables.product.prodname_codeql %} queries diff --git a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/setting-up-a-codeql-workspace.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/setting-up-a-codeql-workspace.md similarity index 93% rename from content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/setting-up-a-codeql-workspace.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/setting-up-a-codeql-workspace.md index 7577fb098fd9..5a6fd67753de 100644 --- a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/setting-up-a-codeql-workspace.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/setting-up-a-codeql-workspace.md @@ -9,9 +9,11 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'When you''re working with {% data variables.product.prodname_codeql %}, you need access to the standard libraries and queries.' +intro: When you're working with {% data variables.product.prodname_codeql %}, you need access to the standard libraries and queries. allowTitleToDifferFromFilename: true +redirect_from: + - /code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/setting-up-a-codeql-workspace +contentType: how-tos --- ## Setting up a {% data variables.product.prodname_codeql %} workspace diff --git a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/testing-codeql-queries-in-vs-code.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/testing-codeql-queries-in-vs-code.md similarity index 93% rename from content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/testing-codeql-queries-in-vs-code.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/testing-codeql-queries-in-vs-code.md index aca4591a9afc..70b40239550f 100644 --- a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/testing-codeql-queries-in-vs-code.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/testing-codeql-queries-in-vs-code.md @@ -9,11 +9,12 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'You can run unit tests for {% data variables.product.prodname_codeql %} queries using the {% data variables.product.prodname_vscode %} extension.' +intro: You can run unit tests for {% data variables.product.prodname_codeql %} queries using the {% data variables.product.prodname_vscode %} extension. allowTitleToDifferFromFilename: true redirect_from: - /code-security/codeql-for-vs-code/testing-codeql-queries-in-visual-studio-code + - /code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/testing-codeql-queries-in-vs-code +contentType: how-tos --- ## About testing queries in {% data variables.product.prodname_vscode_shortname %} diff --git a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/using-the-codeql-model-editor.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/using-the-codeql-model-editor.md similarity index 97% rename from content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/using-the-codeql-model-editor.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/using-the-codeql-model-editor.md index 09c52ad99712..cd6ef4c7615d 100644 --- a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/using-the-codeql-model-editor.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/using-the-codeql-model-editor.md @@ -1,6 +1,6 @@ --- title: Using the CodeQL model editor -shortTitle: CodeQL model editor +shortTitle: Use the model editor versions: fpt: '*' ghec: '*' @@ -9,10 +9,11 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'You can view, write, and edit {% data variables.product.prodname_codeql %} model packs in {% data variables.product.prodname_vscode %}.' +intro: You can view, write, and edit {% data variables.product.prodname_codeql %} model packs in {% data variables.product.prodname_vscode %}. redirect_from: - /code-security/codeql-for-vs-code/using-the-codeql-model-editor + - /code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/using-the-codeql-model-editor +contentType: how-tos --- {% data reusables.code-scanning.beta-model-packs %} diff --git a/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/index.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/index.md new file mode 100644 index 000000000000..bc9d30db89b8 --- /dev/null +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/index.md @@ -0,0 +1,21 @@ +--- +title: Troubleshooting +shortTitle: Troubleshoot +intro: Diagnose and resolve issues with code scanning by troubleshooting analysis errors and problems uploading SARIF results. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +topics: + - Code scanning + - Errors + - Troubleshooting + - SARIF +children: + - /troubleshooting-analysis-errors + - /troubleshooting-sarif-uploads +redirect_from: + - /code-security/code-scanning/troubleshooting-sarif + - /code-security/code-scanning/troubleshooting-sarif-uploads +--- diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/advanced-security-must-be-enabled.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/advanced-security-must-be-enabled.md similarity index 94% rename from content/code-security/code-scanning/troubleshooting-code-scanning/advanced-security-must-be-enabled.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/advanced-security-must-be-enabled.md index b2c6d1a66cba..017812c5d5bb 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/advanced-security-must-be-enabled.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/advanced-security-must-be-enabled.md @@ -1,9 +1,8 @@ --- title: 'Error: "{% data variables.product.prodname_GHAS_or_code_security %} must be enabled for this repository to use code scanning"' shortTitle: '{% data variables.product.prodname_code_security %} must be enabled' -intro: 'If you see this error, make sure that {% data variables.product.prodname_GH_code_security %} is enabled.' +intro: If you see this error, make sure that {% data variables.product.prodname_GH_code_security %} is enabled. allowTitleToDifferFromFilename: true -type: reference topics: - Code scanning - Errors @@ -12,6 +11,9 @@ versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/advanced-security-must-be-enabled +contentType: how-tos --- ## About this error diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/alerts-in-generated-code.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/alerts-in-generated-code.md similarity index 60% rename from content/code-security/code-scanning/troubleshooting-code-scanning/alerts-in-generated-code.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/alerts-in-generated-code.md index 0367a9f0e7af..ff0b443bfa33 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/alerts-in-generated-code.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/alerts-in-generated-code.md @@ -1,7 +1,7 @@ --- title: Alerts found in generated code shortTitle: Alerts in generated code -intro: 'When analyzing your code with {% data variables.product.prodname_code_scanning %}, you may wish to build only the code which you wish to analyze.' +intro: When analyzing your code with {% data variables.product.prodname_code_scanning %}, you may wish to build only the code which you wish to analyze. allowTitleToDifferFromFilename: true versions: fpt: '*' @@ -9,6 +9,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-code-scanning/alerts-found-in-generated-code + - /code-security/code-scanning/troubleshooting-code-scanning/alerts-in-generated-code +contentType: how-tos --- {% data reusables.code-scanning.codeql-action-version-ghes %} diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/analysis-takes-too-long.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/analysis-takes-too-long.md similarity index 96% rename from content/code-security/code-scanning/troubleshooting-code-scanning/analysis-takes-too-long.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/analysis-takes-too-long.md index 0ca7fad654b7..530e7a35399b 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/analysis-takes-too-long.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/analysis-takes-too-long.md @@ -1,7 +1,7 @@ --- title: Code scanning analysis takes too long shortTitle: Analysis takes too long -intro: 'You can fine tune your {% data variables.product.prodname_code_scanning %} configuration to minimize analysis time.' +intro: You can fine tune your {% data variables.product.prodname_code_scanning %} configuration to minimize analysis time. allowTitleToDifferFromFilename: true versions: fpt: '*' @@ -9,6 +9,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-code-scanning/build-is-taking-too-long + - /code-security/code-scanning/troubleshooting-code-scanning/analysis-takes-too-long +contentType: how-tos --- {% data reusables.code-scanning.codeql-action-version-ghes %} diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/automatic-build-failed.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/automatic-build-failed.md similarity index 79% rename from content/code-security/code-scanning/troubleshooting-code-scanning/automatic-build-failed.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/automatic-build-failed.md index 95ce2f09070c..47e78d658d2b 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/automatic-build-failed.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/automatic-build-failed.md @@ -2,13 +2,15 @@ title: Automatic build failed for a compiled language shortTitle: Automatic build failed allowTitleToDifferFromFilename: true -intro: 'If automatic build fails, you can configure {% data variables.product.prodname_code_scanning %} to use specific build steps for compiled languages.' +intro: If automatic build fails, you can configure {% data variables.product.prodname_code_scanning %} to use specific build steps for compiled languages. versions: fpt: '*' ghes: '*' ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-code-scanning/automatic-build-failed-for-a-compiled-language + - /code-security/code-scanning/troubleshooting-code-scanning/automatic-build-failed +contentType: how-tos --- {% data reusables.code-scanning.codeql-action-version-ghes %} diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/c-sharp-compiler-unexpectedly-failing.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/c-sharp-compiler-unexpectedly-failing.md similarity index 84% rename from content/code-security/code-scanning/troubleshooting-code-scanning/c-sharp-compiler-unexpectedly-failing.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/c-sharp-compiler-unexpectedly-failing.md index a77b97db3768..d9d8fb6b06a5 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/c-sharp-compiler-unexpectedly-failing.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/c-sharp-compiler-unexpectedly-failing.md @@ -1,12 +1,15 @@ --- -title: 'C# compiler unexpectedly failing' -shortTitle: 'C# compiler failing' +title: C# compiler unexpectedly failing +shortTitle: C# compiler failing allowTitleToDifferFromFilename: true -intro: 'If your MSBuild C# compilation is unexpectedly failing, you may need to amend your application project file.' +intro: If your MSBuild C# compilation is unexpectedly failing, you may need to amend your application project file. versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/c-sharp-compiler-unexpectedly-failing +contentType: how-tos --- ## About these errors diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/cannot-enable-codeql-in-a-private-repository.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/cannot-enable-codeql-in-a-private-repository.md similarity index 94% rename from content/code-security/code-scanning/troubleshooting-code-scanning/cannot-enable-codeql-in-a-private-repository.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/cannot-enable-codeql-in-a-private-repository.md index 3341a87b57fb..3dd31a54d278 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/cannot-enable-codeql-in-a-private-repository.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/cannot-enable-codeql-in-a-private-repository.md @@ -1,8 +1,7 @@ --- -title: 'Cannot enable CodeQL in a private repository' +title: Cannot enable CodeQL in a private repository intro: '{% data variables.product.prodname_GH_code_security %} must be enabled in order to use {% data variables.product.prodname_code_scanning %} on private repositories.' allowTitleToDifferFromFilename: true -type: reference topics: - Code scanning - Errors @@ -11,6 +10,9 @@ versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/cannot-enable-codeql-in-a-private-repository +contentType: how-tos --- {% ifversion fpt %} diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/enabling-default-setup-takes-too-long.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/enabling-default-setup-takes-too-long.md similarity index 82% rename from content/code-security/code-scanning/troubleshooting-code-scanning/enabling-default-setup-takes-too-long.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/enabling-default-setup-takes-too-long.md index 1eba1d0b2007..e97c40f7b551 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/enabling-default-setup-takes-too-long.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/enabling-default-setup-takes-too-long.md @@ -1,11 +1,14 @@ --- -title: 'Enabling default setup takes too long' -intro: 'If you think that enabling default setup has stalled, you can restart the process.' +title: Enabling default setup takes too long +intro: If you think that enabling default setup has stalled, you can restart the process. allowTitleToDifferFromFilename: true versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/enabling-default-setup-takes-too-long +contentType: how-tos --- diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/extraction-errors-in-the-database.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/extraction-errors-in-the-database.md similarity index 77% rename from content/code-security/code-scanning/troubleshooting-code-scanning/extraction-errors-in-the-database.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/extraction-errors-in-the-database.md index 94520fc66883..37584813d533 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/extraction-errors-in-the-database.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/extraction-errors-in-the-database.md @@ -1,11 +1,14 @@ --- -title: 'Extraction errors in the database' -intro: 'You can check whether or not extraction errors affect the health of the {% data variables.product.prodname_codeql %} database created.' +title: Extraction errors in the database +intro: You can check whether or not extraction errors affect the health of the {% data variables.product.prodname_codeql %} database created. allowTitleToDifferFromFilename: true versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/extraction-errors-in-the-database +contentType: how-tos --- {% data reusables.code-scanning.codeql-action-version-ghes %} diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/fewer-lines-scanned-than-expected.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/fewer-lines-scanned-than-expected.md similarity index 93% rename from content/code-security/code-scanning/troubleshooting-code-scanning/fewer-lines-scanned-than-expected.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/fewer-lines-scanned-than-expected.md index b4f2a84051e6..9a5d70e052b0 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/fewer-lines-scanned-than-expected.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/fewer-lines-scanned-than-expected.md @@ -1,7 +1,7 @@ --- title: CodeQL scanned fewer lines than expected shortTitle: Fewer lines scanned than expected -intro: 'If {% data variables.product.prodname_codeql %} analyzed less code than you expected, you may need to use a custom build command.' +intro: If {% data variables.product.prodname_codeql %} analyzed less code than you expected, you may need to use a custom build command. allowTitleToDifferFromFilename: true versions: fpt: '*' @@ -9,6 +9,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-code-scanning/codeql-scanned-fewer-lines-than-expected + - /code-security/code-scanning/troubleshooting-code-scanning/fewer-lines-scanned-than-expected +contentType: how-tos --- ## About analysis of compiled languages diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/index.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/index.md similarity index 77% rename from content/code-security/code-scanning/troubleshooting-code-scanning/index.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/index.md index ae91122e9735..5da839a58d1b 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/index.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/index.md @@ -1,39 +1,41 @@ --- -title: Troubleshooting code scanning -intro: 'When analyzing your code with {% data variables.product.prodname_code_scanning %}, you may need to troubleshoot unexpected issues.' -redirect_from: - - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-your-default-setup-for-codeql - - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow - - /code-security/code-scanning/troubleshooting-code-scanning/results-differ-between-platforms +title: Troubleshooting analysis errors +shortTitle: Troubleshoot analysis errors +intro: Identify and resolve errors that occur during code analysis, including build failures, incomplete scans, resource limits, and unexpected results. versions: fpt: '*' ghes: '*' ghec: '*' +contentType: how-tos topics: - - Code Security - Code scanning - - CodeQL - - Repositories + - Errors + - Troubleshooting children: - - /advanced-security-must-be-enabled - /alerts-in-generated-code - - /analysis-takes-too-long - /automatic-build-failed - /c-sharp-compiler-unexpectedly-failing - /cannot-enable-codeql-in-a-private-repository - - /enabling-default-setup-takes-too-long - - /extraction-errors-in-the-database + - /analysis-takes-too-long - /fewer-lines-scanned-than-expected - - /logs-not-detailed-enough - - /no-source-code-seen-during-build - - /not-recognized + - /enabling-default-setup-takes-too-long + - /advanced-security-must-be-enabled - /out-of-disk-or-memory - /resource-not-accessible - - /results-different-than-expected + - /not-recognized + - /no-source-code-seen-during-build - /server-error + - /extraction-errors-in-the-database + - /logs-not-detailed-enough + - /results-different-than-expected - /some-languages-not-analyzed - /two-codeql-workflows - /unclear-what-triggered-a-workflow - /unnecessary-step-found - /kotlin-detected-in-no-build +redirect_from: + - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-your-default-setup-for-codeql + - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow + - /code-security/code-scanning/troubleshooting-code-scanning/results-differ-between-platforms + - /code-security/code-scanning/troubleshooting-code-scanning --- diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/kotlin-detected-in-no-build.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/kotlin-detected-in-no-build.md similarity index 97% rename from content/code-security/code-scanning/troubleshooting-code-scanning/kotlin-detected-in-no-build.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/kotlin-detected-in-no-build.md index 7487635f7f66..4efb1cfe7252 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/kotlin-detected-in-no-build.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/kotlin-detected-in-no-build.md @@ -7,6 +7,9 @@ versions: fpt: '*' ghec: '*' ghes: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/kotlin-detected-in-no-build +contentType: how-tos --- ## About this warning diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/logs-not-detailed-enough.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/logs-not-detailed-enough.md similarity index 94% rename from content/code-security/code-scanning/troubleshooting-code-scanning/logs-not-detailed-enough.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/logs-not-detailed-enough.md index 45d2c4d745f8..626786215c39 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/logs-not-detailed-enough.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/logs-not-detailed-enough.md @@ -1,7 +1,7 @@ --- title: Logs are not detailed enough shortTitle: Logs not detailed enough -intro: 'If you''d like to increase the level of detail in your logs, try these steps.' +intro: If you'd like to increase the level of detail in your logs, try these steps. allowTitleToDifferFromFilename: true versions: fpt: '*' @@ -9,6 +9,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-code-scanning/logs-are-not-detailed-enough + - /code-security/code-scanning/troubleshooting-code-scanning/logs-not-detailed-enough +contentType: how-tos --- If your logs are not detailed enough, there are several steps you can take to make them more useful. diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/no-source-code-seen-during-build.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/no-source-code-seen-during-build.md similarity index 93% rename from content/code-security/code-scanning/troubleshooting-code-scanning/no-source-code-seen-during-build.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/no-source-code-seen-during-build.md index 6602a72d7950..0a73b21bda3b 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/no-source-code-seen-during-build.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/no-source-code-seen-during-build.md @@ -1,12 +1,15 @@ --- title: 'Error: "No source code was seen during the build"' -shortTitle: 'No source code seen during build' -intro: 'When {% data variables.product.prodname_codeql %} fails to find any source code, you need to resolve this problem to unblock {% data variables.product.prodname_code_scanning %} analysis.' +shortTitle: No source code seen during build +intro: When {% data variables.product.prodname_codeql %} fails to find any source code, you need to resolve this problem to unblock {% data variables.product.prodname_code_scanning %} analysis. allowTitleToDifferFromFilename: true versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/no-source-code-seen-during-build +contentType: how-tos --- diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/not-recognized.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/not-recognized.md similarity index 89% rename from content/code-security/code-scanning/troubleshooting-code-scanning/not-recognized.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/not-recognized.md index 6506bd4cdba7..a88ae160b1e0 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/not-recognized.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/not-recognized.md @@ -7,6 +7,9 @@ versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/not-recognized +contentType: how-tos --- ## About this error diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/out-of-disk-or-memory.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/out-of-disk-or-memory.md similarity index 85% rename from content/code-security/code-scanning/troubleshooting-code-scanning/out-of-disk-or-memory.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/out-of-disk-or-memory.md index 25047ffa4632..9b802a862b34 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/out-of-disk-or-memory.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/out-of-disk-or-memory.md @@ -1,12 +1,15 @@ --- title: 'Error: "Out of disk" or Error: "Out of memory"' -shortTitle: 'Out of disk or memory' -intro: 'If you see one of these errors with {% data variables.product.prodname_actions %}, {% ifversion ghes %}try reviewing the specifications of your self-hosted runners.{% else %}you can try alternative runners.{% endif %}' +shortTitle: Out of disk or memory +intro: If you see one of these errors with {% data variables.product.prodname_actions %}, {% ifversion ghes %}try reviewing the specifications of your self-hosted runners.{% else %}you can try alternative runners.{% endif %} allowTitleToDifferFromFilename: true versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/out-of-disk-or-memory +contentType: how-tos --- diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/resource-not-accessible.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/resource-not-accessible.md similarity index 93% rename from content/code-security/code-scanning/troubleshooting-code-scanning/resource-not-accessible.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/resource-not-accessible.md index f01dfcb46087..3a14bb7db0d8 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/resource-not-accessible.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/resource-not-accessible.md @@ -1,13 +1,15 @@ --- title: 'Error: 403 "Resource not accessible by integration"' shortTitle: Resource not accessible -intro: 'This error may be seen on pull requests created by {% data variables.product.prodname_dependabot %} and can be resolved in a couple of different ways.' +intro: This error may be seen on pull requests created by {% data variables.product.prodname_dependabot %} and can be resolved in a couple of different ways. allowTitleToDifferFromFilename: true versions: fpt: '*' ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-code-scanning/resource-not-accessible-by-integration + - /code-security/code-scanning/troubleshooting-code-scanning/resource-not-accessible +contentType: how-tos --- >[!NOTE] diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/results-different-than-expected.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/results-different-than-expected.md similarity index 88% rename from content/code-security/code-scanning/troubleshooting-code-scanning/results-different-than-expected.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/results-different-than-expected.md index a0dc68b961fa..09ecc303275b 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/results-different-than-expected.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/results-different-than-expected.md @@ -1,7 +1,7 @@ --- title: Results are different than expected shortTitle: Results different than expected -intro: 'If your {% data variables.product.prodname_code_scanning %} results are different than you expected, you can check which configurations are active.' +intro: If your {% data variables.product.prodname_code_scanning %} results are different than you expected, you can check which configurations are active. allowTitleToDifferFromFilename: true versions: fpt: '*' @@ -9,6 +9,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-code-scanning/results-are-different-than-expected + - /code-security/code-scanning/troubleshooting-code-scanning/results-different-than-expected +contentType: how-tos --- If your {% data variables.product.prodname_code_scanning %} results are different than you expected, you may have both default and advanced setup configured for your repository. When you enable default setup, this disables the existing {% data variables.product.prodname_codeql %} workflow file and blocks any {% data variables.product.prodname_codeql %} API analysis from uploading results. diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/server-error.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/server-error.md similarity index 66% rename from content/code-security/code-scanning/troubleshooting-code-scanning/server-error.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/server-error.md index 06f6870360b9..baf62d881ade 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/server-error.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/server-error.md @@ -1,11 +1,14 @@ --- title: 'Error: "Server error"' -shortTitle: 'Server error' -intro: 'If you see this error, it may be transient. Check the current {% data variables.product.prodname_actions %} service status, and try running your workflow again.' +shortTitle: Server error +intro: If you see this error, it may be transient. Check the current {% data variables.product.prodname_actions %} service status, and try running your workflow again. allowTitleToDifferFromFilename: true versions: fpt: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/server-error +contentType: how-tos --- ## About this error diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/some-languages-not-analyzed.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/some-languages-not-analyzed.md similarity index 86% rename from content/code-security/code-scanning/troubleshooting-code-scanning/some-languages-not-analyzed.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/some-languages-not-analyzed.md index 4a3fa689b9d8..847a292fecba 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/some-languages-not-analyzed.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/some-languages-not-analyzed.md @@ -2,13 +2,15 @@ title: Some languages were not analyzed with CodeQL advanced setup shortTitle: Some languages not analyzed allowTitleToDifferFromFilename: true -intro: 'If some languages were not analyzed, you can modify your {% data variables.product.prodname_code_scanning %} workflow to add a matrix specifying the languages you want to analyze.' +intro: If some languages were not analyzed, you can modify your {% data variables.product.prodname_code_scanning %} workflow to add a matrix specifying the languages you want to analyze. versions: fpt: '*' ghes: '*' ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-code-scanning/some-languages-were-not-analyzed + - /code-security/code-scanning/troubleshooting-code-scanning/some-languages-not-analyzed +contentType: how-tos --- {% data reusables.code-scanning.codeql-action-version-ghes %} diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/two-codeql-workflows.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/two-codeql-workflows.md similarity index 75% rename from content/code-security/code-scanning/troubleshooting-code-scanning/two-codeql-workflows.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/two-codeql-workflows.md index 7fd41f4e0b02..4f81958430fa 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/two-codeql-workflows.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/two-codeql-workflows.md @@ -1,11 +1,14 @@ --- -title: 'Two CodeQL workflows' +title: Two CodeQL workflows allowTitleToDifferFromFilename: true -intro: 'If you see two workflows named "{% data variables.product.prodname_codeql %}", one workflow may be a pre-existing {% data variables.product.prodname_codeql %} workflow file which has been disabled by default setup.' +intro: If you see two workflows named "{% data variables.product.prodname_codeql %}", one workflow may be a pre-existing {% data variables.product.prodname_codeql %} workflow file which has been disabled by default setup. versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/two-codeql-workflows +contentType: how-tos --- {% data reusables.code-scanning.codeql-action-version-ghes %} diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/unclear-what-triggered-a-workflow.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/unclear-what-triggered-a-workflow.md similarity index 82% rename from content/code-security/code-scanning/troubleshooting-code-scanning/unclear-what-triggered-a-workflow.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/unclear-what-triggered-a-workflow.md index 71ec314ac42c..c8552d188332 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/unclear-what-triggered-a-workflow.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/unclear-what-triggered-a-workflow.md @@ -1,7 +1,7 @@ --- title: Unclear what triggered a workflow run shortTitle: Unclear what triggered a workflow -intro: 'If you don''t know what triggered an analysis, investigate the {% data variables.code-scanning.tool_status_page %} or look at the log for the last scan.' +intro: If you don't know what triggered an analysis, investigate the {% data variables.code-scanning.tool_status_page %} or look at the log for the last scan. allowTitleToDifferFromFilename: true versions: fpt: '*' @@ -9,6 +9,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-code-scanning/unclear-what-triggered-a-workflow-run + - /code-security/code-scanning/troubleshooting-code-scanning/unclear-what-triggered-a-workflow +contentType: how-tos --- The {% data variables.code-scanning.tool_status_page %} shows you how well {% data variables.product.prodname_code_scanning %} tools are working for a repository, when files in the repository were first scanned and most recently scanned, and when scans are scheduled. For integrated tools like {% data variables.product.prodname_codeql %}, you can also see more detailed information, including a percentage of files scanned and specific error messages. For more information about the {% data variables.code-scanning.tool_status_page %}, see [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/about-the-tool-status-page). diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/unnecessary-step-found.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/unnecessary-step-found.md similarity index 89% rename from content/code-security/code-scanning/troubleshooting-code-scanning/unnecessary-step-found.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/unnecessary-step-found.md index 015173768f81..854ce9c6b6c6 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/unnecessary-step-found.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/unnecessary-step-found.md @@ -1,12 +1,15 @@ --- title: 'Warning: "1 issue was detected with this workflow: git checkout HEAD^2 is no longer necessary"' -shortTitle: 'Unnecessary step found' -intro: 'If you see this warning, you should update your workflow to follow current best practice.' +shortTitle: Unnecessary step found +intro: If you see this warning, you should update your workflow to follow current best practice. allowTitleToDifferFromFilename: true versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/unnecessary-step-found +contentType: how-tos --- ## About this warning diff --git a/content/code-security/code-scanning/troubleshooting-sarif-uploads/default-setup-enabled.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/default-setup-enabled.md similarity index 82% rename from content/code-security/code-scanning/troubleshooting-sarif-uploads/default-setup-enabled.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/default-setup-enabled.md index 4af686973052..30bd30e1c4c5 100644 --- a/content/code-security/code-scanning/troubleshooting-sarif-uploads/default-setup-enabled.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/default-setup-enabled.md @@ -1,9 +1,8 @@ --- -title: 'Upload was rejected because CodeQL default setup is enabled for {% data variables.product.prodname_code_scanning %}' +title: Upload was rejected because CodeQL default setup is enabled for {% data variables.product.prodname_code_scanning %} shortTitle: Default setup is enabled allowTitleToDifferFromFilename: true -intro: 'You cannot upload SARIF results generated by the {% data variables.product.prodname_codeql %} action or {% data variables.product.prodname_codeql %} CLI when default setup for {% data variables.product.prodname_code_scanning %} is enabled. Check your configuration and decide whether to keep default setup or unblock SARIF upload.' -type: reference +intro: You cannot upload SARIF results generated by the {% data variables.product.prodname_codeql %} action or {% data variables.product.prodname_codeql %} CLI when default setup for {% data variables.product.prodname_code_scanning %} is enabled. Check your configuration and decide whether to keep default setup or unblock SARIF upload. topics: - Code scanning - Errors @@ -15,6 +14,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-sarif/default-setup-enabled + - /code-security/code-scanning/troubleshooting-sarif-uploads/default-setup-enabled +contentType: how-tos --- ## About this error diff --git a/content/code-security/code-scanning/troubleshooting-sarif-uploads/file-too-large.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/file-too-large.md similarity index 96% rename from content/code-security/code-scanning/troubleshooting-sarif-uploads/file-too-large.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/file-too-large.md index a1854f8ebaf9..dc586bc5fdc2 100644 --- a/content/code-security/code-scanning/troubleshooting-sarif-uploads/file-too-large.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/file-too-large.md @@ -1,9 +1,8 @@ --- -title: 'SARIF results file is too large' +title: SARIF results file is too large shortTitle: Results file too large allowTitleToDifferFromFilename: true -intro: 'You cannot upload a SARIF results file larger than 10 MB to {% data variables.product.prodname_code_scanning %}. Explore ways to generate a smaller file containing the highest impact results.' -type: reference +intro: You cannot upload a SARIF results file larger than 10 MB to {% data variables.product.prodname_code_scanning %}. Explore ways to generate a smaller file containing the highest impact results. topics: - Code scanning - Errors @@ -15,6 +14,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-sarif/file-too-large + - /code-security/code-scanning/troubleshooting-sarif-uploads/file-too-large +contentType: how-tos --- ## About this error diff --git a/content/code-security/code-scanning/troubleshooting-sarif-uploads/ghas-required.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/ghas-required.md similarity index 77% rename from content/code-security/code-scanning/troubleshooting-sarif-uploads/ghas-required.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/ghas-required.md index 20170e188764..d916b181dad6 100644 --- a/content/code-security/code-scanning/troubleshooting-sarif-uploads/ghas-required.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/ghas-required.md @@ -1,9 +1,8 @@ --- -title: 'Upload fails because {% data variables.product.prodname_GH_code_security %} is disabled' +title: Upload fails because {% data variables.product.prodname_GH_code_security %} is disabled shortTitle: '{% data variables.product.prodname_GH_code_security %} disabled' allowTitleToDifferFromFilename: true -intro: 'You can only upload SARIF results to {% ifversion fpt or ghec %}private or internal {% endif %}repositories where {% data variables.product.prodname_GH_code_security %} is enabled.' -type: reference +intro: You can only upload SARIF results to {% ifversion fpt or ghec %}private or internal {% endif %}repositories where {% data variables.product.prodname_GH_code_security %} is enabled. topics: - Code scanning - Errors @@ -15,6 +14,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-sarif/ghas-required + - /code-security/code-scanning/troubleshooting-sarif-uploads/ghas-required +contentType: how-tos --- ## About this error diff --git a/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/index.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/index.md new file mode 100644 index 000000000000..8205a9eeada5 --- /dev/null +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/index.md @@ -0,0 +1,22 @@ +--- +title: Troubleshooting SARIF uploads +shortTitle: Troubleshoot SARIF uploads +intro: Identify and resolve issues when uploading SARIF files, including authentication problems, file validation errors, and upload limits. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +topics: + - Code scanning + - Errors + - SARIF + - Troubleshooting +children: + - /missing-token + - /sarif-invalid + - /results-exceed-limit + - /file-too-large + - /ghas-required + - /default-setup-enabled +--- diff --git a/content/code-security/code-scanning/troubleshooting-sarif-uploads/missing-token.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/missing-token.md similarity index 86% rename from content/code-security/code-scanning/troubleshooting-sarif-uploads/missing-token.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/missing-token.md index 80c7951c63ef..bcd4a7abbee2 100644 --- a/content/code-security/code-scanning/troubleshooting-sarif-uploads/missing-token.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/missing-token.md @@ -1,9 +1,8 @@ --- -title: 'GitHub token is required to upload SARIF results' +title: GitHub token is required to upload SARIF results shortTitle: GitHub token missing allowTitleToDifferFromFilename: true -intro: 'You need to provide an authentication method for the upload process to use to access the repository.' -type: reference +intro: You need to provide an authentication method for the upload process to use to access the repository. topics: - Code scanning - Errors @@ -15,6 +14,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-sarif/missing-token + - /code-security/code-scanning/troubleshooting-sarif-uploads/missing-token +contentType: how-tos --- ## About this error diff --git a/content/code-security/code-scanning/troubleshooting-sarif-uploads/results-exceed-limit.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/results-exceed-limit.md similarity index 96% rename from content/code-security/code-scanning/troubleshooting-sarif-uploads/results-exceed-limit.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/results-exceed-limit.md index a1b4c8505f1d..bea39feb7005 100644 --- a/content/code-security/code-scanning/troubleshooting-sarif-uploads/results-exceed-limit.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/results-exceed-limit.md @@ -1,9 +1,8 @@ --- -title: 'SARIF results exceed one or more limits' +title: SARIF results exceed one or more limits shortTitle: Results exceed limits allowTitleToDifferFromFilename: true -intro: 'Learn how to resolve problems when a SARIF file is rejected by {% data variables.product.prodname_code_scanning %} because one or more limits is exceeded.' -type: reference +intro: Learn how to resolve problems when a SARIF file is rejected by {% data variables.product.prodname_code_scanning %} because one or more limits is exceeded. topics: - Code scanning - Errors @@ -15,6 +14,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-sarif/results-exceed-limit + - /code-security/code-scanning/troubleshooting-sarif-uploads/results-exceed-limit +contentType: how-tos --- ## About {% data variables.product.prodname_code_scanning %} limits on SARIF results diff --git a/content/code-security/code-scanning/troubleshooting-sarif-uploads/sarif-invalid.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/sarif-invalid.md similarity index 92% rename from content/code-security/code-scanning/troubleshooting-sarif-uploads/sarif-invalid.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/sarif-invalid.md index 24f668112f4b..155b212be343 100644 --- a/content/code-security/code-scanning/troubleshooting-sarif-uploads/sarif-invalid.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/sarif-invalid.md @@ -1,9 +1,8 @@ --- -title: 'SARIF file is invalid' +title: SARIF file is invalid shortTitle: SARIF file invalid allowTitleToDifferFromFilename: true intro: '{% data variables.product.prodname_code_scanning_caps %} can only process syntactically valid SARIF files. Invalid files are rejected.' -type: reference topics: - Code scanning - Errors @@ -15,6 +14,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-sarif/sarif-invalid + - /code-security/code-scanning/troubleshooting-sarif-uploads/sarif-invalid +contentType: how-tos --- ## About this error diff --git a/content/code-security/index.md b/content/code-security/index.md index 355c1a27eda6..a9a1cbedf882 100644 --- a/content/code-security/index.md +++ b/content/code-security/index.md @@ -13,11 +13,11 @@ featuredLinks: - /code-security/getting-started/quickstart-for-securing-your-repository - '{% ifversion ghes %}/code-security/secret-scanning/working-with-secret-scanning-and-push-protection{% endif %}' - /code-security/getting-started/dependabot-quickstart-guide - - /code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning + - /code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/configuring-default-setup-for-code-scanning guideCards: - /code-security/trialing-github-advanced-security/planning-a-trial-of-ghas - /code-security/secret-scanning/enabling-secret-scanning-features - - /code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning + - /code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/configuring-default-setup-for-code-scanning - /code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-security-updates - /code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-version-updates popular: diff --git a/data/learning-tracks/code-security.yml b/data/learning-tracks/code-security.yml index 08c895afca99..02f0211c7c60 100644 --- a/data/learning-tracks/code-security.yml +++ b/data/learning-tracks/code-security.yml @@ -188,16 +188,16 @@ code_security_actions: - >- /code-security/concepts/code-scanning/about-code-scanning - >- - /code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning + /code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/configuring-default-setup-for-code-scanning - >- - /code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning + /code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/customizing-your-advanced-setup-for-code-scanning - >- - /code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages + /code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/codeql-code-scanning-for-compiled-languages - >- /code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/running-codeql-code-scanning-in-a-container - - /code-security/code-scanning/troubleshooting-code-scanning + - /code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors - >- - /code-security/code-scanning/managing-your-code-scanning-configuration/about-the-tool-status-page + /code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/about-the-tool-status-page code_security_integration: title: Integrate with code scanning description: Upload code analysis results from third-party systems to GitHub using SARIF. @@ -205,7 +205,7 @@ code_security_integration: - >- /code-security/concepts/code-scanning/about-integration-with-code-scanning - >- - /code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github + /code-security/how-tos/scan-code-for-vulnerabilities/integrate-with-existing-tools/uploading-a-sarif-file-to-github - >- /code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning - /rest/code-scanning diff --git a/src/redirects/lib/static/redirect-exceptions.txt b/src/redirects/lib/static/redirect-exceptions.txt index 400f978751ef..9f7a56931291 100644 --- a/src/redirects/lib/static/redirect-exceptions.txt +++ b/src/redirects/lib/static/redirect-exceptions.txt @@ -36,9 +36,6 @@ /enterprise-server@3.6/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning - /enterprise-server@3.6/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-for-a-repository -/enterprise-cloud@latest/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning -- /enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-for-a-repository - # As seen in PR 48753 we are restructuring the copilot docs and removing the overview category /copilot/get-started - /copilot/overview-of-github-copilot From e38c14dbb56639437b23a61f3cc97d3f45a22c18 Mon Sep 17 00:00:00 2001 From: Melanie Yarbrough <11952755+myarb@users.noreply.github.com> Date: Tue, 13 Jan 2026 08:14:07 -0500 Subject: [PATCH 2/7] [EDI] Move "Secret scanning partner program" into "Tutorials" (#59096) --- .../secret-scanning-partnership-program/index.md | 4 +--- content/code-security/tutorials/index.md | 6 ++++-- .../secret-scanning-partner-program.md | 4 +++- 3 files changed, 8 insertions(+), 6 deletions(-) rename content/code-security/{secret-scanning/secret-scanning-partnership-program => tutorials}/secret-scanning-partner-program.md (97%) diff --git a/content/code-security/secret-scanning/secret-scanning-partnership-program/index.md b/content/code-security/secret-scanning/secret-scanning-partnership-program/index.md index cdf66c1e9353..78ca972e3b24 100644 --- a/content/code-security/secret-scanning/secret-scanning-partnership-program/index.md +++ b/content/code-security/secret-scanning/secret-scanning-partnership-program/index.md @@ -1,13 +1,11 @@ --- title: Secret scanning partnership program -intro: 'As a service provider, you can partner with {% data variables.product.prodname_dotcom %} to have your secret token formats secured through secret scanning, which searches for accidental commits of your secret format and can be sent to a service provider''s verify endpoint.' +intro: As a service provider, you can partner with {% data variables.product.prodname_dotcom %} to have your secret token formats secured through secret scanning, which searches for accidental commits of your secret format and can be sent to a service provider's verify endpoint. versions: fpt: '*' ghec: '*' topics: - API shortTitle: Partner program -children: - - /secret-scanning-partner-program --- diff --git a/content/code-security/tutorials/index.md b/content/code-security/tutorials/index.md index 53dd8790c718..33ec2b1d6f6b 100644 --- a/content/code-security/tutorials/index.md +++ b/content/code-security/tutorials/index.md @@ -16,11 +16,13 @@ topics: - Dependabot contentType: tutorials children: - - secure-your-organization - - remediate-leaked-secrets - trialing-github-advanced-security - adopting-github-advanced-security-at-scale + - secure-your-organization + - remediate-leaked-secrets + - secret-scanning-partner-program - manage-security-alerts - improve-code-quality - fix-reported-vulnerabilities --- + diff --git a/content/code-security/secret-scanning/secret-scanning-partnership-program/secret-scanning-partner-program.md b/content/code-security/tutorials/secret-scanning-partner-program.md similarity index 97% rename from content/code-security/secret-scanning/secret-scanning-partnership-program/secret-scanning-partner-program.md rename to content/code-security/tutorials/secret-scanning-partner-program.md index 92cddfced8cf..56d627aba7e0 100644 --- a/content/code-security/secret-scanning/secret-scanning-partnership-program/secret-scanning-partner-program.md +++ b/content/code-security/tutorials/secret-scanning-partner-program.md @@ -1,6 +1,6 @@ --- title: Secret scanning partner program -intro: 'As a service provider, you can partner with {% data variables.product.prodname_dotcom %} to have your secret token formats secured through secret scanning, which searches for accidental commits of your secret format and can be sent to a service provider''s verify endpoint.' +intro: As a service provider, you can partner with {% data variables.product.prodname_dotcom %} to have your secret token formats secured through secret scanning, which searches for accidental commits of your secret format and can be sent to a service provider's verify endpoint. product: '{% data reusables.gated-features.secret-scanning-partner-alerts %}' redirect_from: - /partnerships/token-scanning @@ -8,6 +8,7 @@ redirect_from: - /developers/overview/secret-scanning - /developers/overview/secret-scanning-partner-program - /code-security/secret-scanning/secret-scanning-partner-program + - /code-security/secret-scanning/secret-scanning-partnership-program/secret-scanning-partner-program versions: fpt: '*' ghec: '*' @@ -16,6 +17,7 @@ topics: - Secret scanning - Secret Protection shortTitle: Partner program +contentType: tutorials --- {% data variables.product.prodname_dotcom %} scans repositories for known secret formats to prevent fraudulent use of credentials that were committed accidentally. {% data variables.product.prodname_secret_scanning_caps %} happens by default on public repositories and public npm packages. Repository administrators and organization owners can also enable {% data variables.product.prodname_secret_scanning %} on private repositories. As a service provider, you can partner with {% data variables.product.prodname_dotcom %} so that your secret formats are included in our {% data variables.product.prodname_secret_scanning %}. From 1c1dba0ced1f4ac7a27c4da747640a5663186791 Mon Sep 17 00:00:00 2001 From: Felix Guntrip Date: Tue, 13 Jan 2026 13:47:13 +0000 Subject: [PATCH 3/7] Update recommended versions for GHE and runners (#59117) --- content/admin/all-releases.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/admin/all-releases.md b/content/admin/all-releases.md index 84adf08b7f67..0c46179962e7 100644 --- a/content/admin/all-releases.md +++ b/content/admin/all-releases.md @@ -58,6 +58,7 @@ If you run analysis in an external CI system, we recommend using the same versio | {% data variables.product.prodname_ghe_server %} version | Recommended {% data variables.product.prodname_codeql_cli %} version | | ------------------------------------------------- | ---------------------- | +| 3.19 | 2.22.4 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.22.4/)) | | 3.18 | 2.21.4 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.21.4/)) | | 3.17 | 2.20.7 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.20.7/)) | | 3.16 | 2.20.3 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.20.3/)) | @@ -78,6 +79,7 @@ For instances with {% data variables.product.prodname_actions %} enabled, self-h | {% data variables.product.prodname_ghe_server %} version | Minimum Runner version | | ------------------------------------------------- | ---------------------- | +| 3.19 | 2.328.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.328.0)) | | 3.18 | 2.324.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.324.0)) | | 3.17 | 2.322.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.322.0)) | | 3.16 | 2.321.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.321.0)) | From 435d76b3a714b6d3f602dff9d90496b24d5eb653 Mon Sep 17 00:00:00 2001 From: Sophie <29382425+sophietheking@users.noreply.github.com> Date: Tue, 13 Jan 2026 14:47:28 +0100 Subject: [PATCH 4/7] [EDI] Create a new "Customize code scanning" map topic within "Tutorials" (#59119) --- .../index.md | 1 - .../index.md | 22 ------------------ content/code-security/codeql-cli/index.md | 1 - .../index.md | 4 ---- .../scan-from-the-command-line/index.md | 3 +++ ...analyzing-your-code-with-codeql-queries.md | 4 +++- .../creating-and-working-with-codeql-packs.md | 4 +++- .../creating-codeql-query-suites.md | 4 +++- .../customizing-analysis-with-codeql-packs.md | 4 +++- .../customize-code-scanning/index.md | 23 +++++++++++++++++++ ...preparing-your-code-for-codeql-analysis.md | 4 +++- .../publishing-and-using-codeql-packs.md | 4 +++- ...ing-codeql-code-scanning-in-a-container.md | 4 +++- .../testing-custom-queries.md | 4 +++- ...ading-codeql-analysis-results-to-github.md | 5 +++- content/code-security/tutorials/index.md | 18 +++++++-------- data/learning-tracks/code-security.yml | 2 +- 17 files changed, 64 insertions(+), 47 deletions(-) delete mode 100644 content/code-security/codeql-cli/getting-started-with-the-codeql-cli/index.md rename content/code-security/{codeql-cli/getting-started-with-the-codeql-cli => tutorials/customize-code-scanning}/analyzing-your-code-with-codeql-queries.md (98%) rename content/code-security/{codeql-cli/using-the-advanced-functionality-of-the-codeql-cli => tutorials/customize-code-scanning}/creating-and-working-with-codeql-packs.md (97%) rename content/code-security/{codeql-cli/using-the-advanced-functionality-of-the-codeql-cli => tutorials/customize-code-scanning}/creating-codeql-query-suites.md (98%) rename content/code-security/{codeql-cli/getting-started-with-the-codeql-cli => tutorials/customize-code-scanning}/customizing-analysis-with-codeql-packs.md (97%) create mode 100644 content/code-security/tutorials/customize-code-scanning/index.md rename content/code-security/{codeql-cli/getting-started-with-the-codeql-cli => tutorials/customize-code-scanning}/preparing-your-code-for-codeql-analysis.md (99%) rename content/code-security/{codeql-cli/using-the-advanced-functionality-of-the-codeql-cli => tutorials/customize-code-scanning}/publishing-and-using-codeql-packs.md (99%) rename content/code-security/{code-scanning/creating-an-advanced-setup-for-code-scanning => tutorials/customize-code-scanning}/running-codeql-code-scanning-in-a-container.md (94%) rename content/code-security/{codeql-cli/using-the-advanced-functionality-of-the-codeql-cli => tutorials/customize-code-scanning}/testing-custom-queries.md (97%) rename content/code-security/{codeql-cli/getting-started-with-the-codeql-cli => tutorials/customize-code-scanning}/uploading-codeql-analysis-results-to-github.md (97%) diff --git a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/index.md b/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/index.md index e49f07ca4534..2a31016af22b 100644 --- a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/index.md +++ b/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/index.md @@ -12,5 +12,4 @@ topics: - Code scanning children: - /recommended-hardware-resources-for-running-codeql - - /running-codeql-code-scanning-in-a-container --- diff --git a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/index.md b/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/index.md deleted file mode 100644 index 5508b657c897..000000000000 --- a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Getting started with the CodeQL CLI -intro: You can use the {% data variables.product.prodname_codeql_cli %} to locally develop, test and run {% data variables.product.prodname_codeql %} queries on software projects. -shortTitle: Getting started -product: '{% data reusables.gated-features.codeql %}' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Code Security - - Code scanning - - CodeQL -children: - - /preparing-your-code-for-codeql-analysis - - /analyzing-your-code-with-codeql-queries - - /uploading-codeql-analysis-results-to-github - - /customizing-analysis-with-codeql-packs -redirect_from: - - /code-security/codeql-cli/using-the-codeql-cli ---- - diff --git a/content/code-security/codeql-cli/index.md b/content/code-security/codeql-cli/index.md index 5838d18c1dd8..863c4f75a853 100644 --- a/content/code-security/codeql-cli/index.md +++ b/content/code-security/codeql-cli/index.md @@ -13,7 +13,6 @@ topics: - Code scanning - CodeQL children: - - /getting-started-with-the-codeql-cli - /using-the-advanced-functionality-of-the-codeql-cli - /codeql-cli-manual --- diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/index.md b/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/index.md index 06b78fed5999..06ccf91b3767 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/index.md +++ b/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/index.md @@ -12,10 +12,6 @@ topics: - Code scanning - CodeQL children: - - /creating-codeql-query-suites - - /testing-custom-queries - - /creating-and-working-with-codeql-packs - - /publishing-and-using-codeql-packs - /sarif-output - /csv-output - /extractor-options diff --git a/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/index.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/index.md index 0114db6b0fff..38b7dae7cb2e 100644 --- a/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/index.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/index.md @@ -17,4 +17,7 @@ children: - /testing-query-help-files - /specifying-command-options-in-a-codeql-configuration-file - /creating-database-bundle-for-troubleshooting +redirect_from: + - /code-security/codeql-cli/using-the-codeql-cli + - /code-security/codeql-cli/getting-started-with-the-codeql-cli --- diff --git a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/analyzing-your-code-with-codeql-queries.md b/content/code-security/tutorials/customize-code-scanning/analyzing-your-code-with-codeql-queries.md similarity index 98% rename from content/code-security/codeql-cli/getting-started-with-the-codeql-cli/analyzing-your-code-with-codeql-queries.md rename to content/code-security/tutorials/customize-code-scanning/analyzing-your-code-with-codeql-queries.md index d93491335667..8df772412566 100644 --- a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/analyzing-your-code-with-codeql-queries.md +++ b/content/code-security/tutorials/customize-code-scanning/analyzing-your-code-with-codeql-queries.md @@ -1,6 +1,6 @@ --- title: Analyzing your code with CodeQL queries -intro: 'You can run queries against a {% data variables.product.prodname_codeql %} database extracted from a codebase.' +intro: You can run queries against a {% data variables.product.prodname_codeql %} database extracted from a codebase. product: '{% data reusables.gated-features.codeql %}' shortTitle: Analyzing code versions: @@ -14,6 +14,8 @@ topics: redirect_from: - /code-security/codeql-cli/analyzing-databases-with-the-codeql-cli - /code-security/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli + - /code-security/codeql-cli/getting-started-with-the-codeql-cli/analyzing-your-code-with-codeql-queries +contentType: tutorials --- ## About analyzing databases with the {% data variables.product.prodname_codeql_cli %} diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-and-working-with-codeql-packs.md b/content/code-security/tutorials/customize-code-scanning/creating-and-working-with-codeql-packs.md similarity index 97% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-and-working-with-codeql-packs.md rename to content/code-security/tutorials/customize-code-scanning/creating-and-working-with-codeql-packs.md index 40f61d290d41..95083cf19990 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-and-working-with-codeql-packs.md +++ b/content/code-security/tutorials/customize-code-scanning/creating-and-working-with-codeql-packs.md @@ -1,6 +1,6 @@ --- title: Creating and working with CodeQL packs -intro: 'You can use {% data variables.product.prodname_codeql %} packs to create, share, depend on, and run {% data variables.product.prodname_codeql %} queries and libraries.' +intro: You can use {% data variables.product.prodname_codeql %} packs to create, share, depend on, and run {% data variables.product.prodname_codeql %} queries and libraries. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -13,6 +13,8 @@ topics: redirect_from: - /code-security/codeql-cli/creating-and-working-with-codeql-packs - /code-security/codeql-cli/using-the-codeql-cli/creating-and-working-with-codeql-packs + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-and-working-with-codeql-packs +contentType: tutorials --- ## About {% data variables.product.prodname_codeql %} packs and the {% data variables.product.prodname_codeql_cli %} diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-codeql-query-suites.md b/content/code-security/tutorials/customize-code-scanning/creating-codeql-query-suites.md similarity index 98% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-codeql-query-suites.md rename to content/code-security/tutorials/customize-code-scanning/creating-codeql-query-suites.md index 61ade5aa67be..e6fcd9cdf3e4 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-codeql-query-suites.md +++ b/content/code-security/tutorials/customize-code-scanning/creating-codeql-query-suites.md @@ -1,6 +1,6 @@ --- title: Creating CodeQL query suites -intro: 'You can create query suites for queries you frequently use in your {% data variables.product.prodname_codeql %} analyses.' +intro: You can create query suites for queries you frequently use in your {% data variables.product.prodname_codeql %} analyses. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -13,6 +13,8 @@ topics: redirect_from: - /code-security/codeql-cli/creating-codeql-query-suites - /code-security/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-codeql-query-suites +contentType: tutorials --- ## About creating {% data variables.product.prodname_codeql %} query suites diff --git a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/customizing-analysis-with-codeql-packs.md b/content/code-security/tutorials/customize-code-scanning/customizing-analysis-with-codeql-packs.md similarity index 97% rename from content/code-security/codeql-cli/getting-started-with-the-codeql-cli/customizing-analysis-with-codeql-packs.md rename to content/code-security/tutorials/customize-code-scanning/customizing-analysis-with-codeql-packs.md index 94f4b969366c..63c8bdb91b64 100644 --- a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/customizing-analysis-with-codeql-packs.md +++ b/content/code-security/tutorials/customize-code-scanning/customizing-analysis-with-codeql-packs.md @@ -1,6 +1,6 @@ --- title: Customizing analysis with CodeQL packs -intro: 'You can use {% data variables.product.prodname_codeql %} packs to run {% data variables.product.prodname_codeql %} queries maintained by other people, or to share {% data variables.product.prodname_codeql %} queries that you''ve developed.' +intro: You can use {% data variables.product.prodname_codeql %} packs to run {% data variables.product.prodname_codeql %} queries maintained by other people, or to share {% data variables.product.prodname_codeql %} queries that you've developed. shortTitle: Customizing analysis product: '{% data reusables.gated-features.codeql %}' versions: @@ -14,6 +14,8 @@ topics: redirect_from: - /code-security/codeql-cli/about-codeql-packs - /code-security/codeql-cli/codeql-cli-reference/about-codeql-packs + - /code-security/codeql-cli/getting-started-with-the-codeql-cli/customizing-analysis-with-codeql-packs +contentType: tutorials --- ## About {% data variables.product.prodname_codeql %} packs diff --git a/content/code-security/tutorials/customize-code-scanning/index.md b/content/code-security/tutorials/customize-code-scanning/index.md new file mode 100644 index 000000000000..17a12f1d3a79 --- /dev/null +++ b/content/code-security/tutorials/customize-code-scanning/index.md @@ -0,0 +1,23 @@ +--- +title: Customize code scanning +intro: Learn how to customize code scanning to meet your project's unique security needs by creating and using CodeQL packs and custom queries. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Code Security + - Code scanning + - CodeQL +contentType: tutorials +children: + - /preparing-your-code-for-codeql-analysis + - /analyzing-your-code-with-codeql-queries + - /uploading-codeql-analysis-results-to-github + - /running-codeql-code-scanning-in-a-container + - /customizing-analysis-with-codeql-packs + - /creating-codeql-query-suites + - /testing-custom-queries + - /creating-and-working-with-codeql-packs + - /publishing-and-using-codeql-packs +--- diff --git a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/preparing-your-code-for-codeql-analysis.md b/content/code-security/tutorials/customize-code-scanning/preparing-your-code-for-codeql-analysis.md similarity index 99% rename from content/code-security/codeql-cli/getting-started-with-the-codeql-cli/preparing-your-code-for-codeql-analysis.md rename to content/code-security/tutorials/customize-code-scanning/preparing-your-code-for-codeql-analysis.md index 39d3a7e08239..1d94a6f999d7 100644 --- a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/preparing-your-code-for-codeql-analysis.md +++ b/content/code-security/tutorials/customize-code-scanning/preparing-your-code-for-codeql-analysis.md @@ -1,6 +1,6 @@ --- title: Preparing your code for CodeQL analysis -intro: 'You can build a {% data variables.product.prodname_codeql %} database containing the data needed to analyze your code.' +intro: You can build a {% data variables.product.prodname_codeql %} database containing the data needed to analyze your code. shortTitle: Preparing code for analysis permissions: '{% data reusables.permissions.repo-checkout %}' product: '{% data reusables.gated-features.codeql %}' @@ -19,6 +19,8 @@ redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-codeql-code-scanning-in-your-ci-system - /github/finding-security-vulnerabilities-and-errors-in-your-code/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-code-scanning-in-your-ci-system - /code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system + - /code-security/codeql-cli/getting-started-with-the-codeql-cli/preparing-your-code-for-codeql-analysis +contentType: tutorials --- diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/publishing-and-using-codeql-packs.md b/content/code-security/tutorials/customize-code-scanning/publishing-and-using-codeql-packs.md similarity index 99% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/publishing-and-using-codeql-packs.md rename to content/code-security/tutorials/customize-code-scanning/publishing-and-using-codeql-packs.md index 6a0952b94bf2..c356ed620f3a 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/publishing-and-using-codeql-packs.md +++ b/content/code-security/tutorials/customize-code-scanning/publishing-and-using-codeql-packs.md @@ -1,6 +1,6 @@ --- title: Publishing and using CodeQL packs -intro: 'You can publish your own {% data variables.product.prodname_codeql %} packs and use packs published by other people.' +intro: You can publish your own {% data variables.product.prodname_codeql %} packs and use packs published by other people. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -13,6 +13,8 @@ topics: redirect_from: - /code-security/codeql-cli/publishing-and-using-codeql-packs - /code-security/codeql-cli/using-the-codeql-cli/publishing-and-using-codeql-packs + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/publishing-and-using-codeql-packs +contentType: tutorials --- {% ifversion ghec or ghes %} diff --git a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/running-codeql-code-scanning-in-a-container.md b/content/code-security/tutorials/customize-code-scanning/running-codeql-code-scanning-in-a-container.md similarity index 94% rename from content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/running-codeql-code-scanning-in-a-container.md rename to content/code-security/tutorials/customize-code-scanning/running-codeql-code-scanning-in-a-container.md index f34d0e7c3052..6111912ab17d 100644 --- a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/running-codeql-code-scanning-in-a-container.md +++ b/content/code-security/tutorials/customize-code-scanning/running-codeql-code-scanning-in-a-container.md @@ -1,7 +1,7 @@ --- title: Running CodeQL code scanning in a container shortTitle: '{% data variables.product.prodname_code_scanning_caps %} in a container' -intro: 'You can run {% data variables.product.prodname_code_scanning %} in a container by ensuring that all processes run in the same container.' +intro: You can run {% data variables.product.prodname_code_scanning %} in a container by ensuring that all processes run in the same container. product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container @@ -9,6 +9,7 @@ redirect_from: - /code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container - /github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container + - /code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/running-codeql-code-scanning-in-a-container versions: fpt: '*' ghes: '*' @@ -22,6 +23,7 @@ topics: - Repositories - Containers - Java +contentType: tutorials --- ## About {% data variables.product.prodname_code_scanning %} with a containerized build diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/testing-custom-queries.md b/content/code-security/tutorials/customize-code-scanning/testing-custom-queries.md similarity index 97% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/testing-custom-queries.md rename to content/code-security/tutorials/customize-code-scanning/testing-custom-queries.md index 448bfa67c7a6..4459b2a6ed93 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/testing-custom-queries.md +++ b/content/code-security/tutorials/customize-code-scanning/testing-custom-queries.md @@ -1,6 +1,6 @@ --- title: Testing custom queries -intro: 'You can set up tests for your {% data variables.product.prodname_codeql %} queries to ensure that they continue to return the expected results with new releases of the {% data variables.product.prodname_codeql_cli %}.' +intro: You can set up tests for your {% data variables.product.prodname_codeql %} queries to ensure that they continue to return the expected results with new releases of the {% data variables.product.prodname_codeql_cli %}. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -13,6 +13,8 @@ topics: redirect_from: - /code-security/codeql-cli/testing-custom-queries - /code-security/codeql-cli/using-the-codeql-cli/testing-custom-queries + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/testing-custom-queries +contentType: tutorials --- ## About testing custom queries diff --git a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github.md b/content/code-security/tutorials/customize-code-scanning/uploading-codeql-analysis-results-to-github.md similarity index 97% rename from content/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github.md rename to content/code-security/tutorials/customize-code-scanning/uploading-codeql-analysis-results-to-github.md index 585de6fcccbc..c0a90c2bab4e 100644 --- a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github.md +++ b/content/code-security/tutorials/customize-code-scanning/uploading-codeql-analysis-results-to-github.md @@ -1,7 +1,7 @@ --- title: Uploading CodeQL analysis results to GitHub shortTitle: Uploading results to GitHub -intro: 'You can use the {% data variables.product.prodname_codeql_cli %} to upload {% data variables.product.prodname_codeql %} analysis results to {% data variables.product.github %}.' +intro: You can use the {% data variables.product.prodname_codeql_cli %} to upload {% data variables.product.prodname_codeql %} analysis results to {% data variables.product.github %}. permissions: '{% data reusables.permissions.code-scanning-all-alerts %}' product: '{% data reusables.gated-features.codeql %}' versions: @@ -12,6 +12,9 @@ topics: - Code Security - Code scanning - CodeQL +redirect_from: + - /code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github +contentType: tutorials --- ## About SARIF output diff --git a/content/code-security/tutorials/index.md b/content/code-security/tutorials/index.md index 33ec2b1d6f6b..d4373c314c30 100644 --- a/content/code-security/tutorials/index.md +++ b/content/code-security/tutorials/index.md @@ -16,13 +16,13 @@ topics: - Dependabot contentType: tutorials children: - - trialing-github-advanced-security - - adopting-github-advanced-security-at-scale - - secure-your-organization - - remediate-leaked-secrets - - secret-scanning-partner-program - - manage-security-alerts - - improve-code-quality - - fix-reported-vulnerabilities + - /secure-your-organization + - /remediate-leaked-secrets + - /customize-code-scanning + - /trialing-github-advanced-security + - /adopting-github-advanced-security-at-scale + - /secret-scanning-partner-program + - /manage-security-alerts + - /improve-code-quality + - /fix-reported-vulnerabilities --- - diff --git a/data/learning-tracks/code-security.yml b/data/learning-tracks/code-security.yml index 02f0211c7c60..d67a42cc5a8c 100644 --- a/data/learning-tracks/code-security.yml +++ b/data/learning-tracks/code-security.yml @@ -194,7 +194,7 @@ code_security_actions: - >- /code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/codeql-code-scanning-for-compiled-languages - >- - /code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/running-codeql-code-scanning-in-a-container + /code-security/tutorials/customize-code-scanning/running-codeql-code-scanning-in-a-container - /code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors - >- /code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/about-the-tool-status-page From f97ad0ead49a5974e94a8be85d6c2caf053e1bdc Mon Sep 17 00:00:00 2001 From: Sam Browning <106113886+sabrowning1@users.noreply.github.com> Date: Tue, 13 Jan 2026 09:02:34 -0500 Subject: [PATCH 5/7] Relocate the CodeQL CLI manual pages in the EDI-fied docs structure (#59121) --- content/code-security/codeql-cli/index.md | 4 ++-- .../codeql}/codeql-cli-manual/bqrs-decode.md | 2 ++ .../codeql}/codeql-cli-manual/bqrs-diff.md | 2 ++ .../codeql}/codeql-cli-manual/bqrs-hash.md | 2 ++ .../codeql}/codeql-cli-manual/bqrs-info.md | 2 ++ .../codeql}/codeql-cli-manual/bqrs-interpret.md | 2 ++ .../database-add-diagnostic.md | 2 ++ .../codeql-cli-manual/database-analyze.md | 2 ++ .../codeql-cli-manual/database-bundle.md | 2 ++ .../codeql-cli-manual/database-cleanup.md | 2 ++ .../codeql-cli-manual/database-create.md | 2 ++ .../database-export-diagnostics.md | 2 ++ .../codeql-cli-manual/database-finalize.md | 2 ++ .../codeql-cli-manual/database-import.md | 2 ++ .../codeql-cli-manual/database-index-files.md | 2 ++ .../codeql}/codeql-cli-manual/database-init.md | 2 ++ .../database-interpret-results.md | 2 ++ .../database-print-baseline.md | 2 ++ .../codeql-cli-manual/database-run-queries.md | 2 ++ .../codeql-cli-manual/database-trace-command.md | 2 ++ .../codeql-cli-manual/database-unbundle.md | 2 ++ .../codeql-cli-manual/database-upgrade.md | 2 ++ .../codeql}/codeql-cli-manual/dataset-check.md | 2 ++ .../codeql-cli-manual/dataset-cleanup.md | 2 ++ .../codeql}/codeql-cli-manual/dataset-import.md | 2 ++ .../codeql-cli-manual/dataset-measure.md | 2 ++ .../codeql-cli-manual/dataset-upgrade.md | 2 ++ .../codeql}/codeql-cli-manual/diagnostic-add.md | 2 ++ .../codeql-cli-manual/diagnostic-export.md | 2 ++ .../codeql-cli-manual/execute-cli-server.md | 2 ++ .../execute-language-server.md | 2 ++ .../codeql-cli-manual/execute-queries.md | 2 ++ .../codeql-cli-manual/execute-query-server.md | 2 ++ .../codeql-cli-manual/execute-query-server2.md | 2 ++ .../codeql-cli-manual/execute-upgrades.md | 2 ++ .../generate-extensible-predicate-metadata.md | 3 +++ .../codeql-cli-manual/generate-log-summary.md | 2 ++ .../generate-overlay-changes.md | 3 +++ .../codeql-cli-manual/generate-query-help.md | 2 ++ .../codeql-cli-manual/github-merge-results.md | 3 +++ .../codeql-cli-manual/github-upload-results.md | 2 ++ .../codeql}/codeql-cli-manual/index.md | 6 +++--- .../codeql}/codeql-cli-manual/pack-add.md | 2 ++ .../codeql}/codeql-cli-manual/pack-bundle.md | 2 ++ .../codeql}/codeql-cli-manual/pack-ci.md | 2 ++ .../codeql}/codeql-cli-manual/pack-create.md | 2 ++ .../codeql}/codeql-cli-manual/pack-download.md | 2 ++ .../codeql}/codeql-cli-manual/pack-init.md | 4 +++- .../codeql}/codeql-cli-manual/pack-install.md | 4 +++- .../codeql}/codeql-cli-manual/pack-ls.md | 2 ++ .../codeql}/codeql-cli-manual/pack-packlist.md | 2 ++ .../codeql}/codeql-cli-manual/pack-publish.md | 2 ++ .../pack-resolve-dependencies.md | 2 ++ .../codeql}/codeql-cli-manual/pack-upgrade.md | 2 ++ .../codeql}/codeql-cli-manual/query-compile.md | 2 ++ .../codeql-cli-manual/query-decompile.md | 2 ++ .../codeql}/codeql-cli-manual/query-format.md | 2 ++ .../codeql}/codeql-cli-manual/query-run.md | 2 ++ .../codeql-cli-manual/resolve-database.md | 2 ++ .../resolve-extensions-by-pack.md | 3 +++ .../codeql-cli-manual/resolve-extensions.md | 2 ++ .../codeql-cli-manual/resolve-extractor.md | 2 ++ .../codeql}/codeql-cli-manual/resolve-files.md | 2 ++ .../codeql-cli-manual/resolve-languages.md | 2 ++ .../codeql-cli-manual/resolve-library-path.md | 2 ++ .../codeql-cli-manual/resolve-metadata.md | 2 ++ .../codeql-cli-manual/resolve-ml-models.md | 2 ++ .../codeql}/codeql-cli-manual/resolve-packs.md | 3 +++ .../codeql-cli-manual/resolve-qlpacks.md | 2 ++ .../codeql}/codeql-cli-manual/resolve-qlref.md | 2 ++ .../codeql-cli-manual/resolve-queries.md | 2 ++ .../codeql}/codeql-cli-manual/resolve-ram.md | 2 ++ .../codeql}/codeql-cli-manual/resolve-tests.md | 2 ++ .../codeql-cli-manual/resolve-upgrades.md | 2 ++ .../codeql}/codeql-cli-manual/test-accept.md | 2 ++ .../codeql}/codeql-cli-manual/test-extract.md | 2 ++ .../codeql}/codeql-cli-manual/test-run.md | 2 ++ .../codeql}/codeql-cli-manual/version.md | 2 ++ .../reference/code-scanning/codeql/index.md | 17 +++++++++++++++++ .../reference/code-scanning/index.md | 16 ++++++++++++++++ content/code-security/reference/index.md | 2 ++ src/codeql-cli/lib/config.json | 4 ++-- 82 files changed, 201 insertions(+), 9 deletions(-) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/bqrs-decode.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/bqrs-diff.md (97%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/bqrs-hash.md (96%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/bqrs-info.md (97%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/bqrs-interpret.md (99%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/database-add-diagnostic.md (97%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/database-analyze.md (99%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/database-bundle.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/database-cleanup.md (97%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/database-create.md (99%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/database-export-diagnostics.md (97%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/database-finalize.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/database-import.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/database-index-files.md (99%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/database-init.md (99%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/database-interpret-results.md (99%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/database-print-baseline.md (97%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/database-run-queries.md (99%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/database-trace-command.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/database-unbundle.md (96%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/database-upgrade.md (99%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/dataset-check.md (97%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/dataset-cleanup.md (97%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/dataset-import.md (97%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/dataset-measure.md (96%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/dataset-upgrade.md (99%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/diagnostic-add.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/diagnostic-export.md (97%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/execute-cli-server.md (95%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/execute-language-server.md (96%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/execute-queries.md (99%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/execute-query-server.md (96%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/execute-query-server2.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/execute-upgrades.md (99%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/generate-extensible-predicate-metadata.md (94%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/generate-log-summary.md (97%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/generate-overlay-changes.md (96%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/generate-query-help.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/github-merge-results.md (96%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/github-upload-results.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/index.md (90%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/pack-add.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/pack-bundle.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/pack-ci.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/pack-create.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/pack-download.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/pack-init.md (94%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/pack-install.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/pack-ls.md (97%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/pack-packlist.md (96%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/pack-publish.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/pack-resolve-dependencies.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/pack-upgrade.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/query-compile.md (99%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/query-decompile.md (96%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/query-format.md (97%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/query-run.md (99%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/resolve-database.md (96%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/resolve-extensions-by-pack.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/resolve-extensions.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/resolve-extractor.md (97%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/resolve-files.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/resolve-languages.md (97%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/resolve-library-path.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/resolve-metadata.md (96%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/resolve-ml-models.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/resolve-packs.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/resolve-qlpacks.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/resolve-qlref.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/resolve-queries.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/resolve-ram.md (97%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/resolve-tests.md (97%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/resolve-upgrades.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/test-accept.md (97%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/test-extract.md (98%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/test-run.md (99%) rename content/code-security/{codeql-cli => reference/code-scanning/codeql}/codeql-cli-manual/version.md (96%) create mode 100644 content/code-security/reference/code-scanning/codeql/index.md create mode 100644 content/code-security/reference/code-scanning/index.md diff --git a/content/code-security/codeql-cli/index.md b/content/code-security/codeql-cli/index.md index 863c4f75a853..996d0973575a 100644 --- a/content/code-security/codeql-cli/index.md +++ b/content/code-security/codeql-cli/index.md @@ -2,7 +2,7 @@ title: Use the CodeQL CLI to secure your code shortTitle: CodeQL CLI allowTitleToDifferFromFilename: true -intro: 'Use {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_codeql %} analyses locally.' +intro: Use {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_codeql %} analyses locally. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -14,5 +14,5 @@ topics: - CodeQL children: - /using-the-advanced-functionality-of-the-codeql-cli - - /codeql-cli-manual --- + diff --git a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-decode.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-decode.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/bqrs-decode.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-decode.md index 091913b27998..7b7a14391ea3 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-decode.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-decode.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: Convert result data from BQRS into other forms. redirect_from: - /code-security/codeql-cli/manual/bqrs-decode + - /code-security/codeql-cli/codeql-cli-manual/bqrs-decode +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-diff.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-diff.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/bqrs-diff.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-diff.md index 25361e2b952d..c02f4cd0a33f 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-diff.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-diff.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: Compute the difference between two result sets. redirect_from: - /code-security/codeql-cli/manual/bqrs-diff + - /code-security/codeql-cli/codeql-cli-manual/bqrs-diff +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-hash.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-hash.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/bqrs-hash.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-hash.md index 7624f3eb664e..66dd584dc6b2 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-hash.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-hash.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Plumbing] Compute a stable hash of a BQRS file.' redirect_from: - /code-security/codeql-cli/manual/bqrs-hash + - /code-security/codeql-cli/codeql-cli-manual/bqrs-hash +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-info.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-info.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/bqrs-info.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-info.md index 5e3a997d37d7..38bb740aae6d 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-info.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-info.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: Display metadata for a BQRS file. redirect_from: - /code-security/codeql-cli/manual/bqrs-info + - /code-security/codeql-cli/codeql-cli-manual/bqrs-info +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-interpret.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-interpret.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/bqrs-interpret.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-interpret.md index 45f7c46ad674..52a05e252230 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-interpret.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-interpret.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Plumbing] Interpret data in a single BQRS.' redirect_from: - /code-security/codeql-cli/manual/bqrs-interpret + - /code-security/codeql-cli/codeql-cli-manual/bqrs-interpret +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-add-diagnostic.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-add-diagnostic.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/database-add-diagnostic.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-add-diagnostic.md index 3bc1a01adef4..a0149acb68d2 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-add-diagnostic.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-add-diagnostic.md @@ -14,6 +14,8 @@ product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli redirect_from: - /code-security/codeql-cli/manual/database-add-diagnostic + - /code-security/codeql-cli/codeql-cli-manual/database-add-diagnostic +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-analyze.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-analyze.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/database-analyze.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-analyze.md index 44562d5035ca..e130cf31be40 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-analyze.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-analyze.md @@ -16,6 +16,8 @@ intro: |- source code. redirect_from: - /code-security/codeql-cli/manual/database-analyze + - /code-security/codeql-cli/codeql-cli-manual/database-analyze +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-bundle.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-bundle.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/database-bundle.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-bundle.md index 2d520bd3130d..55bbb5f0396f 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-bundle.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-bundle.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: Create a relocatable archive of a CodeQL database. redirect_from: - /code-security/codeql-cli/manual/database-bundle + - /code-security/codeql-cli/codeql-cli-manual/database-bundle +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-cleanup.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-cleanup.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/database-cleanup.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-cleanup.md index 7eb9659cc56c..1237c8c0836b 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-cleanup.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-cleanup.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: Compact a CodeQL database on disk. redirect_from: - /code-security/codeql-cli/manual/database-cleanup + - /code-security/codeql-cli/codeql-cli-manual/database-cleanup +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-create.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-create.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/database-create.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-create.md index 7c9119991eb2..9d109df91b44 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-create.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-create.md @@ -16,6 +16,8 @@ intro: |- one of the CodeQL products. redirect_from: - /code-security/codeql-cli/manual/database-create + - /code-security/codeql-cli/codeql-cli-manual/database-create +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-export-diagnostics.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-export-diagnostics.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/database-export-diagnostics.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-export-diagnostics.md index aab924d80e9c..ded3e969e182 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-export-diagnostics.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-export-diagnostics.md @@ -16,6 +16,8 @@ product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli redirect_from: - /code-security/codeql-cli/manual/database-export-diagnostics + - /code-security/codeql-cli/codeql-cli-manual/database-export-diagnostics +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-finalize.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-finalize.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/database-finalize.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-finalize.md index ae07940d4fdd..10f1396a1a1b 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-finalize.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-finalize.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Plumbing] Final steps in database creation.' redirect_from: - /code-security/codeql-cli/manual/database-finalize + - /code-security/codeql-cli/codeql-cli-manual/database-finalize +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-import.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-import.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/database-import.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-import.md index 1720418a1280..171d811d6f7e 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-import.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-import.md @@ -16,6 +16,8 @@ intro: |- unfinalized database. redirect_from: - /code-security/codeql-cli/manual/database-import + - /code-security/codeql-cli/codeql-cli-manual/database-import +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-index-files.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-index-files.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/database-index-files.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-index-files.md index 7d66da5c6d38..fe1571a85d11 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-index-files.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-index-files.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Plumbing] Index standalone files with a given CodeQL extractor.' redirect_from: - /code-security/codeql-cli/manual/database-index-files + - /code-security/codeql-cli/codeql-cli-manual/database-index-files +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-init.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-init.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/database-init.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-init.md index a7ac69276878..bf3fd3d66d7e 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-init.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-init.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Plumbing] Create an empty CodeQL database.' redirect_from: - /code-security/codeql-cli/manual/database-init + - /code-security/codeql-cli/codeql-cli-manual/database-init +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-interpret-results.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-interpret-results.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/database-interpret-results.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-interpret-results.md index 7abb3c8fa5f3..e8f06a4c5905 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-interpret-results.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-interpret-results.md @@ -16,6 +16,8 @@ intro: |- such as SARIF or CSV. redirect_from: - /code-security/codeql-cli/manual/database-interpret-results + - /code-security/codeql-cli/codeql-cli-manual/database-interpret-results +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-print-baseline.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-print-baseline.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/database-print-baseline.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-print-baseline.md index ee6a2decd9a4..9690cd45d5ed 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-print-baseline.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-print-baseline.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Plumbing] Print a summary of the baseline lines of code seen.' redirect_from: - /code-security/codeql-cli/manual/database-print-baseline + - /code-security/codeql-cli/codeql-cli-manual/database-print-baseline +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-run-queries.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-run-queries.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/database-run-queries.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-run-queries.md index d9fc27257274..4613e3e4526a 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-run-queries.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-run-queries.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Plumbing] Run a set of queries together.' redirect_from: - /code-security/codeql-cli/manual/database-run-queries + - /code-security/codeql-cli/codeql-cli-manual/database-run-queries +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-trace-command.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-trace-command.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/database-trace-command.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-trace-command.md index 8f90ceb9d32c..6e3eca07a9fd 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-trace-command.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-trace-command.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Plumbing] Run a single command as part of a traced build.' redirect_from: - /code-security/codeql-cli/manual/database-trace-command + - /code-security/codeql-cli/codeql-cli-manual/database-trace-command +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-unbundle.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-unbundle.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/database-unbundle.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-unbundle.md index c6101def470d..7bd65bb743a4 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-unbundle.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-unbundle.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: Extracts a CodeQL database archive. redirect_from: - /code-security/codeql-cli/manual/database-unbundle + - /code-security/codeql-cli/codeql-cli-manual/database-unbundle +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-upgrade.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-upgrade.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/database-upgrade.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-upgrade.md index c6b78c6bcfec..074723919ebc 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-upgrade.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-upgrade.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: Upgrade a database so it is usable by the current tools. redirect_from: - /code-security/codeql-cli/manual/database-upgrade + - /code-security/codeql-cli/codeql-cli-manual/database-upgrade +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/dataset-check.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-check.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/dataset-check.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-check.md index 490e358f0097..fc5ab0f4a560 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/dataset-check.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-check.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Plumbing] Check a particular dataset for internal consistency.' redirect_from: - /code-security/codeql-cli/manual/dataset-check + - /code-security/codeql-cli/codeql-cli-manual/dataset-check +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/dataset-cleanup.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-cleanup.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/dataset-cleanup.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-cleanup.md index 092f4299cb2f..402b6a6bcb92 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/dataset-cleanup.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-cleanup.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Plumbing] Clean up temporary files from a dataset.' redirect_from: - /code-security/codeql-cli/manual/dataset-cleanup + - /code-security/codeql-cli/codeql-cli-manual/dataset-cleanup +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/dataset-import.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-import.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/dataset-import.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-import.md index 2dd26deba3d2..67becfe5c72c 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/dataset-import.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-import.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Plumbing] Import a set of TRAP files to a raw dataset.' redirect_from: - /code-security/codeql-cli/manual/dataset-import + - /code-security/codeql-cli/codeql-cli-manual/dataset-import +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/dataset-measure.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-measure.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/dataset-measure.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-measure.md index dec978bb94b2..ce0c3709f46b 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/dataset-measure.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-measure.md @@ -16,6 +16,8 @@ intro: |- dataset. redirect_from: - /code-security/codeql-cli/manual/dataset-measure + - /code-security/codeql-cli/codeql-cli-manual/dataset-measure +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/dataset-upgrade.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-upgrade.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/dataset-upgrade.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-upgrade.md index 5778a35bcc5c..26819b2bb04c 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/dataset-upgrade.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-upgrade.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Plumbing] Upgrade a dataset so it is usable by the current tools.' redirect_from: - /code-security/codeql-cli/manual/dataset-upgrade + - /code-security/codeql-cli/codeql-cli-manual/dataset-upgrade +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/diagnostic-add.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/diagnostic-add.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/diagnostic-add.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/diagnostic-add.md index 72b4a6c9d3af..fbbc855ad2e2 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/diagnostic-add.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/diagnostic-add.md @@ -14,6 +14,8 @@ product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli redirect_from: - /code-security/codeql-cli/manual/diagnostic-add + - /code-security/codeql-cli/codeql-cli-manual/diagnostic-add +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/diagnostic-export.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/diagnostic-export.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/diagnostic-export.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/diagnostic-export.md index 31806c493aaa..be07e80b7650 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/diagnostic-export.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/diagnostic-export.md @@ -14,6 +14,8 @@ product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli redirect_from: - /code-security/codeql-cli/manual/diagnostic-export + - /code-security/codeql-cli/codeql-cli-manual/diagnostic-export +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/execute-cli-server.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-cli-server.md similarity index 95% rename from content/code-security/codeql-cli/codeql-cli-manual/execute-cli-server.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-cli-server.md index f6db3ed738d1..69be086feaa2 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/execute-cli-server.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-cli-server.md @@ -16,6 +16,8 @@ intro: |- repeated JVM initialization. redirect_from: - /code-security/codeql-cli/manual/execute-cli-server + - /code-security/codeql-cli/codeql-cli-manual/execute-cli-server +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/execute-language-server.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-language-server.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/execute-language-server.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-language-server.md index e7dfde0fb66f..882de2f17933 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/execute-language-server.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-language-server.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Plumbing] On-line support for the QL language in IDEs.' redirect_from: - /code-security/codeql-cli/manual/execute-language-server + - /code-security/codeql-cli/codeql-cli-manual/execute-language-server +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/execute-queries.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-queries.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/execute-queries.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-queries.md index fbd9d6a7ccd8..ff6413dde404 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/execute-queries.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-queries.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Plumbing] Run one or more queries against a dataset.' redirect_from: - /code-security/codeql-cli/manual/execute-queries + - /code-security/codeql-cli/codeql-cli-manual/execute-queries +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/execute-query-server.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-query-server.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/execute-query-server.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-query-server.md index b99b63f7179a..97650519833e 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/execute-query-server.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-query-server.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Plumbing] Support for running queries from IDEs.' redirect_from: - /code-security/codeql-cli/manual/execute-query-server + - /code-security/codeql-cli/codeql-cli-manual/execute-query-server +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/execute-query-server2.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-query-server2.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/execute-query-server2.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-query-server2.md index 0278dbad6fcd..19ce5ec94636 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/execute-query-server2.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-query-server2.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Plumbing] Support for running queries from IDEs.' redirect_from: - /code-security/codeql-cli/manual/execute-query-server2 + - /code-security/codeql-cli/codeql-cli-manual/execute-query-server2 +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/execute-upgrades.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-upgrades.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/execute-upgrades.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-upgrades.md index aa803ac7ea31..c082b3839aca 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/execute-upgrades.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-upgrades.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Plumbing] Run upgrade scripts on an existing raw QL dataset.' redirect_from: - /code-security/codeql-cli/manual/execute-upgrades + - /code-security/codeql-cli/codeql-cli-manual/execute-upgrades +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/generate-extensible-predicate-metadata.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-extensible-predicate-metadata.md similarity index 94% rename from content/code-security/codeql-cli/codeql-cli-manual/generate-extensible-predicate-metadata.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-extensible-predicate-metadata.md index 6c45cdb55029..37190fa80719 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/generate-extensible-predicate-metadata.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-extensible-predicate-metadata.md @@ -14,6 +14,9 @@ topics: type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli +redirect_from: + - /code-security/codeql-cli/codeql-cli-manual/generate-extensible-predicate-metadata +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/generate-log-summary.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-log-summary.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/generate-log-summary.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-log-summary.md index 109c040d38d9..4c2b06890a3a 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/generate-log-summary.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-log-summary.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Advanced] Create a summary of a structured log file.' redirect_from: - /code-security/codeql-cli/manual/generate-log-summary + - /code-security/codeql-cli/codeql-cli-manual/generate-log-summary +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/generate-overlay-changes.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-overlay-changes.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/generate-overlay-changes.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-overlay-changes.md index 6fa8e707e468..b7ba90ed544d 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/generate-overlay-changes.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-overlay-changes.md @@ -13,6 +13,9 @@ topics: type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli +redirect_from: + - /code-security/codeql-cli/codeql-cli-manual/generate-overlay-changes +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/generate-query-help.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-query-help.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/generate-query-help.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-query-help.md index 55d51115a46f..3020559585e7 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/generate-query-help.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-query-help.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: Generate end-user query help from .qhelp files. redirect_from: - /code-security/codeql-cli/manual/generate-query-help + - /code-security/codeql-cli/codeql-cli-manual/generate-query-help +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/github-merge-results.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/github-merge-results.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/github-merge-results.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/github-merge-results.md index d9d5addb1d0e..83043fcb9093 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/github-merge-results.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/github-merge-results.md @@ -12,6 +12,9 @@ topics: type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli +redirect_from: + - /code-security/codeql-cli/codeql-cli-manual/github-merge-results +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/github-upload-results.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/github-upload-results.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/github-upload-results.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/github-upload-results.md index 7d55974de78d..44b54e7b4210 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/github-upload-results.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/github-upload-results.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: Uploads a SARIF file to GitHub code scanning. redirect_from: - /code-security/codeql-cli/manual/github-upload-results + - /code-security/codeql-cli/codeql-cli-manual/github-upload-results +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/index.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/index.md similarity index 90% rename from content/code-security/codeql-cli/codeql-cli-manual/index.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/index.md index 4eabc073f39f..4513d39dd45b 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/index.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/index.md @@ -2,9 +2,7 @@ title: CodeQL CLI commands manual shortTitle: CodeQL CLI manual allowTitleToDifferFromFilename: true -intro: >- - Reference information for the commands available in the most recent release of - {% data variables.product.prodname_codeql_cli %}. +intro: Reference information for the commands available in the most recent release of {% data variables.product.prodname_codeql_cli %}. versions: fpt: '*' ghec: '*' @@ -18,6 +16,7 @@ product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli redirect_from: - /code-security/codeql-cli/manual + - /code-security/codeql-cli/codeql-cli-manual children: - /bqrs-decode - /bqrs-diff @@ -95,6 +94,7 @@ children: - /test-extract - /test-run - /version +contentType: reference --- {% data reusables.codeql-cli.man-pages-version-note %} diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-add.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-add.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-add.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-add.md index d0bcb2f16dc9..14b8e0a4e91f 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-add.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-add.md @@ -16,6 +16,8 @@ intro: |- ranges as dependencies of the current package, and then installs them. redirect_from: - /code-security/codeql-cli/manual/pack-add + - /code-security/codeql-cli/codeql-cli-manual/pack-add +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-bundle.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-bundle.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-bundle.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-bundle.md index 79b671ceea84..ebd421952e45 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-bundle.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-bundle.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Plumbing] Bundle a QL library pack.' redirect_from: - /code-security/codeql-cli/manual/pack-bundle + - /code-security/codeql-cli/codeql-cli-manual/pack-bundle +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-ci.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-ci.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-ci.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-ci.md index 1551deb37084..8530986afb72 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-ci.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-ci.md @@ -16,6 +16,8 @@ intro: |- existing lock file is up to date. redirect_from: - /code-security/codeql-cli/manual/pack-ci + - /code-security/codeql-cli/codeql-cli-manual/pack-ci +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-create.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-create.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-create.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-create.md index b051c5269878..dda08c449498 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-create.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-create.md @@ -16,6 +16,8 @@ intro: |- source code. redirect_from: - /code-security/codeql-cli/manual/pack-create + - /code-security/codeql-cli/codeql-cli-manual/pack-create +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-download.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-download.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-download.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-download.md index 4927d89ed034..6ef353a5fb65 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-download.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-download.md @@ -17,6 +17,8 @@ intro: |- name or implicitly inside of a query suite (.qls) file. redirect_from: - /code-security/codeql-cli/manual/pack-download + - /code-security/codeql-cli/codeql-cli-manual/pack-download +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-init.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-init.md similarity index 94% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-init.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-init.md index bd72043b5f75..85cba43a5dee 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-init.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-init.md @@ -11,9 +11,11 @@ topics: type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli -intro: 'Initializes a qlpack in the specified directory.' +intro: Initializes a qlpack in the specified directory. redirect_from: - /code-security/codeql-cli/manual/pack-init + - /code-security/codeql-cli/codeql-cli-manual/pack-init +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-install.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-install.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-install.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-install.md index 8d35d6159aa9..680220bee8b0 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-install.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-install.md @@ -11,9 +11,11 @@ topics: type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli -intro: 'Install dependencies for this pack.' +intro: Install dependencies for this pack. redirect_from: - /code-security/codeql-cli/manual/pack-install + - /code-security/codeql-cli/codeql-cli-manual/pack-install +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-ls.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-ls.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-ls.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-ls.md index 6a6f3268b7e9..6d61835dd5ef 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-ls.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-ls.md @@ -17,6 +17,8 @@ intro: |- .codeqlmanifest.json file. redirect_from: - /code-security/codeql-cli/manual/pack-ls + - /code-security/codeql-cli/codeql-cli-manual/pack-ls +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-packlist.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-packlist.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-packlist.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-packlist.md index f52bb8d1a305..5cccb773e426 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-packlist.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-packlist.md @@ -16,6 +16,8 @@ intro: |- a QL query pack or library pack. redirect_from: - /code-security/codeql-cli/manual/pack-packlist + - /code-security/codeql-cli/codeql-cli-manual/pack-packlist +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-publish.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-publish.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-publish.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-publish.md index 468a593da7de..87dd5eafc0d0 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-publish.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-publish.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: Publishes a QL library pack to a package registry. redirect_from: - /code-security/codeql-cli/manual/pack-publish + - /code-security/codeql-cli/codeql-cli-manual/pack-publish +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-resolve-dependencies.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-resolve-dependencies.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-resolve-dependencies.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-resolve-dependencies.md index d2fad44c55c9..139e4ad29dc9 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-resolve-dependencies.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-resolve-dependencies.md @@ -16,6 +16,8 @@ intro: |- for this QL pack. redirect_from: - /code-security/codeql-cli/manual/pack-resolve-dependencies + - /code-security/codeql-cli/codeql-cli-manual/pack-resolve-dependencies +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-upgrade.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-upgrade.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-upgrade.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-upgrade.md index f44c0f978245..c59ffb882cff 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-upgrade.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-upgrade.md @@ -16,6 +16,8 @@ intro: |- available versions. redirect_from: - /code-security/codeql-cli/manual/pack-upgrade + - /code-security/codeql-cli/codeql-cli-manual/pack-upgrade +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/query-compile.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-compile.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/query-compile.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-compile.md index 32801fb06743..e8f98f8a88c5 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/query-compile.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-compile.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: Compile or check QL code. redirect_from: - /code-security/codeql-cli/manual/query-compile + - /code-security/codeql-cli/codeql-cli-manual/query-compile +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/query-decompile.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-decompile.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/query-decompile.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-decompile.md index 52acd29d6d02..df3790b51697 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/query-decompile.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-decompile.md @@ -16,6 +16,8 @@ intro: |- from a .qlo file. redirect_from: - /code-security/codeql-cli/manual/query-decompile + - /code-security/codeql-cli/codeql-cli-manual/query-decompile +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/query-format.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-format.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/query-format.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-format.md index 1562c9a538c3..5ed10d045a95 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/query-format.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-format.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: Autoformat QL source code. redirect_from: - /code-security/codeql-cli/manual/query-format + - /code-security/codeql-cli/codeql-cli-manual/query-format +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/query-run.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-run.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/query-run.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-run.md index 226836c851b6..de6a8798aaef 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/query-run.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-run.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: Run a single query. redirect_from: - /code-security/codeql-cli/manual/query-run + - /code-security/codeql-cli/codeql-cli-manual/query-run +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-database.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-database.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-database.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-database.md index c0eb9d36a988..a6e5d0f229e0 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-database.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-database.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Deep plumbing] Report metadata about the database.' redirect_from: - /code-security/codeql-cli/manual/resolve-database + - /code-security/codeql-cli/codeql-cli-manual/resolve-database +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-extensions-by-pack.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-extensions-by-pack.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-extensions-by-pack.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-extensions-by-pack.md index 30ebdf5cd676..249a2f406b74 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-extensions-by-pack.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-extensions-by-pack.md @@ -15,6 +15,9 @@ topics: type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli +redirect_from: + - /code-security/codeql-cli/codeql-cli-manual/resolve-extensions-by-pack +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-extensions.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-extensions.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-extensions.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-extensions.md index a5be28aff79a..b42c21fff8d5 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-extensions.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-extensions.md @@ -16,6 +16,8 @@ intro: |- includes machine learning models and data extensions. redirect_from: - /code-security/codeql-cli/manual/resolve-extensions + - /code-security/codeql-cli/codeql-cli-manual/resolve-extensions +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-extractor.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-extractor.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-extractor.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-extractor.md index b819567aa583..92739909eb27 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-extractor.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-extractor.md @@ -16,6 +16,8 @@ intro: |- language. redirect_from: - /code-security/codeql-cli/manual/resolve-extractor + - /code-security/codeql-cli/codeql-cli-manual/resolve-extractor +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-files.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-files.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-files.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-files.md index a3af3c80aa99..082e916f857b 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-files.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-files.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Deep plumbing] Expand a set of file inclusion/exclusion globs.' redirect_from: - /code-security/codeql-cli/manual/resolve-files + - /code-security/codeql-cli/codeql-cli-manual/resolve-files +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-languages.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-languages.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-languages.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-languages.md index 08731765781c..768debca9c73 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-languages.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-languages.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: List installed CodeQL extractor packs. redirect_from: - /code-security/codeql-cli/manual/resolve-languages + - /code-security/codeql-cli/codeql-cli-manual/resolve-languages +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-library-path.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-library-path.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-library-path.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-library-path.md index 73e0eabb815f..758f051f0374 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-library-path.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-library-path.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Deep plumbing] Determine QL library path and dbscheme for a query.' redirect_from: - /code-security/codeql-cli/manual/resolve-library-path + - /code-security/codeql-cli/codeql-cli-manual/resolve-library-path +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-metadata.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-metadata.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-metadata.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-metadata.md index 9f016be45607..c4340e608559 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-metadata.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-metadata.md @@ -16,6 +16,8 @@ intro: |- query source file. redirect_from: - /code-security/codeql-cli/manual/resolve-metadata + - /code-security/codeql-cli/codeql-cli-manual/resolve-metadata +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-ml-models.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-ml-models.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-ml-models.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-ml-models.md index 454315596d25..dc2ea3012b7c 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-ml-models.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-ml-models.md @@ -16,6 +16,8 @@ intro: |- machine learning models. redirect_from: - /code-security/codeql-cli/manual/resolve-ml-models + - /code-security/codeql-cli/codeql-cli-manual/resolve-ml-models +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-packs.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-packs.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-packs.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-packs.md index 5a3814a9858d..b01bc45db519 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-packs.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-packs.md @@ -12,6 +12,9 @@ topics: type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli +redirect_from: + - /code-security/codeql-cli/codeql-cli-manual/resolve-packs +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-qlpacks.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-qlpacks.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-qlpacks.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-qlpacks.md index 5cd22ccd341d..c7c6ae91f7ef 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-qlpacks.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-qlpacks.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: Create a list of installed QL packs and their locations. redirect_from: - /code-security/codeql-cli/manual/resolve-qlpacks + - /code-security/codeql-cli/codeql-cli-manual/resolve-qlpacks +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-qlref.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-qlref.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-qlref.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-qlref.md index 39e6509064ee..91cbfa5fb308 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-qlref.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-qlref.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Deep plumbing] Dereferences a .qlref file to return a .ql one.' redirect_from: - /code-security/codeql-cli/manual/resolve-qlref + - /code-security/codeql-cli/codeql-cli-manual/resolve-qlref +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-queries.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-queries.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-queries.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-queries.md index 787428659e61..9bef44a4e6a3 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-queries.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-queries.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Deep plumbing] Expand query directories and suite specifications.' redirect_from: - /code-security/codeql-cli/manual/resolve-queries + - /code-security/codeql-cli/codeql-cli-manual/resolve-queries +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-ram.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-ram.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-ram.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-ram.md index eb6511dc9deb..9797cafa75a7 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-ram.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-ram.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Deep plumbing] Prepare RAM options.' redirect_from: - /code-security/codeql-cli/manual/resolve-ram + - /code-security/codeql-cli/codeql-cli-manual/resolve-ram +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-tests.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-tests.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-tests.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-tests.md index 7fe823a3c719..79aff577d8bb 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-tests.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-tests.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Deep plumbing] Find QL unit tests in given directories.' redirect_from: - /code-security/codeql-cli/manual/resolve-tests + - /code-security/codeql-cli/codeql-cli-manual/resolve-tests +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-upgrades.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-upgrades.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-upgrades.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-upgrades.md index f1e8a0b87513..1bdd8e06fe36 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-upgrades.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-upgrades.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Deep plumbing] Determine upgrades to run for a raw dataset.' redirect_from: - /code-security/codeql-cli/manual/resolve-upgrades + - /code-security/codeql-cli/codeql-cli-manual/resolve-upgrades +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/test-accept.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-accept.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/test-accept.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-accept.md index 78909caa0746..da93e5fa2eb0 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/test-accept.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-accept.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: Accept results of failing unit tests. redirect_from: - /code-security/codeql-cli/manual/test-accept + - /code-security/codeql-cli/codeql-cli-manual/test-accept +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/test-extract.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-extract.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/test-extract.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-extract.md index de9a598d5037..2e49f3d4fbe9 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/test-extract.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-extract.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: '[Plumbing] Build a dataset for a test directory.' redirect_from: - /code-security/codeql-cli/manual/test-extract + - /code-security/codeql-cli/codeql-cli-manual/test-extract +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/test-run.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-run.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/test-run.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-run.md index 191a1a246d15..e895a2450a2f 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/test-run.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-run.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: Run unit tests for QL queries. redirect_from: - /code-security/codeql-cli/manual/test-run + - /code-security/codeql-cli/codeql-cli-manual/test-run +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/version.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/version.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/version.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/version.md index 908fca35be1d..9ec68e57485e 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/version.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/version.md @@ -14,6 +14,8 @@ autogenerated: codeql-cli intro: Show the version of the CodeQL toolchain. redirect_from: - /code-security/codeql-cli/manual/version + - /code-security/codeql-cli/codeql-cli-manual/version +contentType: reference --- diff --git a/content/code-security/reference/code-scanning/codeql/index.md b/content/code-security/reference/code-scanning/codeql/index.md new file mode 100644 index 000000000000..7b57ddab028c --- /dev/null +++ b/content/code-security/reference/code-scanning/codeql/index.md @@ -0,0 +1,17 @@ +--- +title: Reference for code scanning with CodeQL +shortTitle: CodeQL +intro: Find information to apply to your work with {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Code Security + - Code scanning + - Vulnerabilities +contentType: reference +children: + - /codeql-cli-manual +--- + diff --git a/content/code-security/reference/code-scanning/index.md b/content/code-security/reference/code-scanning/index.md new file mode 100644 index 000000000000..c603d816cd16 --- /dev/null +++ b/content/code-security/reference/code-scanning/index.md @@ -0,0 +1,16 @@ +--- +title: Reference for code scanning +shortTitle: Code scanning +intro: Find information to apply to your work with {% data variables.product.prodname_code_scanning %}. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Code Security + - Code scanning + - Vulnerabilities +contentType: reference +children: + - codeql +--- diff --git a/content/code-security/reference/index.md b/content/code-security/reference/index.md index 91eef27e7c0e..b150165e9190 100644 --- a/content/code-security/reference/index.md +++ b/content/code-security/reference/index.md @@ -15,4 +15,6 @@ topics: - Dependencies - Dependabot contentType: reference +children: + - code-scanning --- diff --git a/src/codeql-cli/lib/config.json b/src/codeql-cli/lib/config.json index dd6f8c49c67d..d62f6633ffe9 100644 --- a/src/codeql-cli/lib/config.json +++ b/src/codeql-cli/lib/config.json @@ -15,8 +15,8 @@ "autogenerated": "codeql-cli" }, "markdownPrefix": "{% data reusables.codeql-cli.man-pages-version-note %}", - "targetDirectory": "content/code-security/codeql-cli/codeql-cli-manual", + "targetDirectory": "content/code-security/reference/code-scanning/codeql/codeql-cli-manual", "sourceDirectory": "semmle-code/documentation/restructuredtext/codeql-cli/manual", "removeKeywords": [], - "linterIgnore": ["content/code-security/codeql-cli/codeql-cli-manual"] + "linterIgnore": ["content/code-security/reference/code-scanning/codeql/codeql-cli-manual"] } From b6866261a5b4498e301387753cac868624d6c1e9 Mon Sep 17 00:00:00 2001 From: Sophie <29382425+sophietheking@users.noreply.github.com> Date: Tue, 13 Jan 2026 15:03:28 +0100 Subject: [PATCH 6/7] [EDI] Move RAI articles into the "Responsible use" map topic (#59132) --- content/code-security/code-quality/index.md | 2 -- .../code-quality/responsible-use/index.md | 12 ------------ .../managing-code-scanning-alerts/index.md | 1 - .../responsible-use/code-quality.md | 4 +++- content/code-security/responsible-use/index.md | 9 ++++++++- .../responsible-ai-generic-secrets.md | 7 ++++--- .../responsible-ai-regex-generator.md | 7 ++++--- .../responsible-use-autofix-code-scanning.md | 5 +++-- .../secret-scanning/copilot-secret-scanning/index.md | 5 ++--- 9 files changed, 24 insertions(+), 28 deletions(-) delete mode 100644 content/code-security/code-quality/responsible-use/index.md rename content/code-security/{code-quality => }/responsible-use/code-quality.md (97%) rename content/code-security/{secret-scanning/copilot-secret-scanning => responsible-use}/responsible-ai-generic-secrets.md (96%) rename content/code-security/{secret-scanning/copilot-secret-scanning => responsible-use}/responsible-ai-regex-generator.md (94%) rename content/code-security/{code-scanning/managing-code-scanning-alerts => responsible-use}/responsible-use-autofix-code-scanning.md (97%) diff --git a/content/code-security/code-quality/index.md b/content/code-security/code-quality/index.md index 002d7a7a912b..3609678fa519 100644 --- a/content/code-security/code-quality/index.md +++ b/content/code-security/code-quality/index.md @@ -9,6 +9,4 @@ topics: children: - /get-started - /reference - - /responsible-use --- - diff --git a/content/code-security/code-quality/responsible-use/index.md b/content/code-security/code-quality/responsible-use/index.md deleted file mode 100644 index 1ead734e7dad..000000000000 --- a/content/code-security/code-quality/responsible-use/index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Responsible use of GitHub Code Quality -shortTitle: Responsible use -intro: 'Use {% data variables.product.prodname_code_quality %} responsibly by understanding its purposes, capabilities, and limitations.' -versions: - feature: code-quality -topics: - - Code Quality -children: - - code-quality -contentType: rai ---- \ No newline at end of file diff --git a/content/code-security/code-scanning/managing-code-scanning-alerts/index.md b/content/code-security/code-scanning/managing-code-scanning-alerts/index.md index 6513370055d5..72951ec4c786 100644 --- a/content/code-security/code-scanning/managing-code-scanning-alerts/index.md +++ b/content/code-security/code-scanning/managing-code-scanning-alerts/index.md @@ -15,7 +15,6 @@ redirect_from: - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists - /code-security/code-scanning/managing-code-scanning-alerts/tracking-code-scanning-alerts-in-issues-using-task-lists children: - - /responsible-use-autofix-code-scanning - /disabling-autofix-for-code-scanning - /assessing-code-scanning-alerts-for-your-repository - /resolving-code-scanning-alerts diff --git a/content/code-security/code-quality/responsible-use/code-quality.md b/content/code-security/responsible-use/code-quality.md similarity index 97% rename from content/code-security/code-quality/responsible-use/code-quality.md rename to content/code-security/responsible-use/code-quality.md index 5d514ee04f90..9b7d811c18f1 100644 --- a/content/code-security/code-quality/responsible-use/code-quality.md +++ b/content/code-security/responsible-use/code-quality.md @@ -1,7 +1,7 @@ --- title: Responsible use of GitHub Code Quality shortTitle: Code quality -intro: 'Use {% data variables.product.prodname_code_quality %} responsibly by understanding its purposes, capabilities, and limitations.' +intro: Use {% data variables.product.prodname_code_quality %} responsibly by understanding its purposes, capabilities, and limitations. versions: feature: code-quality topics: @@ -9,6 +9,8 @@ topics: - CodeQL - AI contentType: rai +redirect_from: + - /code-security/code-quality/responsible-use/code-quality --- {% data reusables.code-quality.code-quality-preview-note %} diff --git a/content/code-security/responsible-use/index.md b/content/code-security/responsible-use/index.md index d48879a51ce3..9ecbc347ac92 100644 --- a/content/code-security/responsible-use/index.md +++ b/content/code-security/responsible-use/index.md @@ -1,7 +1,7 @@ --- title: Responsible use of {% data variables.product.github %}'s security and code quality features shortTitle: Responsible use -intro: 'Use {% data variables.product.github %}''s security and code quality features responsibly by understanding their purposes, capabilities, and limitations.' +intro: Use {% data variables.product.github %}'s security and code quality features responsibly by understanding their purposes, capabilities, and limitations. versions: fpt: '*' ghes: '*' @@ -14,4 +14,11 @@ topics: - Vulnerabilities - Code Quality contentType: rai +children: + - /responsible-use-autofix-code-scanning + - /responsible-ai-generic-secrets + - /responsible-ai-regex-generator + - /code-quality +redirect_from: + - /code-security/code-quality/responsible-use --- diff --git a/content/code-security/secret-scanning/copilot-secret-scanning/responsible-ai-generic-secrets.md b/content/code-security/responsible-use/responsible-ai-generic-secrets.md similarity index 96% rename from content/code-security/secret-scanning/copilot-secret-scanning/responsible-ai-generic-secrets.md rename to content/code-security/responsible-use/responsible-ai-generic-secrets.md index 7f82b8e44c95..3802c471fd4c 100644 --- a/content/code-security/secret-scanning/copilot-secret-scanning/responsible-ai-generic-secrets.md +++ b/content/code-security/responsible-use/responsible-ai-generic-secrets.md @@ -1,13 +1,12 @@ --- title: Responsible detection of generic secrets with Copilot secret scanning -shortTitle: Generic secret detection -intro: 'Learn how {% data variables.secret-scanning.copilot-secret-scanning %} uses AI responsibly to scan and create alerts for unstructured secrets, such as passwords.' +shortTitle: Copilot secret scanning +intro: Learn how {% data variables.secret-scanning.copilot-secret-scanning %} uses AI responsibly to scan and create alerts for unstructured secrets, such as passwords. allowTitleToDifferFromFilename: true product: '{% data reusables.rai.secret-scanning.copilot-secret-scanning-gated-feature %}' versions: feature: secret-scanning-ai-generic-secret-detection fpt: '*' -type: rai topics: - Secret scanning - Secret Protection @@ -17,6 +16,8 @@ redirect_from: - /code-security/secret-scanning/about-the-detection-of-generic-secrets-with-secret-scanning - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/about-the-detection-of-generic-secrets-with-secret-scanning - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets + - /code-security/secret-scanning/copilot-secret-scanning/responsible-ai-generic-secrets +contentType: rai --- diff --git a/content/code-security/secret-scanning/copilot-secret-scanning/responsible-ai-regex-generator.md b/content/code-security/responsible-use/responsible-ai-regex-generator.md similarity index 94% rename from content/code-security/secret-scanning/copilot-secret-scanning/responsible-ai-regex-generator.md rename to content/code-security/responsible-use/responsible-ai-regex-generator.md index b22bad0c63a3..863eb49f5ec2 100644 --- a/content/code-security/secret-scanning/copilot-secret-scanning/responsible-ai-regex-generator.md +++ b/content/code-security/responsible-use/responsible-ai-regex-generator.md @@ -1,12 +1,11 @@ --- title: Responsible generation of regular expressions with Copilot secret scanning -shortTitle: Generate regular expressions with AI -intro: 'Learn about the capabilities and limitations of the {% data variables.secret-scanning.custom-pattern-regular-expression-generator %} in helping you to define custom patterns to extend the capabilities of {% data variables.product.prodname_secret_scanning %}.' +shortTitle: Regular expressions generator +intro: Learn about the capabilities and limitations of the {% data variables.secret-scanning.custom-pattern-regular-expression-generator %} in helping you to define custom patterns to extend the capabilities of {% data variables.product.prodname_secret_scanning %}. product: '{% data reusables.rai.secret-scanning.copilot-secret-scanning-gated-feature %}' allowTitleToDifferFromFilename: true versions: feature: secret-scanning-custom-pattern-ai-generated -type: rai topics: - Secret Protection - Secret scanning @@ -18,6 +17,8 @@ redirect_from: - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/about-generating-regular-expressions-with-ai - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/responsible-use-ai-regex-generator - /code-security/secret-scanning/copilot-secret-scanning/responsible-use-ai-regex-generator + - /code-security/secret-scanning/copilot-secret-scanning/responsible-ai-regex-generator +contentType: rai --- diff --git a/content/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning.md b/content/code-security/responsible-use/responsible-use-autofix-code-scanning.md similarity index 97% rename from content/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning.md rename to content/code-security/responsible-use/responsible-use-autofix-code-scanning.md index 4351a7e817ef..0c4e2bffd82a 100644 --- a/content/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning.md +++ b/content/code-security/responsible-use/responsible-use-autofix-code-scanning.md @@ -1,12 +1,11 @@ --- title: Responsible use of Copilot Autofix for code scanning shortTitle: Copilot Autofix for code scanning -intro: Learn how GitHub uses AI to suggest potential fixes for {% data variables.product.prodname_code_scanning %} alerts and find out how best to mitigate limitations in the AI suggestions. +intro: Learn how {% data variables.product.github %} uses AI to suggest potential fixes for {% data variables.product.prodname_code_scanning %} alerts and find out how best to mitigate limitations in the AI suggestions. allowTitleToDifferFromFilename: true product: '{% data reusables.rai.code-scanning.gated-feature-autofix %}' versions: feature: code-scanning-autofix -type: rai topics: - Code Security - Code scanning @@ -14,6 +13,8 @@ topics: - AI redirect_from: - /code-security/code-scanning/managing-code-scanning-alerts/about-autofix-for-codeql-code-scanning + - /code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning +contentType: rai --- ## About {% data variables.copilot.copilot_autofix_short %} for {% data variables.product.prodname_code_scanning %} diff --git a/content/code-security/secret-scanning/copilot-secret-scanning/index.md b/content/code-security/secret-scanning/copilot-secret-scanning/index.md index 0ca6512eaf93..aa1a7a689041 100644 --- a/content/code-security/secret-scanning/copilot-secret-scanning/index.md +++ b/content/code-security/secret-scanning/copilot-secret-scanning/index.md @@ -2,7 +2,7 @@ title: Enhance your secret detection capabilities with Copilot secret scanning shortTitle: Copilot secret scanning allowTitleToDifferFromFilename: true -intro: 'Learn how {% data variables.product.prodname_secret_scanning %} uses AI to detect generic secrets in your code, and generate regular expressions for your custom patterns.' +intro: Learn how {% data variables.product.prodname_secret_scanning %} uses AI to detect generic secrets in your code, and generate regular expressions for your custom patterns. product: '{% data reusables.rai.secret-scanning.copilot-secret-scanning-gated-feature %}' versions: ghec: '*' @@ -12,10 +12,9 @@ topics: - Repositories - Copilot children: - - /responsible-ai-generic-secrets - /enabling-ai-powered-generic-secret-detection - - /responsible-ai-regex-generator - /generating-regular-expressions-for-custom-patterns-with-copilot-secret-scanning redirect_from: - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection --- + From a1dd687ce120f3cf759400a6c37c6cd409b05004 Mon Sep 17 00:00:00 2001 From: Melanie Yarbrough <11952755+myarb@users.noreply.github.com> Date: Tue, 13 Jan 2026 09:26:40 -0500 Subject: [PATCH 7/7] [EDI] Move the "End-to-end supply chain" map topic into "Tutorials" (#59098) --- content/code-security/supply-chain-security/index.md | 4 ++-- .../end-to-end-supply-chain-overview.md | 5 ++++- .../implement-supply-chain-best-practices}/index.md | 8 ++++++-- .../securing-accounts.md | 3 +++ .../securing-builds.md | 3 +++ .../securing-code.md | 3 +++ content/code-security/tutorials/index.md | 7 ++++--- data/learning-tracks/code-security.yml | 8 ++++---- 8 files changed, 29 insertions(+), 12 deletions(-) rename content/code-security/{supply-chain-security/end-to-end-supply-chain => tutorials/implement-supply-chain-best-practices}/end-to-end-supply-chain-overview.md (89%) rename content/code-security/{supply-chain-security/end-to-end-supply-chain => tutorials/implement-supply-chain-best-practices}/index.md (51%) rename content/code-security/{supply-chain-security/end-to-end-supply-chain => tutorials/implement-supply-chain-best-practices}/securing-accounts.md (99%) rename content/code-security/{supply-chain-security/end-to-end-supply-chain => tutorials/implement-supply-chain-best-practices}/securing-builds.md (98%) rename content/code-security/{supply-chain-security/end-to-end-supply-chain => tutorials/implement-supply-chain-best-practices}/securing-code.md (98%) diff --git a/content/code-security/supply-chain-security/index.md b/content/code-security/supply-chain-security/index.md index f14e6bb758a3..8e3b35481194 100644 --- a/content/code-security/supply-chain-security/index.md +++ b/content/code-security/supply-chain-security/index.md @@ -2,7 +2,7 @@ title: Securing your software supply chain shortTitle: Supply chain security allowTitleToDifferFromFilename: true -intro: 'Visualize, maintain, and secure the dependencies in your software supply chain.' +intro: Visualize, maintain, and secure the dependencies in your software supply chain. redirect_from: - /categories/managing-security-vulnerabilities - /github/managing-security-vulnerabilities @@ -16,5 +16,5 @@ topics: - Repositories children: - /understanding-your-software-supply-chain - - /end-to-end-supply-chain --- + diff --git a/content/code-security/supply-chain-security/end-to-end-supply-chain/end-to-end-supply-chain-overview.md b/content/code-security/tutorials/implement-supply-chain-best-practices/end-to-end-supply-chain-overview.md similarity index 89% rename from content/code-security/supply-chain-security/end-to-end-supply-chain/end-to-end-supply-chain-overview.md rename to content/code-security/tutorials/implement-supply-chain-best-practices/end-to-end-supply-chain-overview.md index 296cada673dd..6604a6c960d9 100644 --- a/content/code-security/supply-chain-security/end-to-end-supply-chain/end-to-end-supply-chain-overview.md +++ b/content/code-security/tutorials/implement-supply-chain-best-practices/end-to-end-supply-chain-overview.md @@ -2,7 +2,7 @@ title: Securing your end-to-end supply chain shortTitle: Overview allowTitleToDifferFromFilename: true -intro: 'Introducing best practice guides on complete end-to-end supply chain security including personal accounts, code, and build processes.' +intro: Introducing best practice guides on complete end-to-end supply chain security including personal accounts, code, and build processes. versions: fpt: '*' ghec: '*' @@ -13,6 +13,9 @@ topics: - Teams - Dependencies - Code Security +redirect_from: + - /code-security/supply-chain-security/end-to-end-supply-chain/end-to-end-supply-chain-overview +contentType: tutorials --- ## What is the end-to-end supply chain? diff --git a/content/code-security/supply-chain-security/end-to-end-supply-chain/index.md b/content/code-security/tutorials/implement-supply-chain-best-practices/index.md similarity index 51% rename from content/code-security/supply-chain-security/end-to-end-supply-chain/index.md rename to content/code-security/tutorials/implement-supply-chain-best-practices/index.md index 598d609e0452..fc1afaae7c8b 100644 --- a/content/code-security/supply-chain-security/end-to-end-supply-chain/index.md +++ b/content/code-security/tutorials/implement-supply-chain-best-practices/index.md @@ -1,6 +1,6 @@ --- -title: End-to-end supply chain -intro: 'How to think about securing your user accounts, your code, and your build process' +title: Implement supply chain best practices +intro: How to think about securing your user accounts, your code, and your build process versions: fpt: '*' ghec: '*' @@ -16,4 +16,8 @@ children: - /securing-accounts - /securing-code - /securing-builds +redirect_from: + - /code-security/supply-chain-security/end-to-end-supply-chain +contentType: tutorials --- + diff --git a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts.md b/content/code-security/tutorials/implement-supply-chain-best-practices/securing-accounts.md similarity index 99% rename from content/code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts.md rename to content/code-security/tutorials/implement-supply-chain-best-practices/securing-accounts.md index 51884a55312c..249269399fa7 100644 --- a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts.md +++ b/content/code-security/tutorials/implement-supply-chain-best-practices/securing-accounts.md @@ -14,6 +14,9 @@ topics: - SSH - Security - Accounts +redirect_from: + - /code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts +contentType: tutorials --- ## About this guide diff --git a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-builds.md b/content/code-security/tutorials/implement-supply-chain-best-practices/securing-builds.md similarity index 98% rename from content/code-security/supply-chain-security/end-to-end-supply-chain/securing-builds.md rename to content/code-security/tutorials/implement-supply-chain-best-practices/securing-builds.md index 2c83c9acb40e..c06035a621ba 100644 --- a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-builds.md +++ b/content/code-security/tutorials/implement-supply-chain-best-practices/securing-builds.md @@ -13,6 +13,9 @@ topics: - Security - CI - CD +redirect_from: + - /code-security/supply-chain-security/end-to-end-supply-chain/securing-builds +contentType: tutorials --- ## About this guide diff --git a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-code.md b/content/code-security/tutorials/implement-supply-chain-best-practices/securing-code.md similarity index 98% rename from content/code-security/supply-chain-security/end-to-end-supply-chain/securing-code.md rename to content/code-security/tutorials/implement-supply-chain-best-practices/securing-code.md index 278daddd6761..0fa19d2ea615 100644 --- a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-code.md +++ b/content/code-security/tutorials/implement-supply-chain-best-practices/securing-code.md @@ -15,6 +15,9 @@ topics: - Code Security - Secret Protection - Secret scanning +redirect_from: + - /code-security/supply-chain-security/end-to-end-supply-chain/securing-code +contentType: tutorials --- ## About this guide diff --git a/content/code-security/tutorials/index.md b/content/code-security/tutorials/index.md index d4373c314c30..ef6841b008d8 100644 --- a/content/code-security/tutorials/index.md +++ b/content/code-security/tutorials/index.md @@ -16,12 +16,13 @@ topics: - Dependabot contentType: tutorials children: - - /secure-your-organization - - /remediate-leaked-secrets - - /customize-code-scanning - /trialing-github-advanced-security - /adopting-github-advanced-security-at-scale + - /secure-your-organization + - /remediate-leaked-secrets - /secret-scanning-partner-program + - /customize-code-scanning + - /implement-supply-chain-best-practices - /manage-security-alerts - /improve-code-quality - /fix-reported-vulnerabilities diff --git a/data/learning-tracks/code-security.yml b/data/learning-tracks/code-security.yml index d67a42cc5a8c..73ff1faf3796 100644 --- a/data/learning-tracks/code-security.yml +++ b/data/learning-tracks/code-security.yml @@ -216,9 +216,9 @@ end_to_end_supply_chain: process. guides: - >- - /code-security/supply-chain-security/end-to-end-supply-chain/end-to-end-supply-chain-overview + /code-security/tutorials/implement-supply-chain-best-practices/end-to-end-supply-chain-overview - >- - /code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts - - /code-security/supply-chain-security/end-to-end-supply-chain/securing-code + /code-security/tutorials/implement-supply-chain-best-practices/securing-accounts + - /code-security/tutorials/implement-supply-chain-best-practices/securing-code - >- - /code-security/supply-chain-security/end-to-end-supply-chain/securing-builds + /code-security/tutorials/implement-supply-chain-best-practices/securing-builds