Skip to content

Commit 542c007

Browse files
sourcegraph-buildkitebuildkite-at-sourcegraph
sourcegraph-buildkite
and
buildkite-at-sourcegraph
authored
🤖 Sync generated docs from sourcegraph/sourcegraph (2025-11-04/14-27-01) (#1405)
This is an automated pull request, created by //doc:generated:push on sourcegraph/sourcegraph Co-authored-by: Buildkite <buildkite@sourcegraph.com>
1 parent cab9036 commit 542c007

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+8868
-10178
lines changed

‎docs/admin/observability/alerts.mdx‎

Lines changed: 1560 additions & 1664 deletions
Large diffs are not rendered by default.

‎docs/admin/observability/dashboards.mdx‎

Lines changed: 7142 additions & 8401 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/cli/references/api.mdx‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false` |
1010
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` |
1111
| `-query` | GraphQL query to execute, e.g. 'query \{ currentUser \{ username \} \}' (stdin otherwise) | |
12-
| `-trace` | Log the trace ID for requests. See [docs](/admin/observability/tracing) | `false` |
12+
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` |
1313
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` |
1414
| `-vars` | GraphQL query variables to include as JSON string, e.g. '\{"var": "val", "var2": "val2"\}' | |
1515

@@ -27,7 +27,7 @@ Usage of 'src api':
2727
-query string
2828
GraphQL query to execute, e.g. 'query { currentUser { username } }' (stdin otherwise)
2929
-trace
30-
Log the trace ID for requests. #See https://sourcegraph.com/docs/admin/observability/tracing
30+
Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing
3131
-user-agent-telemetry
3232
Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true)
3333
-vars string
@@ -60,3 +60,4 @@ Examples:
6060
6161
6262
```
63+

‎docs/cli/references/batch/apply.mdx‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
| `-clear-cache` | If true, clears the execution cache and executes all steps anew. | `false` |
1313
| `-dump-requests` | Log GraphQL requests and responses to stdout | `false` |
1414
| `-f` | The batch spec file to read, or - to read from standard input. | |
15+
| `-fail-fast` | Halts execution immediately upon first error instead of continuing with other tasks. | `false` |
1516
| `-force-override-ignore` | Do not ignore repositories that have a .batchignore file. | `false` |
1617
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false` |
1718
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` |
@@ -20,11 +21,11 @@
2021
| `-n` | Alias for -namespace. | |
2122
| `-namespace` | The user or organization namespace to place the batch change within. Default is the currently authenticated user. | |
2223
| `-run-as-root` | If true, forces all step containers to run as root. | `false` |
23-
| `-skip-errors` | If true, errors encountered while executing steps in a repository won't stop the execution of the batch spec but only cause that repository to be skipped. | `false` |
24+
| `-skip-errors` | If true, errors encountered won't stop the program, but only log them. | `false` |
2425
| `-text-only` | INTERNAL USE ONLY. EXPERIMENTAL. Switches off the TUI to only print JSON lines. | `false` |
2526
| `-timeout` | The maximum duration a single batch spec step can take. | `1h0m0s` |
2627
| `-tmp` | Directory for storing temporary data, such as log files. Default is /tmp. Can also be set with environment variable SRC_BATCH_TMP_DIR; if both are set, this flag will be used and not the environment variable. | `/tmp` |
27-
| `-trace` | Log the trace ID for requests. [See docs](/admin/observability/tracing) | `false` |
28+
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` |
2829
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` |
2930
| `-v` | print verbose output | `false` |
3031
| `-workspace` | Workspace mode to use ("auto", "bind", or "volume") | `auto` |
@@ -48,6 +49,8 @@ Usage of 'src batch apply':
4849
Log GraphQL requests and responses to stdout
4950
-f string
5051
The batch spec file to read, or - to read from standard input.
52+
-fail-fast
53+
Halts execution immediately upon first error instead of continuing with other tasks.
5154
-force-override-ignore
5255
Do not ignore repositories that have a .batchignore file.
5356
-get-curl
@@ -65,15 +68,15 @@ Usage of 'src batch apply':
6568
-run-as-root
6669
If true, forces all step containers to run as root.
6770
-skip-errors
68-
If true, errors encountered while executing steps in a repository won't stop the execution of the batch spec but only cause that repository to be skipped.
71+
If true, errors encountered won't stop the program, but only log them.
6972
-text-only
7073
INTERNAL USE ONLY. EXPERIMENTAL. Switches off the TUI to only print JSON lines.
7174
-timeout duration
7275
The maximum duration a single batch spec step can take. (default 1h0m0s)
7376
-tmp string
7477
Directory for storing temporary data, such as log files. Default is /tmp. Can also be set with environment variable SRC_BATCH_TMP_DIR; if both are set, this flag will be used and not the environment variable. (default "/tmp")
7578
-trace
76-
Log the trace ID for requests. # See https://sourcegraph.com/docs/admin/observability/tracing
79+
Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing
7780
-user-agent-telemetry
7881
Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true)
7982
-v print verbose output
@@ -99,3 +102,4 @@ Examples:
99102
100103
101104
```
105+

