Commit 87caa98d authored by Thomas Boni's avatar Thomas Boni
Browse files

Merge branch '405-super_linter-emplacement-des-fichiers-de-configuration' into 'latest' 

Resolve "[super_linter] emplacement des fichiers de configuration"

Closes #405

See merge request r2devops/hub!245
parents dd81ea5d 77f8c705

.spell_check/dico.txt

+3 −0
Original line number Diff line number Diff line
@@ -342,3 +342,6 @@ Sonarcloud 
deployer

Deployer

jobdescription

templating

Templating

auths

jobs/super_linter/README.md

+7 −1
Original line number Diff line number Diff line
@@ -105,7 +105,7 @@ customize its behavior. 
| **DOCKERFILE_HADOLINT_FILE_NAME** | Filename for [hadolint configuration](https://github.com/hadolint/hadolint){:target="_blank"} (ex: `.hadolintlintrc.yaml`)                                                                   | `.hadolint.yml`      |

| **ERROR_ON_MISSING_EXEC_BIT**     | If set to `false`, the `bash-exec` linter will report a warning if a shell script is not executable. If set to `true`, the `bash-exec` linter will report an arror instead.| `false`              |

| **JAVASCRIPT_ES_CONFIG_FILE**     | Filename for [eslint configuration](https://eslint.org/docs/user-guide/configuring#configuration-file-formats){:target="_blank"} (ex: `.eslintrc.yml`, `.eslintrc.json`)                     | `.eslintrc.yml`      |

| **LINTER_RULES_PATH**             | Directory for all linter configuration rules.                                                                                                                              | `.github/linters`    |

| **LINTER_RULES_PATH**             | Directory for all linter configuration rules.                                                                                                                              | `.linters`    |

| **MARKDOWN_CONFIG_FILE**          | Filename for [Markdownlint configuration](https://github.com/DavidAnson/markdownlint#optionsconfig){:target="_blank"} (ex: `.markdown-lint.yml`, `.markdownlint.json`, `.markdownlint.yaml`) | `.markdown-lint.yml` |

| **PYTHON_PYLINT_CONFIG_FILE**     | Filename for [pylint configuration](https://pylint.pycqa.org/en/latest/user_guide/run.html?highlight=rcfile#command-line-options){:target="_blank"} (ex: `.python-lint`, `.pylintrc`)        | `.python-lint`       |

| **PYTHON_FLAKE8_CONFIG_FILE**     | Filename for [flake8 configuration](https://flake8.pycqa.org/en/latest/user/configuration.html){:target="_blank"} (ex: `.flake8`, `tox.ini`)                                                 | `.flake8`            |
@@ -115,6 +115,12 @@ customize its behavior. 
| **TYPESCRIPT_ES_CONFIG_FILE**     | Filename for [eslint configuration](https://eslint.org/docs/user-guide/configuring#configuration-file-formats){:target="_blank"} (ex: `.eslintrc.yml`, `.eslintrc.json`)                     | `.eslintrc.yml`      |

| **YAML_CONFIG_FILE**              | Filename for [Yamllint configuration](https://yamllint.readthedocs.io/en/stable/configuration.html){:target="_blank"} (ex: `.yaml-lint.yml`, `.yamllint.yml`)                                | `.yaml-lint.yml`     |



!!! warning

    Please be aware that any config file specified is relative to `$LINTER_RULES_PATH`, so you have to put **all your

    templating** under the path specified. If you are curious to know what are the *default templates* files for your

    linters, they are all available in the [`TEMPLATES`](https://github.com/github/super-linter/tree/master/TEMPLATES) 

    folder



#### Enable or disable linters



!!! info "Note about `VALIDATE_[LANGUAGE]` variables from super-linter [README](https://github.com/github/super-linter#environment-variables){:target="_blank"}"

jobs/super_linter/super_linter.yml

+1 −0
Original line number Diff line number Diff line
@@ -25,6 +25,7 @@ super_linter: 
    RUN_LOCAL: "true"

    DEFAULT_WORKSPACE: $CI_PROJECT_DIR

    DEFAULT_BRANCH: $CI_DEFAULT_BRANCH

    LINTER_RULES_PATH: ".linters"

    OUTPUT_FORMAT: "tap"

    OUTPUT_DETAILS: "detailed"

    OUTPUT_FOLDER: "super-linter.report"

jobs/super_linter/versions/0.2.1.md

0 → 100644
+2 −0
Original line number Diff line number Diff line 
* Improve documentation for `$LINTER_RULES_PATH`

* Default value for `$LINTER_RULES_PATH` is now `.linters`