-
Notifications
You must be signed in to change notification settings - Fork 162
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into new-website
- Loading branch information
Showing
166 changed files
with
2,416 additions
and
3,305 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| extends: ["@commitlint/config-conventional"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| name: PR Title Check | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: [main] | ||
| types: [opened, edited, synchronize] | ||
|
|
||
| jobs: | ||
| title_check: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| pull-requests: read | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # v4.1.2 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Setup Node.js | ||
| uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2 | ||
|
|
||
| - name: Install commitlint | ||
| run: npm install --save-dev @commitlint/{config-conventional,cli} | ||
|
|
||
| - name: Lint PR title | ||
| run: echo "${{ github.event.pull_request.title }}" | npx commitlint |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| # zarf tools yq | ||
| <!-- Auto-generated by hack/gen-cli-docs.sh --> | ||
|
|
||
| yq is a lightweight and portable command-line data file processor. | ||
|
|
||
| ## Synopsis | ||
|
|
||
| yq is a portable command-line data file processor (https://github.com/mikefarah/yq/) | ||
| See https://mikefarah.gitbook.io/yq/ for detailed documentation and examples. | ||
|
|
||
| ``` | ||
| zarf tools yq [flags] | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| ``` | ||
| # yq defaults to 'eval' command if no command is specified. See "zarf tools yq eval --help" for more examples. | ||
| # read the "stuff" node from "myfile.yml" | ||
| zarf tools yq '.stuff' < myfile.yml | ||
| # update myfile.yml in place | ||
| zarf tools yq -i '.stuff = "foo"' myfile.yml | ||
| # print contents of sample.json as idiomatic YAML | ||
| zarf tools yq -P sample.json | ||
| ``` | ||
|
|
||
| ## Options | ||
|
|
||
| ``` | ||
| -C, --colors force print with colors | ||
| --csv-auto-parse parse CSV YAML/JSON values (default true) | ||
| --csv-separator char CSV Separator character (default ,) | ||
| -e, --exit-status set exit status if there are no matches or null or false is returned | ||
| --expression string forcibly set the expression argument. Useful when yq argument detection thinks your expression is a file. | ||
| --from-file string Load expression from specified file. | ||
| -f, --front-matter string (extract|process) first input as yaml front-matter. Extract will pull out the yaml content, process will run the expression against the yaml content, leaving the remaining data intact | ||
| --header-preprocess Slurp any header comments and separators before processing expression. (default true) | ||
| -h, --help help for yq | ||
| -I, --indent int sets indent level for output (default 2) | ||
| -i, --inplace update the file in place of first file given. | ||
| -p, --input-format string [auto|a|yaml|y|json|j|props|p|csv|c|tsv|t|xml|x|base64|uri|toml|lua|l] parse format for input. (default "auto") | ||
| --lua-globals output keys as top-level global variables | ||
| --lua-prefix string prefix (default "return ") | ||
| --lua-suffix string suffix (default ";\n") | ||
| --lua-unquoted output unquoted string keys (e.g. {foo="bar"}) | ||
| -M, --no-colors force print with no colors | ||
| -N, --no-doc Don't print document separators (---) | ||
| -0, --nul-output Use NUL char to separate values. If unwrap scalar is also set, fail if unwrapped scalar contains NUL char. | ||
| -n, --null-input Don't read input, simply evaluate the expression given. Useful for creating docs from scratch. | ||
| -o, --output-format string [auto|a|yaml|y|json|j|props|p|csv|c|tsv|t|xml|x|base64|uri|toml|shell|s|lua|l] output format type. (default "auto") | ||
| -P, --prettyPrint pretty print, shorthand for '... style = ""' | ||
| --properties-array-brackets use [x] in array paths (e.g. for SpringBoot) | ||
| --properties-separator string separator to use between keys and values (default " = ") | ||
| -s, --split-exp string print each result (or doc) into a file named (exp). [exp] argument must return a string. You can use $index in the expression as the result counter. | ||
| --split-exp-file string Use a file to specify the split-exp expression. | ||
| --string-interpolation Toggles strings interpolation of \(exp) (default true) | ||
| --tsv-auto-parse parse TSV YAML/JSON values (default true) | ||
| -r, --unwrapScalar unwrap scalar, print the value with no quotes, colors or comments. Defaults to true for yaml (default true) | ||
| -v, --verbose verbose mode | ||
| -V, --version Print version information and quit | ||
| --xml-attribute-prefix string prefix for xml attributes (default "+@") | ||
| --xml-content-name string name for xml content (if no attribute name is present). (default "+content") | ||
| --xml-directive-name string name for xml directives (e.g. <!DOCTYPE thing cat>) (default "+directive") | ||
| --xml-keep-namespace enables keeping namespace after parsing attributes (default true) | ||
| --xml-proc-inst-prefix string prefix for xml processing instructions (e.g. <?xml version="1"?>) (default "+p_") | ||
| --xml-raw-token enables using RawToken method instead Token. Commonly disables namespace translations. See https://pkg.go.dev/encoding/xml#Decoder.RawToken for details. (default true) | ||
| --xml-skip-directives skip over directives (e.g. <!DOCTYPE thing cat>) | ||
| --xml-skip-proc-inst skip over process instructions (e.g. <?xml version="1"?>) | ||
| --xml-strict-mode enables strict parsing of XML. See https://pkg.go.dev/encoding/xml for more details. | ||
| ``` | ||
|
|
||
| ## SEE ALSO | ||
|
|
||
| * [zarf tools](zarf_tools.md) - Collection of additional tools to make airgap easier | ||
| * [zarf tools yq eval](zarf_tools_yq_eval.md) - (default) Apply the expression to each document in each yaml file in sequence | ||
| * [zarf tools yq eval-all](zarf_tools_yq_eval-all.md) - Loads _all_ yaml documents of _all_ yaml files and runs expression once |
Oops, something went wrong.