Fix heading-increment violations (#43054)
This commit is contained in:
@@ -118,7 +118,7 @@ env:
|
||||
|
||||
{% data variables.product.prodname_dotcom %} offers ternary operator like behaviour that you can use in expressions. By using a ternary operator in this way, you can dynamically set the value of an environment variable based on a condition, without having to write separate if-else blocks for each possible option.
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
{% raw %}
|
||||
|
||||
|
||||
@@ -337,7 +337,7 @@ jobs:
|
||||
|
||||
### Building with Node.js
|
||||
|
||||
##### Travis CI for building with Node.js
|
||||
#### Travis CI for building with Node.js
|
||||
|
||||
{% raw %}
|
||||
|
||||
@@ -351,7 +351,7 @@ script:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
##### {% data variables.product.prodname_actions %} workflow for building with Node.js
|
||||
#### {% data variables.product.prodname_actions %} workflow for building with Node.js
|
||||
|
||||
```yaml
|
||||
name: Node.js CI
|
||||
|
||||
@@ -37,7 +37,7 @@ The decoded output will be written to standard output, unless the
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<file>`
|
||||
#### `<file>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] BQRS file to decode.
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@ Compute the difference between two result sets.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<file1>`
|
||||
#### `<file1>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] First BQRS file to compare.
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@ codeql bqrs hash <options>... -- <file>
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<file>`
|
||||
#### `<file>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] BQRS file to hash.
|
||||
|
||||
|
||||
@@ -42,7 +42,7 @@ options of [codeql bqrs decode](/code-security/codeql-cli/codeql-cli-manual/bqrs
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<file>`
|
||||
#### `<file>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] BQRS file to show information about.
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ metadata and generates output in the specified format.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<bqrs-file>`
|
||||
#### `<bqrs-file>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] The BQRS file to interpret.
|
||||
|
||||
|
||||
@@ -36,7 +36,7 @@ Available since `v2.12.6`.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<database>`
|
||||
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the CodeQL database to bundle.
|
||||
|
||||
|
||||
@@ -45,7 +45,7 @@ being interpreted as source-code alerts, use
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<database>`
|
||||
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the CodeQL database to query.
|
||||
|
||||
|
||||
@@ -38,7 +38,7 @@ that results, logs, TRAP, or similar should be included.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<database>`
|
||||
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the CodeQL database to bundle.
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ possible on disk without degrading its future usefulness.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<database>`
|
||||
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the CodeQL database to clean up.
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ one of the CodeQL products.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<database>`
|
||||
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the CodeQL database to create. This directory will
|
||||
be created, and _must not_ already exist (but its parent must).
|
||||
|
||||
@@ -39,7 +39,7 @@ Available since `v2.12.6`.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<database>`
|
||||
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the CodeQL database under construction. This must
|
||||
have been prepared for extraction with [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init).
|
||||
|
||||
@@ -36,7 +36,7 @@ Finalize a database that was created with [codeql database init](/code-security/
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<database>`
|
||||
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the CodeQL database under construction. This must
|
||||
have been prepared for extraction with [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init).
|
||||
|
||||
@@ -50,7 +50,7 @@ meaningful.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<database>`
|
||||
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the CodeQL database under construction. This must
|
||||
have been prepared for extraction with [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init).
|
||||
|
||||
@@ -49,7 +49,7 @@ patterns, which can use the following wildcard characters:
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<database>`
|
||||
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the CodeQL database under construction. This must
|
||||
have been prepared for extraction with [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init).
|
||||
|
||||
@@ -43,7 +43,7 @@ extractors in the middle of an extraction operation anyway.)
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<database>`
|
||||
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the CodeQL database to create. This directory will
|
||||
be created, and _must not_ already exist (but its parent must).
|
||||
|
||||
@@ -40,7 +40,7 @@ directory using [codeql database run-queries](/code-security/codeql-cli/codeql-c
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<database>`
|
||||
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the CodeQL database that has been queried.
|
||||
|
||||
|
||||
@@ -45,7 +45,7 @@ source root.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<database>`
|
||||
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the CodeQL database under construction. This must
|
||||
have been prepared for extraction with [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init).
|
||||
|
||||
@@ -45,7 +45,7 @@ Alternatively, if you have only a single query to run, you might prefer
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<database>`
|
||||
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the CodeQL database to query.
|
||||
|
||||
|
||||
@@ -38,7 +38,7 @@ database.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<database>`
|
||||
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the CodeQL database under construction. This must
|
||||
have been prepared for extraction with [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init).
|
||||
|
||||
@@ -36,7 +36,7 @@ This command extracts a CodeQL database archive created by [codeql database bund
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<archive>`
|
||||
#### `<archive>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the CodeQL database archive to unzip.
|
||||
|
||||
|
||||
@@ -41,7 +41,7 @@ was created.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<database>`
|
||||
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the CodeQL database to upgrade.
|
||||
|
||||
|
||||
@@ -39,7 +39,7 @@ rule out issues in the underlying data as the cause.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<dataset>`
|
||||
#### `<dataset>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the raw QL dataset to check.
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ will make it impossible to import further data into the dataset.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<dataset>`
|
||||
#### `<dataset>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the raw QL dataset to clean up.
|
||||
|
||||
|
||||
@@ -39,7 +39,7 @@ initial import.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<dataset>`
|
||||
#### `<dataset>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the raw QL dataset to create or update. The
|
||||
directory will be created if it doesn't already exist.
|
||||
|
||||
@@ -42,7 +42,7 @@ optimizer.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<dataset>`
|
||||
#### `<dataset>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the raw QL dataset to measure.
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ This does the same as
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<dataset>`
|
||||
#### `<dataset>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the raw QL dataset to upgrade.
|
||||
|
||||
|
||||
@@ -36,7 +36,7 @@ Available since `v2.12.6`.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `--markdown-message=<markdownMessage>`
|
||||
#### `--markdown-message=<markdownMessage>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
Message for the diagnostic, in GitHub-flavored Markdown format.
|
||||
|
||||
|
||||
@@ -36,7 +36,7 @@ Available since `v2.12.6`.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `--format=<format>`
|
||||
#### `--format=<format>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] The format in which to write the results. One of:
|
||||
|
||||
|
||||
@@ -39,7 +39,7 @@ and output streams.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `--check-errors=<checkErrors>`
|
||||
#### `--check-errors=<checkErrors>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] How to check errors. One of: ON\_CHANGE, EXPLICIT.
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ This command should not normally be invoked directly. Instead use either
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<dataset>`
|
||||
#### `<dataset>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the raw QL dataset to query.
|
||||
|
||||
|
||||
@@ -41,7 +41,7 @@ Available since `v2.10.11`.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `--[no-]tuple-counting`
|
||||
#### `--[no-]tuple-counting` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Advanced] Display tuple counts for each evaluation step in the query
|
||||
evaluator logs. If the `--evaluator-log` option is provided, tuple
|
||||
|
||||
@@ -40,7 +40,7 @@ an error will be reported.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<dataset>`
|
||||
#### `<dataset>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the raw QL dataset to upgrade.
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@ found in the given pack.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<pack-root-dir>`
|
||||
#### `<pack-root-dir>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] The pack root directory for which we are reporting
|
||||
extensible predicate metadata.
|
||||
|
||||
@@ -41,7 +41,7 @@ event logs directly.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<input>`
|
||||
#### `<input>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the event log file to produce a summary of.
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@ Generate end-user query help from .qhelp files.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<qhelpdir|suite>...`
|
||||
#### `<qhelpdir|suite>...` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Query help files to render. Each argument is one of:
|
||||
|
||||
|
||||
@@ -44,7 +44,7 @@ This token must have the `security_events` scope.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `-s, --sarif=<file>`
|
||||
#### `-s, --sarif=<file>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Path to the SARIF file to upload. This should be the
|
||||
output of [codeql database analyze](/code-security/codeql-cli/codeql-cli-manual/database-analyze) (or [codeql database interpret-results](/code-security/codeql-cli/codeql-cli-manual/database-interpret-results)) with `--format sarif-latest` for upload to github.com or
|
||||
|
||||
@@ -42,7 +42,7 @@ Available since `v2.6.0`.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<scope/name[@range]>...`
|
||||
#### `<scope/name[@range]>...` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] The scope, name, and optional version range of the pack to
|
||||
add to the dependency list.
|
||||
|
||||
@@ -39,7 +39,7 @@ Available since `v2.6.3`.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<dir>`
|
||||
#### `<dir>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
The root directory of the package.
|
||||
|
||||
|
||||
@@ -50,7 +50,7 @@ Available since `v2.12.4`.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<dir>`
|
||||
#### `<dir>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
The root directory of the package.
|
||||
|
||||
|
||||
@@ -43,7 +43,7 @@ Available since `v2.6.0`.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<dir>`
|
||||
#### `<dir>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
The root directory of the package.
|
||||
|
||||
|
||||
@@ -44,7 +44,7 @@ Available since `v2.6.0`.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<scope/name[@version]|suite.qls>...`
|
||||
#### `<scope/name[@version]|suite.qls>...` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] List of CodeQL packs and query suites to download. If a
|
||||
query suite is provided, its instructions will be inspected and all
|
||||
|
||||
@@ -39,7 +39,7 @@ Available since `v2.6.0`.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<package-name>`
|
||||
#### `<package-name>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] The scope and name of the pack to create. Scope is only
|
||||
required if this pack is to be published.
|
||||
|
||||
@@ -46,7 +46,7 @@ Available since `v2.6.0`.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<dir>`
|
||||
#### `<dir>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
The root directory of the package.
|
||||
|
||||
|
||||
@@ -41,7 +41,7 @@ Available since `v2.7.1`.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<dir>`
|
||||
#### `<dir>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
The root directory of the package or workspace, defaults to the current
|
||||
working directory. If this parameter points to a directory containing a
|
||||
|
||||
@@ -43,7 +43,7 @@ Available since `v2.6.0`.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<dir>`
|
||||
#### `<dir>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
The root directory of the package.
|
||||
|
||||
|
||||
@@ -39,7 +39,7 @@ Available since `v2.6.0`.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<dir>`
|
||||
#### `<dir>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
The root directory of the package or workspace, defaults to the current
|
||||
working directory. If this parameter points to a directory containing a
|
||||
|
||||
@@ -42,7 +42,7 @@ Available since `v2.6.0`.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<dir>`
|
||||
#### `<dir>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
The root directory of the package.
|
||||
|
||||
|
||||
@@ -43,7 +43,7 @@ Available since `v2.6.3`.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<dir>`
|
||||
#### `<dir>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
The root directory of the package.
|
||||
|
||||
|
||||
@@ -39,7 +39,7 @@ output options are mostly for debugging.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<file>...`
|
||||
#### `<file>...` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Queries to compile. Each argument is one of:
|
||||
|
||||
|
||||
@@ -40,7 +40,7 @@ option is specified.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<file>`
|
||||
#### `<file>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] QLO file to read from.
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@ Autoformat QL source code.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<file>...`
|
||||
#### `<file>...` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
One or more `.ql` or `.qll` source files to autoformat. A dash can be
|
||||
specified to read from standard input.
|
||||
|
||||
@@ -49,7 +49,7 @@ To run multiple queries in parallel, see [codeql database run-queries](/code-sec
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<file.ql>`
|
||||
#### `<file.ql>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] QL source of the query to execute.
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@ codeql resolve database <options>... -- <database>
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<database>`
|
||||
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] The database for which to load the metadata.
|
||||
|
||||
|
||||
@@ -42,7 +42,7 @@ Available since `v2.13.3`.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<pack>...`
|
||||
#### `<pack>...` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
The path to the root of the packs to resolve extensions for.
|
||||
|
||||
|
||||
@@ -41,7 +41,7 @@ specifiers passed in as command line arguments.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<querysuite|pack>...`
|
||||
#### `<querysuite|pack>...` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Queries to execute. Each argument is in the form
|
||||
`scope/name@range:path` where:
|
||||
|
||||
@@ -37,7 +37,7 @@ language.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `-l, --language=<lang>`
|
||||
#### `-l, --language=<lang>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] The name of the extractor to locate.
|
||||
|
||||
|
||||
@@ -50,7 +50,7 @@ patterns, which can use the following wildcard characters:
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<dir>`
|
||||
#### `<dir>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
The directory to be searched.
|
||||
|
||||
|
||||
@@ -40,7 +40,7 @@ format an appropriate error message.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `--search-path=<dir>[:<dir>...]`
|
||||
#### `--search-path=<dir>[:<dir>...]` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
A list of directories under which extractor packs may be found. The
|
||||
directories can either be the extractor packs themselves or directories
|
||||
|
||||
@@ -48,7 +48,7 @@ change without much notice as the QL language ecosystem evolves.**
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `--[no-]find-extractors`
|
||||
#### `--[no-]find-extractors` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Advanced] Include in the output a summary of `extractor` fields from
|
||||
the QL packs that the query depends on. This is used only for a few rare
|
||||
|
||||
@@ -37,7 +37,7 @@ query source file.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<file>`
|
||||
#### `<file>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Query source file from which to extract metadata.
|
||||
|
||||
|
||||
@@ -43,7 +43,7 @@ This command is deprecated. Use [codeql resolve extensions](/code-security/codeq
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<querysuite|pack>...`
|
||||
#### `<querysuite|pack>...` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Queries to execute. Each argument is in the form
|
||||
`scope/name@range:path` where:
|
||||
|
||||
@@ -43,7 +43,7 @@ an error message.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `--search-path=<dir>[:<dir>...]`
|
||||
#### `--search-path=<dir>[:<dir>...]` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
A list of directories under which QL packs may be found. Each directory
|
||||
can either be a QL pack (or bundle of packs containing a
|
||||
|
||||
@@ -36,7 +36,7 @@ Accepts a .qlref file and returns the .ql file that it points to.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<qlref>`
|
||||
#### `<qlref>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] .qlref file to dereference.
|
||||
|
||||
|
||||
@@ -43,7 +43,7 @@ list of queries.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<querysuite|pack>...`
|
||||
#### `<querysuite|pack>...` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] Queries to execute. Each argument is in the form
|
||||
`scope/name@range:path` where:
|
||||
|
||||
@@ -43,7 +43,7 @@ desired _total_ RAM amount.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `--format=<fmt>`
|
||||
#### `--format=<fmt>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
Select output format. Choices include:
|
||||
|
||||
|
||||
@@ -38,7 +38,7 @@ individual .ql and .qlref files to execute.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<test|dir>...`
|
||||
#### `<test|dir>...` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
Each argument is one of:
|
||||
|
||||
|
||||
@@ -41,7 +41,7 @@ in extraordinary cases where exact control is needed.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `--dbscheme=<file>`
|
||||
#### `--dbscheme=<file>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] The _current_ dbscheme of the dataset we want to upgrade.
|
||||
|
||||
|
||||
@@ -46,7 +46,7 @@ results of _failing_ tests from a previous run.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<test|dir>...`
|
||||
#### `<test|dir>...` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
Each argument is one of:
|
||||
|
||||
|
||||
@@ -38,7 +38,7 @@ execute test queries against.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<testDir>`
|
||||
#### `<testDir>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
\[Mandatory] The path to the test directory.
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@ Run unit tests for QL queries.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `<test|dir>...`
|
||||
#### `<test|dir>...` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
Each argument is one of:
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@ Show the version of the CodeQL toolchain.
|
||||
|
||||
## Primary options
|
||||
|
||||
#### `--format=<fmt>`
|
||||
#### `--format=<fmt>` <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
Select output format. Choices include `text` _(default)_ ,`terse`, and
|
||||
`json`.
|
||||
|
||||
@@ -23,21 +23,21 @@ The main difference between the products is that {% data variables.product.prodn
|
||||
|
||||
To get started with {% data variables.product.prodname_ghe_cloud %}, create an enterprise account and add one or more organizations.
|
||||
|
||||
#### 1. About enterprise accounts
|
||||
### 1. About enterprise accounts
|
||||
|
||||
An enterprise account allows you to centrally manage policy and settings for multiple {% data variables.product.prodname_dotcom %} organizations, including member access, billing and usage and security. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts)."
|
||||
|
||||
#### 2. Creating an enterprise account
|
||||
### 2. Creating an enterprise account
|
||||
|
||||
To create your enterprise account, start a free 30-day trial of {% data variables.product.prodname_ghe_cloud %}. For more information, see "[AUTOTITLE](/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud)."
|
||||
|
||||
{% data reusables.enterprise.ghec-cta-button %}
|
||||
|
||||
#### 3. Adding organizations to your enterprise account
|
||||
### 3. Adding organizations to your enterprise account
|
||||
|
||||
You can add any number of new or existing organizations to manage within your enterprise account. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise)."
|
||||
|
||||
#### 4. Viewing the subscription and usage for your enterprise account
|
||||
### 4. Viewing the subscription and usage for your enterprise account
|
||||
|
||||
You can view your current subscription, license usage, invoices, payment history, and other billing information for your enterprise account at any time. Both enterprise owners and billing managers can access and manage billing settings for enterprise accounts. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/billing/managing-the-plan-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account)."
|
||||
|
||||
@@ -47,17 +47,17 @@ If your enterprise uses {% data variables.product.prodname_emus %}, your members
|
||||
|
||||
If your enterprise does not use {% data variables.product.prodname_emus %}, follow the steps below.
|
||||
|
||||
#### 1. Assigning roles in an enterprise
|
||||
### 1. Assigning roles in an enterprise
|
||||
|
||||
By default, everyone in an enterprise is a member of the enterprise. There are also administrative roles, including enterprise owner and billing manager, that have different levels of access to enterprise settings and data. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise)."
|
||||
|
||||
#### 2. Inviting people to manage your enterprise
|
||||
### 2. Inviting people to manage your enterprise
|
||||
|
||||
You can invite people to manage your enterprise as enterprise owners or billing managers or remove administrators who no longer need access. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise)."
|
||||
|
||||
You can also grant enterprise members the ability to manage support tickets in the support portal. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise)."
|
||||
|
||||
#### 3. Viewing people in your enterprise
|
||||
### 3. Viewing people in your enterprise
|
||||
|
||||
To audit access to enterprise-owned resources or user license usage, you can view every enterprise administrator, enterprise member, and outside collaborator in your enterprise. You can see the organizations that a member belongs to and the specific repositories that an outside collaborator has access to. For more information, see "[AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise)."
|
||||
|
||||
@@ -112,11 +112,11 @@ You can enable and manage team synchronization between an identity provider (IdP
|
||||
|
||||
To manage and moderate your enterprise, you can set policies for organizations within the enterprise, view audit logs, configure webhooks, and restrict email notifications.
|
||||
|
||||
#### 1. Managing policies for organizations in your enterprise account
|
||||
### 1. Managing policies for organizations in your enterprise account
|
||||
|
||||
You can choose to enforce a number of policies for all organizations owned by your enterprise, or choose to allow these policies to be set in each organization. Types of policies you can enforce include repository management, project board, and team policies. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/policies)."
|
||||
|
||||
#### 2. Viewing audit logs, configuring webhooks, and restricting email notifications for your enterprise
|
||||
### 2. Viewing audit logs, configuring webhooks, and restricting email notifications for your enterprise
|
||||
|
||||
You can view actions from all of the organizations owned by your enterprise account in the enterprise audit log. You can also configure webhooks to receive events from organizations owned by your enterprise account. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise)" and "[AUTOTITLE](/enterprise-cloud@latest/admin/monitoring-activity-in-your-enterprise)."
|
||||
|
||||
|
||||
@@ -46,7 +46,7 @@ redirect_from:
|
||||
|
||||
Your migration source is your ADO organization.
|
||||
|
||||
#### `createMigrationSource` mutation
|
||||
### `createMigrationSource` mutation
|
||||
|
||||
```graphql
|
||||
mutation createMigrationSource($name: String!, $ownerId: ID!) {
|
||||
@@ -65,7 +65,7 @@ mutation createMigrationSource($name: String!, $ownerId: ID!) {
|
||||
|
||||
{% data reusables.enterprise-migration-tool.createMigrationSource-table-ec %}
|
||||
|
||||
#### `createMigrationSource` response
|
||||
### `createMigrationSource` response
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -88,7 +88,7 @@ In this example, `MS_kgDaACQxYmYxOWU4Yi0wNzZmLTQ3NTMtOTdkZC1hNGUzZmYxN2U2YzA` is
|
||||
|
||||
{% data reusables.enterprise-migration-tool.start-repository-migration-ec %}
|
||||
|
||||
#### `startRepositoryMigration` mutation
|
||||
### `startRepositoryMigration` mutation
|
||||
|
||||
```graphql
|
||||
mutation startRepositoryMigration (
|
||||
|
||||
@@ -100,7 +100,7 @@ Blob storage is required to migrate repositories with large Git source or metada
|
||||
|
||||
Your migration source is your organization on {% data variables.product.prodname_ghe_server %}.
|
||||
|
||||
#### `createMigrationSource` mutation
|
||||
### `createMigrationSource` mutation
|
||||
|
||||
```graphql
|
||||
mutation createMigrationSource($name: String!, $url: String!, $ownerId: ID!) {
|
||||
@@ -120,7 +120,7 @@ mutation createMigrationSource($name: String!, $url: String!, $ownerId: ID!) {
|
||||
{% data reusables.enterprise-migration-tool.createMigrationSource-table-ec %}
|
||||
| `url` | The URL for {% data variables.location.product_location_enterprise %}. This URL does not need to be accessible from {% data variables.product.prodname_ghe_cloud %}.
|
||||
|
||||
#### `createMigrationSource` response
|
||||
### `createMigrationSource` response
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -244,7 +244,7 @@ You may need to allowlist {% data variables.product.company_short %}'s IP ranges
|
||||
|
||||
{% data reusables.enterprise-migration-tool.start-repository-migration-ec %}
|
||||
|
||||
#### `startRepositoryMigration` mutation
|
||||
### `startRepositoryMigration` mutation
|
||||
|
||||
```graphql
|
||||
mutation startRepositoryMigration (
|
||||
|
||||
@@ -46,7 +46,7 @@ redirect_from:
|
||||
|
||||
Your migration source is an organization on {% data variables.product.prodname_dotcom_the_website %}.
|
||||
|
||||
#### `createMigrationSource` mutation
|
||||
### `createMigrationSource` mutation
|
||||
|
||||
```graphql
|
||||
mutation createMigrationSource($name: String!, $ownerId: ID!) {
|
||||
@@ -65,7 +65,7 @@ mutation createMigrationSource($name: String!, $ownerId: ID!) {
|
||||
|
||||
{% data reusables.enterprise-migration-tool.createMigrationSource-table-ec %}
|
||||
|
||||
#### `createMigrationSource` response
|
||||
### `createMigrationSource` response
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -88,7 +88,7 @@ In this example, `MS_kgDaACQxYmYxOWU4Yi0wNzZmLTQ3NTMtOTdkZC1hNGUzZmYxN2U2YzA` is
|
||||
|
||||
{% data reusables.enterprise-migration-tool.start-repository-migration-ec %}
|
||||
|
||||
#### `startRepositoryMigration` mutation
|
||||
### `startRepositoryMigration` mutation
|
||||
|
||||
```graphql
|
||||
mutation startRepositoryMigration (
|
||||
|
||||
@@ -90,7 +90,7 @@ A merge queue creates temporary branches with a special prefix to validate pull
|
||||
|
||||
For information about merge methods, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)."
|
||||
|
||||
#### Successful CI
|
||||
### Successful CI
|
||||
|
||||
When multiple pull requests are added to the merge queue and when the temporary `merge_group` branches have successful CI results, they are both merged. In the following scenario, two pull requests are successfully added to the queue and merged to the target branch.
|
||||
|
||||
@@ -100,7 +100,7 @@ When multiple pull requests are added to the merge queue and when the temporary
|
||||
1. The merge queue creates a temporary branch with the prefix of `main/pr-2` that contains code changes from the target branch, pull request #1, and pull request #2, and dispatches webhooks.
|
||||
1. When the {% data variables.product.product_name %} API receives successful CI responses for `merge_group` branches `main/pr-1` and `main/pr-2`, the temporary branch `main/pr-2` will be merged in to the target branch. The target branch now contains both changes from pull request #1 and #2.
|
||||
|
||||
#### Failing CI
|
||||
### Failing CI
|
||||
|
||||
{% data reusables.pull_requests.merge-queue-reject %}
|
||||
|
||||
@@ -116,7 +116,7 @@ The following scenario outlines what happens when a CI reports a failing status
|
||||
|
||||
{% data reusables.pull_requests.merge-queue-removal-reasons %}
|
||||
|
||||
#### Jumping to the top of the queue
|
||||
### Jumping to the top of the queue
|
||||
|
||||
When adding a pull request to a merge queue, there is an option to move your pull request to the top of the queue.
|
||||
|
||||
|
||||
@@ -45,7 +45,7 @@ In the event of any conflict or inconsistency between the DPA and any other term
|
||||
|
||||
1.10 “**Sensitive Data**” means any Personal Data revealing racial or ethnic origin; political opinions, religious or philosophical beliefs or trade union membership; processing of genetic data or biometric data for the purposes of uniquely identifying a natural person; data concerning health, a natural person’s sex life or sexual orientation; and data relating to offences, criminal convictions, or security measures.
|
||||
|
||||
## 2. Status and Compliance.
|
||||
### 2. Status and Compliance.
|
||||
|
||||
#### 2.1 Data Processing.
|
||||
|
||||
@@ -213,7 +213,7 @@ In countries where regulatory approval is required for use of the Standard Contr
|
||||
|
||||
For the purposes of Article 46 (2) of the General Data Protection Regulation (EU 2016/679) for the transfer of personal data to processors established in third countries which do not ensure an adequate level of data protection, Customer (as data exporter) and GitHub (as data importer, whose signature appears below), each a “party,” together “the parties”, have agreed on the following Contractual Clauses (the “Clauses” or “Standard Contractual Clauses”) in order to adduce adequate safeguards with respect to the protection of privacy and fundamental rights and freedoms of individuals for the transfer by the data exporter to the data importer of the personal data specified in Appendix 1.
|
||||
|
||||
#### Clause 1: Definitions
|
||||
#### Clause 1: Definitions <!-- markdownlint-disable-line heading-increment -->
|
||||
|
||||
(a) 'personal data', 'special categories of data', 'process/processing', 'controller', 'processor', 'data subject' and 'supervisory authority' shall have the same meaning as in the General Data Protection Regulation (EU 2016/679) on the protection of individuals with regard to the processing of personal data and on the free movement of such data;
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ export const baseConfig = {
|
||||
default: false,
|
||||
'heading-increment': {
|
||||
// MD001
|
||||
severity: 'warning',
|
||||
severity: 'error',
|
||||
'partial-markdown-files': true,
|
||||
},
|
||||
'first-heading-h1': {
|
||||
|
||||
Reference in New Issue
Block a user