‎docs/cli/references/batch/new.mdx‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
| `-f` | The name of the batch spec file to create. | `batch.yaml` |
1010
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false` |
1111
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` |
12-
| `-trace` | Log the trace ID for requests. [See docs](/admin/observability/tracing) | `false` |
12+
| `-skip-errors` | If true, errors encountered won't stop the program, but only log them. | `false` |
13+
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` |
1314
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` |
1415

1516

@@ -25,8 +26,10 @@ Usage of 'src batch new':
2526
Print the curl command for executing this query and exit (WARNING: includes printing your access token!)
2627
-insecure-skip-verify
2728
Skip validation of TLS certificates against trusted chains
29+
-skip-errors
30+
If true, errors encountered won't stop the program, but only log them.
2831
-trace
29-
Log the trace ID for requests. #See https://sourcegraph.com/docs/admin/observability/tracing
32+
Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing
3033
-user-agent-telemetry
3134
Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true)
3235
@@ -45,3 +48,4 @@ Examples:
4548
4649
4750
```
51+

‎docs/cli/references/batch/preview.mdx‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
| `-clear-cache` | If true, clears the execution cache and executes all steps anew. | `false` |
1313
| `-dump-requests` | Log GraphQL requests and responses to stdout | `false` |
1414
| `-f` | The batch spec file to read, or - to read from standard input. | |
15+
| `-fail-fast` | Halts execution immediately upon first error instead of continuing with other tasks. | `false` |
1516
| `-force-override-ignore` | Do not ignore repositories that have a .batchignore file. | `false` |
1617
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false` |
1718
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` |
@@ -20,11 +21,11 @@
2021
| `-n` | Alias for -namespace. | |
2122
| `-namespace` | The user or organization namespace to place the batch change within. Default is the currently authenticated user. | |
2223
| `-run-as-root` | If true, forces all step containers to run as root. | `false` |
23-
| `-skip-errors` | If true, errors encountered while executing steps in a repository won't stop the execution of the batch spec but only cause that repository to be skipped. | `false` |
24+
| `-skip-errors` | If true, errors encountered won't stop the program, but only log them. | `false` |
2425
| `-text-only` | INTERNAL USE ONLY. EXPERIMENTAL. Switches off the TUI to only print JSON lines. | `false` |
2526
| `-timeout` | The maximum duration a single batch spec step can take. | `1h0m0s` |
2627
| `-tmp` | Directory for storing temporary data, such as log files. Default is /tmp. Can also be set with environment variable SRC_BATCH_TMP_DIR; if both are set, this flag will be used and not the environment variable. | `/tmp` |
27-
| `-trace` | Log the trace ID for requests. [See docs](/admin/observability/tracing) | `false` |
28+
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` |
2829
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` |
2930
| `-v` | print verbose output | `false` |
3031
| `-workspace` | Workspace mode to use ("auto", "bind", or "volume") | `auto` |
@@ -48,6 +49,8 @@ Usage of 'src batch preview':
4849
Log GraphQL requests and responses to stdout
4950
-f string
5051
The batch spec file to read, or - to read from standard input.
52+
-fail-fast
53+
Halts execution immediately upon first error instead of continuing with other tasks.
5154
-force-override-ignore
5255
Do not ignore repositories that have a .batchignore file.
5356
-get-curl
@@ -65,15 +68,15 @@ Usage of 'src batch preview':
6568
-run-as-root
6669
If true, forces all step containers to run as root.
6770
-skip-errors
68-
If true, errors encountered while executing steps in a repository won't stop the execution of the batch spec but only cause that repository to be skipped.
71+
If true, errors encountered won't stop the program, but only log them.
6972
-text-only
7073
INTERNAL USE ONLY. EXPERIMENTAL. Switches off the TUI to only print JSON lines.
7174
-timeout duration
7275
The maximum duration a single batch spec step can take. (default 1h0m0s)
7376
-tmp string
7477
Directory for storing temporary data, such as log files. Default is /tmp. Can also be set with environment variable SRC_BATCH_TMP_DIR; if both are set, this flag will be used and not the environment variable. (default "/tmp")
7578
-trace
76-
Log the trace ID for requests. #See https://sourcegraph.com/docs/admin/observability/tracing
79+
Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing
7780
-user-agent-telemetry
7881
Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true)
7982
-v print verbose output
@@ -97,3 +100,4 @@ Examples:
97100
98101
99102
```
103+

