Skip to content

apply.md

Latest commit

 

History

History
93 lines (77 loc) · 4.36 KB

apply.md

File metadata and controls

93 lines (77 loc) · 4.36 KB

src batch apply

Flags

Name Description Default Value
-allow-unsupported Allow unsupported code hosts. false
-apply Ignored. false
-cache Directory for caching results and repository archives. ~/.cache/sourcegraph/batch
-clean-archives If true, deletes downloaded repository archives after executing batch spec steps. true
-clear-cache If true, clears the execution cache and executes all steps anew. false
-dump-requests Log GraphQL requests and responses to stdout false
-f The batch spec file to read.
-force-override-ignore Do not ignore repositories that have a .batchignore file. false
-get-curl Print the curl command for executing this query and exit (WARNING: includes printing your access token!) false
-insecure-skip-verify Skip validation of TLS certificates against trusted chains false
-j The maximum number of parallel jobs. Default is GOMAXPROCS. 8
-keep-logs Retain logs after executing steps. false
-n Alias for -namespace.
-namespace The user or organization namespace to place the batch change within. Default is the currently authenticated user.
-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
-text-only INTERNAL USE ONLY. EXPERIMENTAL. Switches off the TUI to only print JSON lines. false
-timeout The maximum duration a single batch spec step can take. 1h0m0s
-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
-trace Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing false
-v print verbose output false
-workspace Workspace mode to use ("auto", "bind", or "volume") auto

Usage

Usage of 'src batch apply':
  -allow-unsupported
    	Allow unsupported code hosts.
  -apply
    	Ignored.
  -cache string
    	Directory for caching results and repository archives. (default "~/.cache/sourcegraph/batch")
  -clean-archives
    	If true, deletes downloaded repository archives after executing batch spec steps. (default true)
  -clear-cache
    	If true, clears the execution cache and executes all steps anew.
  -dump-requests
    	Log GraphQL requests and responses to stdout
  -f string
    	The batch spec file to read.
  -force-override-ignore
    	Do not ignore repositories that have a .batchignore file.
  -get-curl
    	Print the curl command for executing this query and exit (WARNING: includes printing your access token!)
  -insecure-skip-verify
    	Skip validation of TLS certificates against trusted chains
  -j int
    	The maximum number of parallel jobs. Default is GOMAXPROCS. (default 8)
  -keep-logs
    	Retain logs after executing steps.
  -n string
    	Alias for -namespace.
  -namespace string
    	The user or organization namespace to place the batch change within. Default is the currently authenticated user.
  -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.
  -text-only
    	INTERNAL USE ONLY. EXPERIMENTAL. Switches off the TUI to only print JSON lines.
  -timeout duration
    	The maximum duration a single batch spec step can take. (default 1h0m0s)
  -tmp string
    	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")
  -trace
    	Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing
  -v	print verbose output
  -workspace string
    	Workspace mode to use ("auto", "bind", or "volume") (default "auto")

'src batch apply' is used to apply a batch spec on a Sourcegraph instance,
creating or updating the described batch change if necessary.

Usage:

    src batch apply -f FILE [command options]

Examples:

    $ src batch apply -f batch.spec.yaml
  
    $ src batch apply -f batch.spec.yaml -namespace myorg