diff options
| author | w0rp <devw0rp@gmail.com> | 2021-06-19 10:34:57 +0100 |
|---|---|---|
| committer | w0rp <devw0rp@gmail.com> | 2021-06-19 10:34:57 +0100 |
| commit | 84a4a76aafaefe125df785ebac2e4858ec54debb (patch) | |
| tree | 91797d6d9509a2439948ed6e60174a8f94ffb6ce /doc | |
| parent | 1b08791228f5aca4545a3fba6699b29a003028fe (diff) | |
| download | ale-84a4a76aafaefe125df785ebac2e4858ec54debb.zip | |
Close #3770 - Add support for checking circleci configs
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale-supported-languages-and-tools.txt | 1 | ||||
| -rw-r--r-- | doc/ale-yaml.txt | 26 | ||||
| -rw-r--r-- | doc/ale.txt | 1 |
3 files changed, 28 insertions, 0 deletions
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt index 67dc971c..4a901488 100644 --- a/doc/ale-supported-languages-and-tools.txt +++ b/doc/ale-supported-languages-and-tools.txt @@ -568,6 +568,7 @@ Notes: * XML * `xmllint` * YAML + * `circleci`!! * `prettier` * `spectral` * `swaglint` diff --git a/doc/ale-yaml.txt b/doc/ale-yaml.txt index 04871403..65e0d069 100644 --- a/doc/ale-yaml.txt +++ b/doc/ale-yaml.txt @@ -1,6 +1,28 @@ =============================================================================== ALE YAML Integration *ale-yaml-options* + +=============================================================================== +circleci *ale-yaml-circleci* + +Website: https://circleci.com/docs/2.0/local-cli + + +Installation +------------------------------------------------------------------------------- + +Follow the instructions on the website, and make sure to test that you can +validate configuration files with: > + + circleci config validate - < .circleci/config.yml +< + +As long as the validator runs correctly, you should be able to see errors when +you save the configuration file. The validator doesn't run as you type because +it sends network requests, and running too often would overload the circleci +servers. + + =============================================================================== prettier *ale-yaml-prettier* @@ -15,11 +37,13 @@ Install prettier either globally or locally: > npm install prettier -g # global npm install prettier # local < + =============================================================================== spectral *ale-yaml-spectral* Website: https://github.com/stoplightio/spectral + Installation ------------------------------------------------------------------------------- @@ -80,6 +104,7 @@ g:ale_yaml_swaglint_use_global *g:ale_yaml_swaglint_use_global* See |ale-integrations-local-executables| + =============================================================================== yamlfix *ale-yaml-yamlfix* @@ -118,6 +143,7 @@ g:ale_yaml_yamlfix_use_global *g:ale_yaml_yamlfix_use_global* See |ale-integrations-local-executables| + =============================================================================== yamllint *ale-yaml-yamllint* diff --git a/doc/ale.txt b/doc/ale.txt index b7059af9..9ff05059 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -3083,6 +3083,7 @@ documented in additional help files. xml.....................................|ale-xml-options| xmllint...............................|ale-xml-xmllint| yaml....................................|ale-yaml-options| + circleci..............................|ale-yaml-circleci| prettier..............................|ale-yaml-prettier| spectral..............................|ale-yaml-spectral| swaglint..............................|ale-yaml-swaglint| |