yq.bzlAPI docs @0.3.0

@yq.bzl//yq:yq.bzl

Public API for calling yq

Functions & Macros

yq

Invoke yq with an expression on a set of input files.

yq is capable of parsing and outputting to other formats. See their docs for more examples.

Parameters
*name

Name of the rule

*srcs

List of input file labels

expression

yq expression (https://mikefarah.gitbook.io/yq/commands/evaluate).

Defaults to the identity
expression ".". Subject to stamp variable replacements, see Stamping.
When stamping is enabled, an environment variable named "STAMP" will be available in the expression.

Be careful to write the filter so that it handles unstamped builds, as in the example above.

Default: "."
args

Additional args to pass to yq.

Note that you do not need to pass eval or eval-all as this
is handled automatically based on the number srcs. Passing the output format or the parse format
is optional as these can be guessed based on the file extensions in srcs and outs.

Default: []
outs

Name of the output files.

Defaults to a single output with the name plus a ".yaml" extension, or
the extension corresponding to a passed output argument (e.g., "-o=json"). For split operations you
must declare all outputs as the name of the output files depends on the expression.

Default: None
kwargs

Other common named parameters such as tags or visibility