‎docs/cli/references/batch/remote.mdx‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` |
1515
| `-n` | Alias for -namespace. | |
1616
| `-namespace` | The user or organization namespace to place the batch change within. Default is the currently authenticated user. | |
17-
| `-trace` | Log the trace ID for requests. [See docs](/admin/observability/tracing) | `false` |
17+
| `-skip-errors` | If true, errors encountered won't stop the program, but only log them. | `false` |
18+
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` |
1819
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` |
1920

2021

@@ -40,8 +41,10 @@ Usage of 'src batch remote':
4041
Alias for -namespace.
4142
-namespace string
4243
The user or organization namespace to place the batch change within. Default is the currently authenticated user.
44+
-skip-errors
45+
If true, errors encountered won't stop the program, but only log them.
4346
-trace
44-
Log the trace ID for requests. #See https://sourcegraph.com/docs/admin/observability/tracing
47+
Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing
4548
-user-agent-telemetry
4649
Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true)
4750
'src batch remote' runs a batch spec on the Sourcegraph instance.
@@ -58,3 +61,4 @@ Examples:
5861
5962
6063
```
64+

‎docs/cli/references/batch/repositories.mdx‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111
| `-force-override-ignore` | Do not ignore repositories that have a .batchignore file. | `false` |
1212
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false` |
1313
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` |
14-
| `-trace` | Log the trace ID for requests. [See docs](/admin/observability/tracing) | `false` |
14+
| `-skip-errors` | If true, errors encountered won't stop the program, but only log them. | `false` |
15+
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` |
1516
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` |
1617

1718

@@ -31,8 +32,10 @@ Usage of 'src batch repositories':
3132
Print the curl command for executing this query and exit (WARNING: includes printing your access token!)
3233
-insecure-skip-verify
3334
Skip validation of TLS certificates against trusted chains
35+
-skip-errors
36+
If true, errors encountered won't stop the program, but only log them.
3437
-trace
35-
Log the trace ID for requests. #See https://sourcegraph.com/docs/admin/observability/tracing
38+
Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing
3639
-user-agent-telemetry
3740
Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true)
3841
@@ -52,3 +55,4 @@ Examples:
5255
5356
5457
```
58+

‎docs/cli/references/batch/validate.mdx‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111
| `-force-override-ignore` | Do not ignore repositories that have a .batchignore file. | `false` |
1212
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false` |
1313
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` |
14-
| `-trace` | Log the trace ID for requests. [See docs](/admin/observability/tracing) | `false` |
14+
| `-skip-errors` | If true, errors encountered won't stop the program, but only log them. | `false` |
15+
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` |
1516
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` |
1617

1718

@@ -31,8 +32,10 @@ Usage of 'src batch validate':
3132
Print the curl command for executing this query and exit (WARNING: includes printing your access token!)
3233
-insecure-skip-verify
3334
Skip validation of TLS certificates against trusted chains
35+
-skip-errors
36+
If true, errors encountered won't stop the program, but only log them.
3437
-trace
35-
Log the trace ID for requests. See https://sourcegraph.com/docs/admin/observability/tracing
38+
Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing
3639
-user-agent-telemetry
3740
Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true)
3841
@@ -51,3 +54,4 @@ Examples:
5154
5255
5356
```
57+

0 commit comments

Comments
 (0)