jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-21 19:06:49 -05:00
Code Issues Projects Releases Wiki Activity

Create function to allow a reusable to link current article in a different docs version (#34273)

Browse Source 
Co-authored-by: Peter Bengtsson <peterbe@github.com>
This commit is contained in:
Felicity Chapman
2023-02-02 09:30:34 +00:00
committed by GitHub
parent d09e48e2fc
commit 03a971c25a
18 changed files with 65 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
content/code-security/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli.md
View File

@@ -18,6 +18,8 @@ topics:
## About analyzing databases with the {% data variables.product.prodname_codeql_cli %}
{% data reusables.code-scanning.codeql-cli-version-ghes %}
To analyze a codebase, you run queries against a CodeQL
database extracted from the code.

8
content/code-security/codeql-cli/using-the-codeql-cli/creating-and-working-with-codeql-packs.md
View File

@@ -16,13 +16,7 @@ topics:
## About {% data variables.product.prodname_codeql %} packs and the {% data variables.product.prodname_codeql_cli %}
{% ifversion ghes %}
{% note %}
**Note:** If you have manually updated your {% data variables.product.prodname_codeql_cli %} version to a newer version than what is covered in this article, please see “[Creating and working with {% data variables.product.prodname_codeql %} packs](/enterprise-cloud@latest/code-security/codeql-cli/using-the-codeql-cli/creating-and-working-with-codeql-packs)”, the Enterprise Cloud version, for the most up-to-date documentation.
{% endnote %}
{% endif %}
{% data reusables.code-scanning.codeql-cli-version-ghes %}
With {% data variables.product.prodname_codeql %} packs and the package management commands in the {% data variables.product.prodname_codeql_cli %}, you can publish your custom queries and integrate them into your codebase analysis.

2
content/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases.md
View File

@@ -17,6 +17,8 @@ topics:
## About creating {% data variables.product.prodname_codeql %} databases
{% data reusables.code-scanning.codeql-cli-version-ghes %}
Before you analyze your code using {% data variables.product.prodname_codeql %}, you need to create a {% data variables.product.prodname_codeql %} database containing all the data required to run queries on your code. You can create {% data variables.product.prodname_codeql %} databases yourself using the {% data variables.product.prodname_codeql_cli %}, or download them from {% data variables.product.prodname_dotcom_the_website %}.
{% data variables.product.prodname_codeql %} analysis relies on extracting relational data from your code, and using it to build a [{% data variables.product.prodname_codeql %} database](https://codeql.github.com/docs/codeql-overview/codeql-glossary/#codeql-database). {% data variables.product.prodname_codeql %} databases contain all of the important information about a codebase, which can be analyzed by executing {% data variables.product.prodname_codeql %} queries against it. {% data variables.product.prodname_dotcom %} creates and stores {% data variables.product.prodname_codeql %} databases for a large number of open-source projects. For more information, see “[Downloading {% data variables.product.prodname_codeql %} databases from {% data variables.product.prodname_dotcom_the_website %}](/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases#downloading-databases-from-githubcom).”

2
content/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites.md
View File

@@ -17,6 +17,8 @@ topics:
## About creating {% data variables.product.prodname_codeql %} query suites
{% data reusables.code-scanning.codeql-cli-version-ghes %}
{% data variables.product.prodname_codeql %} query suites provide a way of selecting queries, based on their
filename, location on disk{% ifversion codeql-packs %} or in a {% data variables.product.prodname_codeql %} pack{% endif %}, or metadata properties.
Create query suites for the queries that you want to frequently use in

2
content/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli.md
View File

@@ -18,6 +18,8 @@ topics:
## Getting started with the {% data variables.product.prodname_codeql_cli %}
{% data reusables.code-scanning.codeql-cli-version-ghes %}
To run {% data variables.product.prodname_codeql %} commands, you need to set up the CLI so that it can access
the tools, queries, and libraries required to create and analyze databases.

8
content/code-security/codeql-cli/using-the-codeql-cli/publishing-and-using-codeql-packs.md
View File

@@ -16,13 +16,7 @@ topics:
## Configuring the `qlpack.yml` file before publishing
{% ifversion ghes %}
{% note %}
**Note:** If you have manually updated your {% data variables.product.prodname_codeql_cli %} version to a newer version than what is covered in this article, please see “[Publishing and using {% data variables.product.prodname_codeql %} packs](/enterprise-cloud@latest/code-security/codeql-cli/using-the-codeql-cli/publishing-and-using-codeql-packs)”, the Enterprise Cloud version, for the most up-to-date documentation.
{% endnote %}
{% endif %}
{% data reusables.code-scanning.codeql-cli-version-ghes %}
You can check and modify the configuration details of your {% data variables.product.prodname_codeql %} pack prior to publishing. Open the `qlpack.yml` file in your preferred text editor.