Skip to content

Commit 5442d0a

Browse files
[EDI] Creating CodeQL CLI database bundles (#59987)
1 parent 9039673 commit 5442d0a

2 files changed

Lines changed: 8 additions & 11 deletions

File tree

content/code-security/concepts/code-scanning/codeql/about-the-codeql-cli.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,12 @@ The {% data variables.product.prodname_codeql_cli %} uses special programs, call
115115

116116
{% data reusables.code-scanning.codeql-license %}
117117

118+
## About {% data variables.product.prodname_codeql_cli %} database bundles
119+
120+
The {% data variables.product.prodname_codeql_cli %} database bundle command can be used to create a relocatable archive of a {% data variables.product.prodname_codeql %} database.
121+
122+
A copy of a database bundle can be used to share troubleshooting information with your team members or with {% data variables.contact.github_support %}. See [AUTOTITLE](/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/creating-database-bundle-for-troubleshooting).
123+
118124
## Getting started
119125

120126
For the simplest way to get started, see [AUTOTITLE](/code-security/codeql-cli/getting-started-with-the-codeql-cli/setting-up-the-codeql-cli).

content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/creating-database-bundle-for-troubleshooting.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Creating CodeQL CLI database bundles
33
shortTitle: Creating CodeQL CLI database bundles
4-
intro: You can create a database bundle with {% data variables.product.prodname_codeql %} troubleshooting information.
4+
intro: Create a database bundle with {% data variables.product.prodname_codeql %} troubleshooting information.
55
allowTitleToDifferFromFilename: true
66
product: '{% data reusables.gated-features.codeql %}'
77
versions:
@@ -19,18 +19,9 @@ contentType: how-tos
1919

2020
{% data reusables.code-scanning.codeql-database-archive-contains-source-code %}
2121

22-
## About creating {% data variables.product.prodname_codeql_cli %} database bundles
23-
2422
{% data reusables.code-scanning.codeql-cli-version-ghes %}
2523

26-
The {% data variables.product.prodname_codeql_cli %} database bundle command can be used to create a relocatable archive of a {% data variables.product.prodname_codeql %} database.
27-
28-
A copy of a database bundle can be used to share troubleshooting information with your team members or with {% data variables.contact.github_support %}.
29-
30-
The following {% data variables.product.prodname_codeql_cli %} command syntax is suggested when creating a database bundle for troubleshooting purposes:
31-
32-
> [!NOTE]
33-
> This sample `database bundle` command requires {% data variables.product.prodname_codeql_cli %} version {% data variables.product.codeql_cli_version_min_version_create_bundle %} or higher.
24+
The following {% data variables.product.prodname_codeql_cli %} command syntax is suggested when creating a database bundle for troubleshooting purposes. This sample `database bundle` command requires {% data variables.product.prodname_codeql_cli %} version {% data variables.product.codeql_cli_version_min_version_create_bundle %} or higher.
3425

3526
```shell
3627
codeql database bundle --output=codeql-debug-artifacts.zip --include-diagnostics --include-logs --include-results -- <dir>

0 commit comments

Comments
 (0)