Make sure there is a blank line above and below headings (#37922)
This commit is contained in:
@@ -45,6 +45,7 @@ The other files and directories within the pack should be logically organized. F
|
||||
their own top-level directories.
|
||||
|
||||
{% ifversion query-pack-compatibility %}
|
||||
|
||||
### About published packs
|
||||
|
||||
When a pack is published for use in analyses, the `codeql pack create` or `codeql pack publish` command verifies that the content is complete and also adds some additional pieces of content to it:
|
||||
@@ -141,6 +142,7 @@ The following properties are supported in `qlpack.yml` files.
|
||||
```
|
||||
|
||||
#### `tests`
|
||||
|
||||
- Optional for packs containing {% data variables.product.prodname_codeql %} tests. Ignored for packs without tests.
|
||||
- Defines the path to a directory within the pack that contains tests, defined relative to the pack directory. Use `.` to specify the whole pack. Any queries in this directory are run as tests when `test run` is run with the `--strict-test-discovery` option. These queries are ignored by query suite definitions that use `queries` or `qlpack` instructions to ask for all queries in a particular pack. If this property is missing, then `.` is assumed. For example:
|
||||
|
||||
@@ -149,6 +151,7 @@ The following properties are supported in `qlpack.yml` files.
|
||||
```
|
||||
|
||||
#### `extractor`
|
||||
|
||||
- Required by all packs containing {% data variables.product.prodname_codeql %} tests.
|
||||
- Defines the {% data variables.product.prodname_codeql %} language extractor to use when running the {% data variables.product.prodname_codeql %} tests in the pack. For more information about testing queries, see "[Testing custom queries](/code-security/codeql-cli/using-the-codeql-cli/testing-custom-queries)." For example:
|
||||
|
||||
@@ -157,6 +160,7 @@ The following properties are supported in `qlpack.yml` files.
|
||||
```
|
||||
|
||||
#### `authors`
|
||||
|
||||
- Optional.
|
||||
- Defines metadata that will be displayed on the packaging search page in the packages section of the account that the {% data variables.product.prodname_codeql %} pack is published to. For example:
|
||||
|
||||
@@ -165,6 +169,7 @@ The following properties are supported in `qlpack.yml` files.
|
||||
```
|
||||
|
||||
#### `license`
|
||||
|
||||
- Optional.
|
||||
- Defines metadata that will be displayed on the packaging search page in the packages section of the account that the {% data variables.product.prodname_codeql %} pack is published to. For a list of allowed licenses, see [SPDX License List](https://spdx.org/licenses/) in the SPDX Specification. For example:
|
||||
|
||||
@@ -173,6 +178,7 @@ The following properties are supported in `qlpack.yml` files.
|
||||
```
|
||||
|
||||
#### `description`
|
||||
|
||||
- Optional.
|
||||
- Defines metadata that will be displayed on the packaging search page in the packages section of the account that the {% data variables.product.prodname_codeql %} pack is published to. For example:
|
||||
|
||||
@@ -181,6 +187,7 @@ The following properties are supported in `qlpack.yml` files.
|
||||
```
|
||||
|
||||
#### `libraryPathDependencies`
|
||||
|
||||
- Optional, deprecated. Use the `dependencies` property instead.
|
||||
- Previously used to define the names of any {% data variables.product.prodname_codeql %} packs that this {% data variables.product.prodname_codeql %} pack depends on, as an array. This gives the pack access to any libraries, database schema, and query suites defined in the dependency. For example:
|
||||
|
||||
@@ -189,6 +196,7 @@ The following properties are supported in `qlpack.yml` files.
|
||||
```
|
||||
|
||||
#### `dbscheme`
|
||||
|
||||
- Required by core language packs only.
|
||||
- Defines the path to the [database schema](https://codeql.github.com/docs/codeql-overview/codeql-glossary/#codeql-database-schema) for all libraries and queries written for this {% data variables.product.prodname_codeql %} language (see example below). For example:
|
||||
|
||||
@@ -197,6 +205,7 @@ The following properties are supported in `qlpack.yml` files.
|
||||
```
|
||||
|
||||
#### `upgrades`
|
||||
|
||||
- Required by core language packs only.
|
||||
- Defines the path to a directory within the pack that contains database upgrade scripts, defined relative to the pack directory. Database upgrades are used internally to ensure that a database created with a different version of the {% data variables.product.prodname_codeql_cli %} is compatible with the current version of the CLI. For example:
|
||||
|
||||
|
||||
@@ -58,6 +58,7 @@ This details each SARIF component that may be generated, along with any specific
|
||||
| `$schema`| {% octicon "check" aria-label="Always" %}| Provides a link to the [SARIF schema](https://github.com/oasis-tcs/sarif-spec/blob/123e95847b13fbdd4cbe2120fa5e33355d4a042b/Schemata/sarif-schema-2.1.0.json).|
|
||||
| `version`| {% octicon "check" aria-label="Always" %}| The version of the SARIF used to generate the output.|
|
||||
| `runs`| {% octicon "check" aria-label="Always" %}| An array containing a single run object, for one language.|
|
||||
|
||||
### `run` object
|
||||
|
||||
| JSON property name| Always generated?| Notes|
|
||||
@@ -173,6 +174,7 @@ For character offset and length regions, the following properties will be set:
|
||||
| `snippet`| {% octicon "x" aria-label="Optionally" %}| None |
|
||||
|
||||
### `codeFlow` object
|
||||
|
||||
| JSON property name| Always generated?| Notes|
|
||||
|-----------------------|--------------------|------|
|
||||
| `threadFlows`| {% octicon "check" aria-label="Always" %}| None |
|
||||
|
||||
Reference in New Issue
Block a user