Merge #482

482: Add yaml linting check in CI r=bidoubiwa a=meili-bot

_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:
  - Linting check in CI:
    Example in `tests.yml create a new job:
    ```yaml
    lint:
      name: Linting check
      runs-on: ubuntu-latest
      steps:
        - uses: actions/checkout@v3
        - name: Yaml lint check
          uses: ibiqlik/action-yamllint@v3
          with:
            config_file: .yamllint.yml
    ```
  - Inside `.yamllint`, you might want to ignore some folders. For example `node_modules` in JS repos
    Example in `.yamllint`:
    ```yaml
    ignore: |
      node_modules
    ````

Since `yamllint` is a python package, we cannot add a local check unless you download [`.yamllint`](https://github.com/adrienverge/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](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) 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
- [ ] Add the directories or files to ignore in `.yamllint`
- [ ] Add information in the contributing guide on this new check.


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>

Author: meili-bors[bot]

.code-samples.meilisearch.yaml

@@ -898,7 +898,7 @@ typo_tolerance_guide_3: |-
     disable_on_words: Some(vec!["shrek".to_string()]),
     min_word_size_for_typos: Some(min_word_size_for_typos),
   };
-  
+
   let task: TaskInfo = client
     .index("movies")
     .set_typo_tolerance(&typo_tolerance)
@@ -1337,7 +1337,7 @@ faceted_search_2: |-
       .build();
   let search_query_3 = SearchQuery::new(&books)
       .with_facets(Selectors::Some(&["genres"]))
-      .with_filter("language = English OR language = French")  
+      .with_filter("language = English OR language = French")
       .build();
 
   let books_response = client
@@ -1634,7 +1634,7 @@ multi_search_1: |-
       .build();
   let search_query_2 = SearchQuery::new(&movie)
       .with_query("nemo")
-      .with_limit(5)      
+      .with_limit(5)
       .build();
 
   let movie_response = client

.github/dependabot.yml

@@ -1,21 +1,21 @@
 version: 2
 updates:
-- package-ecosystem: "github-actions"
-  directory: "/"
-  schedule:
-    interval: "monthly"
-  labels:
-    - 'skip-changelog'
-    - 'dependencies'
-  rebase-strategy: disabled
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    labels:
+      - 'skip-changelog'
+      - 'dependencies'
+    rebase-strategy: disabled
 
-- package-ecosystem: cargo
-  directory: "/"
-  schedule:
-    interval: daily
-    time: "04:00"
-  open-pull-requests-limit: 10
-  labels:
-  - skip-changelog
-  - dependencies
-  rebase-strategy: disabled
+  - package-ecosystem: cargo
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "04:00"
+    open-pull-requests-limit: 10
+    labels:
+      - skip-changelog
+      - dependencies
+    rebase-strategy: disabled

.github/workflows/tests.yml

@@ -69,3 +69,12 @@ jobs:
         run: |
           rustup target add wasm32-unknown-unknown
           cargo check -p web_app --target wasm32-unknown-unknown
+  yaml-lint:
+    name: Yaml linting check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Yaml lint check
+        uses: ibiqlik/action-yamllint@v3
+        with:
+          config_file: .yamllint.yml

.yamllint.yml

@@ -0,0 +1,9 @@
+extends: default
+ignore: |
+  node_modules
+rules:
+  comments-indentation: disable
+  line-length: disable
+  document-start: disable
+  brackets: disable
+  truthy: disable

CONTRIBUTING.md

@@ -124,6 +124,10 @@ sh scripts/check-readme.sh --diff
 
 If it's not, the CI will fail on your PR.
 
+### Yaml lint
+
+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 .`
+
 ## Git Guidelines
 
 ### Git Branches <!-- omit in toc -->