meilisearch / vuepress-plugin-meilisearch

Add a relevant and typo tolerant search bar to your VuePress
MIT License
63 stars 14 forks source link

Add yaml linting check in CI #306

Closed meili-bot closed 10 months ago

meili-bot commented 1 year ago

This PR is auto-generated.

To avoid mistakes in the yaml files, for example, duplicated keys or wrong indentation, we decided to add a lint check on yaml files.

Additional to the .yamllint files added in this pr, the following must be added as well:

Since yamllint is a python package, we cannot add a local check unless you download .yamllint. In which case, you can check if the yaml files are correctly linted by running the following command: yamllint .

Additionally, you can use the VSCode extension YAML by redhat which automatically highlights errors.

To help users be aware of this, we recommend adding this to your contributing guide:

To check if your `yaml` files are correctly formatted, you need to [install yamllint](https://yamllint.readthedocs.io/en/stable/quickstart.html#installing-yamllint) and then run `yamllint .`

TODO