YAML linting (esphome#3779)

Petapton · Sep 6, 2022 · 89fd367 · 89fd367
1 parent c317422
commit 89fd367
Show file tree

Hide file tree

Showing 27 changed files with 1,039 additions and 933 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -25,10 +25,9 @@ indent_size = 2
 [*.{yaml,yml}]
 indent_style = space
 indent_size = 2
-quote_type = single
+quote_type = double
 
 # JSON
 [*.json]
 indent_style = space
 indent_size = 2
-
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -1,3 +1,4 @@
+---
 # These are supported funding model platforms
 
 custom: https://www.nabucasa.com
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,11 +1,15 @@
+---
 blank_issues_enabled: false
 contact_links:
   - name: Issue Tracker
     url: https://github.com/esphome/issues
     about: Please create bug reports in the dedicated issue tracker.
   - name: Feature Request Tracker
     url: https://github.com/esphome/feature-requests
-    about: Please create feature requests in the dedicated feature request tracker.
+    about: |
+      Please create feature requests in the dedicated feature request tracker.
   - name: Frequently Asked Question
     url: https://esphome.io/guides/faq.html
-    about: Please view the FAQ for common questions and what to include in a bug report.
+    about: |
+      Please view the FAQ for common questions and what
+      to include in a bug report.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,13 +1,14 @@
+---
 version: 2
 updates:
-  - package-ecosystem: "pip"
+  - package-ecosystem: pip
     directory: "/"
     schedule:
-      interval: "daily"
+      interval: daily
     ignore:
       # Hypotehsis is only used for testing and is updated quite often
       - dependency-name: hypothesis
-  - package-ecosystem: "github-actions"
+  - package-ecosystem: github-actions
     directory: "/"
     schedule:
       interval: daily

diff --git a/.github/workflows/ci-docker.yml b/.github/workflows/ci-docker.yml
@@ -1,21 +1,23 @@
+---
 name: CI for docker images
 
 # Only run when docker paths change
+# yamllint disable-line rule:truthy
 on:
   push:
     branches: [dev, beta, release]
     paths:
-      - 'docker/**'
-      - '.github/workflows/**'
-      - 'requirements*.txt'
-      - 'platformio.ini'
+      - "docker/**"
+      - ".github/workflows/**"
+      - "requirements*.txt"
+      - "platformio.ini"
 
   pull_request:
     paths:
-      - 'docker/**'
-      - '.github/workflows/**'
-      - 'requirements*.txt'
-      - 'platformio.ini'
+      - "docker/**"
+      - ".github/workflows/**"
+      - "requirements*.txt"
+      - "platformio.ini"
 
 permissions:
   contents: read
@@ -30,24 +32,24 @@ jobs:
         arch: [amd64, armv7, aarch64]
         build_type: ["ha-addon", "docker", "lint"]
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: '3.9'
-    - name: Set up Docker Buildx
-      uses: docker/setup-buildx-action@v2
-    - name: Set up QEMU
-      uses: docker/setup-qemu-action@v2
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
 
-    - name: Set TAG
-      run: |
-        echo "TAG=check" >> $GITHUB_ENV
+      - name: Set TAG
+        run: |
+          echo "TAG=check" >> $GITHUB_ENV
 
-    - name: Run build
-      run: |
-        docker/build.py \
-          --tag "${TAG}" \
-          --arch "${{ matrix.arch }}" \
-          --build-type "${{ matrix.build_type }}" \
-          build
+      - name: Run build
+        run: |
+          docker/build.py \
+            --tag "${TAG}" \
+            --arch "${{ matrix.arch }}" \
+            --build-type "${{ matrix.build_type }}" \
+            build
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,5 +1,7 @@
+---
 name: CI
 
+# yamllint disable-line rule:truthy
 on:
   push:
     branches: [dev, beta, release]
@@ -10,6 +12,7 @@ permissions:
   contents: read
 
 concurrency:
+  # yamllint disable-line rule:line-length
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
   cancel-in-progress: true
 
@@ -73,24 +76,28 @@ jobs:
             name: Run script/clang-tidy for ESP32 IDF
             options: --environment esp32-idf-tidy --grep USE_ESP_IDF
             pio_cache_key: tidyesp32-idf
+          - id: yamllint
+            name: Run yamllint
 
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python
         uses: actions/setup-python@v4
         id: python
         with:
-          python-version: '3.8'
+          python-version: "3.8"
 
       - name: Cache virtualenv
         uses: actions/cache@v3
         with:
           path: .venv
+          # yamllint disable-line rule:line-length
           key: venv-${{ steps.python.outputs.python-version }}-${{ hashFiles('requirements*.txt') }}
           restore-keys: |
             venv-${{ steps.python.outputs.python-version }}-
 
       - name: Set up virtualenv
+        # yamllint disable rule:line-length
         run: |
           python -m venv .venv
           source .venv/bin/activate
@@ -99,12 +106,14 @@ jobs:
           pip install -e .
           echo "$GITHUB_WORKSPACE/.venv/bin" >> $GITHUB_PATH
           echo "VIRTUAL_ENV=$GITHUB_WORKSPACE/.venv" >> $GITHUB_ENV
+        # yamllint enable rule:line-length
 
       # Use per check platformio cache because checks use different parts
       - name: Cache platformio
         uses: actions/cache@v3
         with:
           path: ~/.platformio
+          # yamllint disable-line rule:line-length
           key: platformio-${{ matrix.pio_cache_key }}-${{ hashFiles('platformio.ini') }}
         if: matrix.id == 'test' || matrix.id == 'clang-tidy'
 
@@ -145,8 +154,9 @@ jobs:
           pytest -vv --tb=native tests
         if: matrix.id == 'pytest'
 
-      # Also run git-diff-index so that the step is marked as failed on formatting errors,
-      # since clang-format doesn't do anything but change files if -i is passed.
+      # Also run git-diff-index so that the step is marked as failed on
+      # formatting errors, since clang-format doesn't do anything but
+      # change files if -i is passed.
       - name: Run clang-format
         run: |
           script/clang-format -i
@@ -161,6 +171,11 @@ jobs:
           # Also cache libdeps, store them in a ~/.platformio subfolder
           PLATFORMIO_LIBDEPS_DIR: ~/.platformio/libdeps
 
+      - name: Run yamllint
+        if: matrix.id == 'yamllint'
+        uses: frenck/action-yamllint@v1.2.0
+
       - name: Suggested changes
         run: script/ci-suggest-changes
+        # yamllint disable-line rule:line-length
         if: always() && (matrix.id == 'clang-tidy' || matrix.id == 'clang-format' || matrix.id == 'lint-python')
diff --git a/.github/workflows/lock.yml b/.github/workflows/lock.yml
@@ -1,8 +1,10 @@
+---
 name: Lock
 
+# yamllint disable-line rule:truthy
 on:
   schedule:
-    - cron: '30 0 * * *'
+    - cron: "30 0 * * *"
   workflow_dispatch:
 
 permissions:

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,5 +1,7 @@
+---
 name: Publish Release
 
+# yamllint disable-line rule:truthy
 on:
   workflow_dispatch:
   release:
@@ -20,6 +22,7 @@ jobs:
       - uses: actions/checkout@v3
       - name: Get tag
         id: tag
+        # yamllint disable rule:line-length
         run: |
           if [[ "$GITHUB_EVENT_NAME" = "release" ]]; then
             TAG="${GITHUB_REF#refs/tags/}"
@@ -29,6 +32,7 @@ jobs:
             TAG="${TAG}${today}"
           fi
           echo "::set-output name=tag::${TAG}"
+        # yamllint enable rule:line-length
 
   deploy-pypi:
     name: Build and publish to PyPi
@@ -39,7 +43,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.x'
+          python-version: "3.x"
       - name: Set up python environment
         run: |
           script/setup
@@ -65,37 +69,37 @@ jobs:
         arch: [amd64, armv7, aarch64]
         build_type: ["ha-addon", "docker", "lint"]
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: '3.9'
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
 
-    - name: Set up Docker Buildx
-      uses: docker/setup-buildx-action@v2
-    - name: Set up QEMU
-      uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
 
-    - name: Log in to docker hub
-      uses: docker/login-action@v2
-      with:
-        username: ${{ secrets.DOCKER_USER }}
-        password: ${{ secrets.DOCKER_PASSWORD }}
-    - name: Log in to the GitHub container registry
-      uses: docker/login-action@v2
-      with:
+      - name: Log in to docker hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_USER }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+      - name: Log in to the GitHub container registry
+        uses: docker/login-action@v2
+        with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-    - name: Build and push
-      run: |
-        docker/build.py \
-          --tag "${{ needs.init.outputs.tag }}" \
-          --arch "${{ matrix.arch }}" \
-          --build-type "${{ matrix.build_type }}" \
-          build \
-          --push
+      - name: Build and push
+        run: |
+          docker/build.py \
+            --tag "${{ needs.init.outputs.tag }}" \
+            --arch "${{ matrix.arch }}" \
+            --build-type "${{ matrix.build_type }}" \
+            build \
+            --push
 
   deploy-docker-manifest:
     if: github.repository == 'esphome/esphome'
