Fix multiple blank lines in content and data (#37909)
This commit is contained in:
@@ -77,10 +77,8 @@ codeql database analyze <database> --format=<format> --output=<output> <query-sp
|
||||
|
||||
You must specify:
|
||||
|
||||
|
||||
- `<database>`: the path to the {% data variables.product.prodname_codeql %} database you want to analyze.
|
||||
- `--format`: the format of the results file generated during analysis. A
|
||||
number of different formats are supported, including CSV, [SARIF](https://codeql.github.com/docs/codeql-overview/codeql-glossary/#sarif-file), and graph formats. For more information about CSV and SARIF,
|
||||
- `--format`: the format of the results file generated during analysis. A number of different formats are supported, including CSV, [SARIF](https://codeql.github.com/docs/codeql-overview/codeql-glossary/#sarif-file), and graph formats. For more information about CSV and SARIF,
|
||||
see [Results](#results). To find out which other results formats are
|
||||
supported, see "[AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/database-analyze)."
|
||||
- `--output`: the output path of the results file generated during analysis.
|
||||
@@ -131,13 +129,8 @@ For full details of all the options you can use when analyzing databases, see "[
|
||||
Query specifiers are used by `codeql database analyze` and other commands that operate on a set of queries.
|
||||
The complete form of a query specifier is `scope/name@range:path`, where:
|
||||
|
||||
|
||||
- `scope/name` is the qualified name of a {% data variables.product.prodname_codeql %} pack.
|
||||
|
||||
|
||||
- `range` is a [semver range](https://docs.npmjs.com/cli/v6/using-npm/semver#ranges).
|
||||
|
||||
|
||||
- `path` is a file system path to a single query, a directory containing queries, or a query suite file.
|
||||
|
||||
When you specify a `scope/name`, the `range` and `path` are
|
||||
@@ -157,7 +150,6 @@ pack.
|
||||
|
||||
### Example query specifiers
|
||||
|
||||
|
||||
- `codeql/python-queries` - All the queries in the default query suite of the latest version of the `codeql/python-queries` pack.
|
||||
|
||||
- `codeql/python-queries@1.2.3` - All the queries in the default query suite of version `1.2.3` of the `codeql/python-queries` pack.
|
||||
@@ -284,13 +276,10 @@ If you are using {% data variables.product.prodname_codeql_cli %} v2.8.1 or late
|
||||
|
||||
The complete way to specify a set of queries is in the form `scope/name@range:path`, where:
|
||||
|
||||
|
||||
- `scope/name` is the qualified name of a {% data variables.product.prodname_codeql %} pack.
|
||||
|
||||
|
||||
- `range` is a [semver range](https://docs.npmjs.com/cli/v6/using-npm/semver#ranges).
|
||||
|
||||
|
||||
- `path` is a file system path to a single query, a directory containing queries, or a query suite file.
|
||||
|
||||
When you specify a `scope/name`, the `range` and `path` are
|
||||
|
||||
@@ -34,7 +34,6 @@ You can use the `pack` command in the {% data variables.product.prodname_codeql_
|
||||
For more information about compatibility between published query packs and different {% data variables.product.prodname_codeql %} releases, see "[About {% data variables.product.prodname_codeql %} pack compatibility](/code-security/codeql-cli/using-the-codeql-cli/publishing-and-using-codeql-packs#about-codeql-pack-compatibility)."
|
||||
{% endif %}
|
||||
|
||||
|
||||
## Creating a {% data variables.product.prodname_codeql %} pack
|
||||
|
||||
You can create a {% data variables.product.prodname_codeql %} pack by running the following command from the checkout root of your project:
|
||||
@@ -45,10 +44,8 @@ codeql pack init <scope>/<pack>
|
||||
|
||||
You must specify:
|
||||
|
||||
|
||||
- `<scope>`: the name of the {% data variables.product.prodname_dotcom %} organization or user account that you will publish to.
|
||||
|
||||
|
||||
- `<pack>`: the name for the pack that you are creating.
|
||||
|
||||
The `codeql pack init` command creates the directory structure and configuration files for a {% data variables.product.prodname_codeql %} pack. By default, the command creates a query pack. If you want to create a library pack, you must edit the `qlpack.yml` file to explicitly declare the file as a library pack by including the `library:true` property.
|
||||
@@ -57,13 +54,10 @@ The `codeql pack init` command creates the directory structure and configuration
|
||||
|
||||
If you already have a `qlpack.yml` file, you can edit it manually to convert it into a {% data variables.product.prodname_codeql %} pack.
|
||||
|
||||
|
||||
1. Edit the `name` property so that it matches the format `<scope>/<name>`, where `<scope>` is the name of the {% data variables.product.prodname_dotcom %} organization or user account that you will publish to.
|
||||
|
||||
|
||||
2. In the `qlpack.yml` file, include a `version` property with a semver identifier, as well as an optional `dependencies` block.
|
||||
|
||||
|
||||
3. Migrate the list of dependencies in `libraryPathDependencies` to the `dependencies` block. Specify the version range for each dependency. If the range is unimportant, or you are unsure of compatibility, you can specify `"\*"`, which indicates that any version is acceptable and will default to the latest version when you run `codeql pack install`.
|
||||
|
||||
For more information about the properties, see "[About {% data variables.product.prodname_codeql %} packs](/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs#about-codeql-packs)."
|
||||
|
||||
@@ -33,10 +33,8 @@ default-suite-file: default-queries.qls # optional, a pointer to a query-suite i
|
||||
license: # optional, the license under which the pack is published
|
||||
dependencies: # map from CodeQL pack name to version range
|
||||
```
|
||||
|
||||
- `name:` must follow the `<scope>/<pack>` format, where `<scope>` is the {% data variables.product.prodname_dotcom %} organization that you will publish to and <pack> is the name for the pack.
|
||||
|
||||
|
||||
- A maximum of one of `default-suite` or `default-suite-file` is allowed. These are two different ways to define a default query suite to be run, the first by specifying queries directly in the qlpack.yml file and the second by specifying a query suite in the pack.
|
||||
|
||||
## Running `codeql pack publish`
|
||||
|
||||
Reference in New Issue
Block a user