docs(yaml_lint): update docs for new variables

!21
This commit is contained in:
2023-05-14 15:50:23 +09:30
parent 8581981a43
commit a925db1464

View File

@ -29,8 +29,8 @@ include:
Yaml Lint (python 3.6): Yaml Lint (python 3.6):
variables: variables:
YAML_LINT_PATH: "roles/" YAML_LINT_PATH: "."
YAML_LINT_CONFIG: ".yamllint.yaml" YAML_LINT_EXTRA_ARGS: "{ extends: $ROOT_DIR/yaml_lint/.yamllint.yaml, ignore: [gitlab-ci/*] }"
extends: extends:
- .yaml_linter_defaults - .yaml_linter_defaults
image: python:3.6-slim image: python:3.6-slim
@ -41,8 +41,8 @@ Yaml Lint (python 3.6):
| var name | Description | | var name | Description |
|:----:|:----| |:----:|:----|
| YAML_LINT_PATH | *The path you wish the linter to search for yaml files* | | YAML_LINT_PATH | *The path you wish the linter to search for yaml files, defaults to `.`* |
| YAML_LINT_CONFOG | *The path you have stored the yaml config file in* | | YAML_LINT_EXTRA_ARGS | *configuration in yaml format., defaults to `{ extends: $ROOT_DIR/yaml_lint/.yamllint.yaml, ignore: [gitlab-ci/*] }` for further info see the [YAML Lint docs](https://yamllint.readthedocs.io/en/stable/configuration.html?highlight=exclude#custom-configuration-without-a-config-file)* |
## Job Workflow ## Job Workflow