Merge #325

325: Add yaml linting check in CI r=brunoocasali 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
    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
    ```
  - 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>
Co-authored-by: Bruno Casali <brunoocasali@gmail.com>

.github/workflows/tests.yml

@@ -56,6 +56,16 @@ jobs:
       - name: Run linter
         run: dart analyze --fatal-infos && dart format . --set-exit-if-changed
 
+  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
+
   pana:
     runs-on: ubuntu-latest
     timeout-minutes: 10
@@ -73,4 +83,3 @@ jobs:
       - name: Analyze pana output
         run: |
           echo "$PANA_OUTPUT" | grep "Supports 6 of 6 possible platforms"
-

.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