feat: add a GitHub action to lint the YAML files

Lint some YAML
Add a `.yamllint` config file

.asf.yaml

@@ -15,8 +15,8 @@ github:
     - microcontroller
   enabled_merge_buttons:
     # disable squash button:
-    squash:  false
+    squash: false
     # disable merge button:
-    merge:   false
+    merge: false
     # enable rebase button:
-    rebase:  true
+    rebase: true

.github/workflows/build.yml

@@ -150,7 +150,7 @@ jobs:
           command: docker pull docker.pkg.github.com/apache/incubator-nuttx-testing/nuttx-ci-linux
 
       - name: Export NuttX Repo SHA
-        run:  echo "nuttx_sha=`git -C sources/nuttx rev-parse HEAD`" >> $GITHUB_ENV
+        run: echo "nuttx_sha=`git -C sources/nuttx rev-parse HEAD`" >> $GITHUB_ENV
       - name: Run builds
         uses: ./sources/testing/.github/actions/ci-container
         env:
@@ -193,7 +193,7 @@ jobs:
           key: ${{ runner.os }}-tools-${{ hashFiles('./sources/testing/cibuild.sh') }}
 
       - name: Export NuttX Repo SHA
-        run:  echo "nuttx_sha=`git -C sources/nuttx rev-parse HEAD`" >> $GITHUB_ENV
+        run: echo "nuttx_sha=`git -C sources/nuttx rev-parse HEAD`" >> $GITHUB_ENV
       - name: Run Builds
         run: |
           echo "::add-matcher::sources/nuttx/.github/gcc.json"

.github/workflows/check.yml

@@ -22,18 +22,18 @@ jobs:
     runs-on: ubuntu-18.04
 
     steps:
-    - name: Checkout nuttx repo
+      - name: Checkout nuttx repo
-      uses: actions/checkout@v2
+        uses: actions/checkout@v2
-      with:
+        with:
-        repository: apache/incubator-nuttx
+          repository: apache/incubator-nuttx
-        path: nuttx
+          path: nuttx
-        fetch-depth: 0
+          fetch-depth: 0
 
-    - name: Check Pull Request
+      - name: Check Pull Request
-      run: |
+        run: |
-        echo "::add-matcher::nuttx/.github/nxstyle.json"
+          echo "::add-matcher::nuttx/.github/nxstyle.json"
-        cd nuttx
+          cd nuttx
-        commits="${{ github.event.pull_request.base.sha }}..HEAD"
+          commits="${{ github.event.pull_request.base.sha }}..HEAD"
-        git log --oneline $commits
+          git log --oneline $commits
-        echo "../nuttx/tools/checkpatch.sh -g $commits"
+          echo "../nuttx/tools/checkpatch.sh -g $commits"
-        ../nuttx/tools/checkpatch.sh -g $commits
+          ../nuttx/tools/checkpatch.sh -g $commits

.github/workflows/doc.yml

@@ -19,35 +19,35 @@ jobs:
   build-html:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
+      - uses: actions/checkout@v1
-    - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v2
-      with:
+        with:
-        python-version: '3.8'
+          python-version: '3.8'
-    - name: Generate requirements.txt file
+      - name: Generate requirements.txt file
-      run: |
+        run: |
-        cd Documentation/
+          cd Documentation/
-        pip3 install pipenv
+          pip3 install pipenv
-        pipenv lock -r > requirements.txt
+          pipenv lock -r > requirements.txt
-    - uses: ammaraskar/sphinx-problem-matcher@master
+      - uses: ammaraskar/sphinx-problem-matcher@master
-    - uses: ammaraskar/sphinx-action@master
+      - uses: ammaraskar/sphinx-action@master
-      with:
+        with:
-        docs-folder: "Documentation/"
+          docs-folder: "Documentation/"
-    - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v2
-      with:
+        with:
-        name: sphinx-docs
+          name: sphinx-docs
-        path: Documentation/_build/html/
+          path: Documentation/_build/html/
   linkcheck:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
+      - uses: actions/checkout@v1
-    - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v2
-      with:
+        with:
-        python-version: '3.8'
+          python-version: '3.8'
-    - uses: ammaraskar/sphinx-problem-matcher@master
+      - uses: ammaraskar/sphinx-problem-matcher@master
-    - name: Run linkcheck
+      - name: Run linkcheck
-      run: |
+        run: |
-        cd Documentation/
+          cd Documentation/
-        pip3 install pipenv
+          pip3 install pipenv
-        pipenv install
+          pipenv install
-        # This step flakes frequently so still annotate errors but dont fail the build
+          # This step flakes frequently so still annotate errors but dont fail the build
-        pipenv run make linkcheck || true
+          pipenv run make linkcheck || true

.github/workflows/lint.yml

@@ -0,0 +1,12 @@
+name: ❄️ Lint
+
+on: [pull_request]
+
+jobs:
+  yamllint:
+    name: 🍺 YAML
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: 🧹 YAML Lint
+        uses: ibiqlik/action-yamllint@v3

.yamllint

@@ -0,0 +1,8 @@
+---
+
+extends: default
+
+rules:
+  document-start: disable
+  line-length: disable
+  truthy: disable