@@ -108,34 +112,34 @@ jobs:
       matrix:
         build_type: ["ha-addon", "docker", "lint"]
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: '3.9'
-    - name: Enable experimental manifest support
-      run: |
-        mkdir -p ~/.docker
-        echo "{\"experimental\": \"enabled\"}" > ~/.docker/config.json
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+      - name: Enable experimental manifest support
+        run: |
+          mkdir -p ~/.docker
+          echo "{\"experimental\": \"enabled\"}" > ~/.docker/config.json
 
-    - name: Log in to docker hub
-      uses: docker/login-action@v2
-      with:
-        username: ${{ secrets.DOCKER_USER }}
-        password: ${{ secrets.DOCKER_PASSWORD }}
-    - name: Log in to the GitHub container registry
-      uses: docker/login-action@v2
-      with:
+      - name: Log in to docker hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_USER }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+      - name: Log in to the GitHub container registry
+        uses: docker/login-action@v2
+        with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-    - name: Run manifest
-      run: |
-        docker/build.py \
-          --tag "${{ needs.init.outputs.tag }}" \
-          --build-type "${{ matrix.build_type }}" \
-          manifest
+      - name: Run manifest
+        run: |
+          docker/build.py \
+            --tag "${{ needs.init.outputs.tag }}" \
+            --build-type "${{ matrix.build_type }}" \
+            manifest
 
   deploy-ha-addon-repo:
     if: github.repository == 'esphome/esphome' && github.event_name == 'release'
@@ -144,6 +148,7 @@ jobs:
     steps:
       - env:
           TOKEN: ${{ secrets.DEPLOY_HA_ADDON_REPO_TOKEN }}
+        # yamllint disable rule:line-length
         run: |
           TAG="${GITHUB_REF#refs/tags/}"
           curl \
@@ -152,3 +157,4 @@ jobs:
             -H "Accept: application/vnd.github.v3+json" \
             https://api.github.com/repos/esphome/home-assistant-addon/actions/workflows/bump-version.yml/dispatches \
             -d "{\"ref\":\"main\",\"inputs\":{\"version\":\"$TAG\"}}"
+        # yamllint enable rule:line-length