1
0
mirror of synced 2025-12-23 03:44:00 -05:00

Add HTML comments for MS short links (#34903)

This commit is contained in:
Felicity Chapman
2023-02-21 08:45:28 +00:00
committed by GitHub
parent 6312d67f24
commit a44da9be99
4 changed files with 17 additions and 3 deletions

View File

@@ -16,6 +16,9 @@ topics:
- Enterprise - Enterprise
- Security - Security
--- ---
<!--The CodeQL CLI man pages include a link to a section in this article. If you rename this article,
make sure that you also update the MS short link: https://aka.ms/code-scanning-docs/configuring-ghes.-->
{% data reusables.code-scanning.beta %} {% data reusables.code-scanning.beta %}
@@ -41,8 +44,8 @@ You can configure {% data variables.product.prodname_code_scanning %} to run {%
## Running {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_actions %} ## Running {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_actions %}
<!-- Note that the CodeQL CLI manual pages link to this heading: https://aka.ms/code-scanning-docs-configuring-ghes. <!--The CodeQL CLI man pages include a link to this section of the article. If you rename this section,
If you edit this heading, update the short link too.--> make sure that you also update the MS short link: https://aka.ms/code-scanning-docs/configuring-ghes.-->
### Setting up a self-hosted runner ### Setting up a self-hosted runner

View File

@@ -24,7 +24,8 @@ topics:
- Python - Python
shortTitle: Customize code scanning shortTitle: Customize code scanning
--- ---
<!--The CodeQL CLI man pages include a link to a section of the article. If you rename this article,
make sure that you also update the MS short link: https://aka.ms/code-scanning-docs/config-file.-->
{% data reusables.code-scanning.beta %} {% data reusables.code-scanning.beta %}
{% data reusables.code-scanning.enterprise-enable-code-scanning-actions %} {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %}
@@ -404,6 +405,9 @@ In the following example, the `+` symbol ensures that the specified additional {
## Using a custom configuration file ## Using a custom configuration file
<!--The CodeQL CLI man pages include a link to this section of the article. If you rename this section,
make sure that you also update the MS short link: https://aka.ms/code-scanning-docs/config-file.-->
A custom configuration file is an alternative way to specify additional {% ifversion codeql-packs %}packs and {% endif %}queries to run. You can also use the file to disable the default queries{% ifversion code-scanning-exclude-queries-from-analysis %}, exclude or include specific queries,{% endif %} and to specify which directories to scan during analysis. A custom configuration file is an alternative way to specify additional {% ifversion codeql-packs %}packs and {% endif %}queries to run. You can also use the file to disable the default queries{% ifversion code-scanning-exclude-queries-from-analysis %}, exclude or include specific queries,{% endif %} and to specify which directories to scan during analysis.
In the workflow file, use the `config-file` parameter of the `init` action to specify the path to the configuration file you want to use. This example loads the configuration file _./.github/codeql/codeql-config.yml_. In the workflow file, use the `config-file` parameter of the `init` action to specify the path to the configuration file you want to use. This example loads the configuration file _./.github/codeql/codeql-config.yml_.

View File

@@ -12,6 +12,8 @@ topics:
- Code scanning - Code scanning
- CodeQL - CodeQL
--- ---
<!--The CodeQL CLI man pages include a link to a section in this article. If you rename this article,
make sure that you also update the MS short link: https://aka.ms/codeql-docs/indirect-tracing.-->
{% data reusables.codeql-cli.codeql-site-migration-note %} {% data reusables.codeql-cli.codeql-site-migration-note %}
@@ -241,6 +243,9 @@ This command runs a custom script that contains all of the commands required to
### Using indirect build tracing ### Using indirect build tracing
<!--The CodeQL CLI man pages include a link to this section of the article. If you rename this section,
make sure that you also update the MS short link: https://aka.ms/codeql-docs/indirect-tracing.-->
If the {% data variables.product.prodname_codeql_cli %} autobuilders for compiled languages do not work with your CI workflow and you cannot wrap invocations of build commands with `codeql database trace-command`, you can use indirect build tracing to create a {% data variables.product.prodname_codeql %} database. To use indirect build tracing, your CI system must be able to set custom environment variables for each build action. If the {% data variables.product.prodname_codeql_cli %} autobuilders for compiled languages do not work with your CI workflow and you cannot wrap invocations of build commands with `codeql database trace-command`, you can use indirect build tracing to create a {% data variables.product.prodname_codeql %} database. To use indirect build tracing, your CI system must be able to set custom environment variables for each build action.
To create a {% data variables.product.prodname_codeql %} database with indirect build tracing, run the following command from the checkout root of your project: To create a {% data variables.product.prodname_codeql %} database with indirect build tracing, run the following command from the checkout root of your project:

View File

@@ -12,6 +12,8 @@ topics:
- Code scanning - Code scanning
- CodeQL - CodeQL
--- ---
<!--The CodeQL CLI man pages include a link to this article. If you rename this article,
make sure that you also update the MS short link: https://aka.ms/codeql-cli-docs/extractor-options.-->
{% data reusables.codeql-cli.codeql-site-migration-note %} {% data reusables.codeql-cli.codeql-site-migration-note %}