Merge tag '2024.6.4' into bsec2_bme68x

.devcontainer/devcontainer.json

@@ -7,8 +7,21 @@
     "PIP_BREAK_SYSTEM_PACKAGES": "1",
     "PIP_ROOT_USER_ACTION": "ignore"
   },
-  "runArgs": ["--privileged", "-e", "ESPHOME_DASHBOARD_USE_PING=1"],
+  "runArgs": [
+    "--privileged",
+    "-e",
+    "ESPHOME_DASHBOARD_USE_PING=1"
+    // uncomment and edit the path in order to pass though local USB serial to the conatiner
+    // , "--device=/dev/ttyACM0"
+  ],
   "appPort": 6052,
+  // if you are using avahi in the host device, uncomment these to allow the
+  // devcontainer to find devices via mdns
+  //"mounts": [
+  //  "type=bind,source=/dev/bus/usb,target=/dev/bus/usb",
+  //  "type=bind,source=/var/run/dbus,target=/var/run/dbus",
+  //  "type=bind,source=/var/run/avahi-daemon/socket,target=/var/run/avahi-daemon/socket"
+  //],
   "customizations": {
     "vscode": {
       "extensions": [

setup.cfg → .flake8

@@ -1,20 +1,3 @@
-[metadata]
-license      = MIT
-license_file = LICENSE
-platforms = any
-description  = Make creating custom firmwares for ESP32/ESP8266 super easy.
-long_description = file: README.md
-keywords     = home, automation
-classifier =
-    Environment :: Console
-    Intended Audience :: Developers
-    Intended Audience :: End Users/Desktop
-    License :: OSI Approved :: MIT License
-    Programming Language :: C++
-    Programming Language :: Python :: 3
-    Topic :: Home Automation
-Topic :: Home Automation
-
 [flake8]
 max-line-length = 120
 # Following 4 for black compatibility
@@ -38,25 +21,22 @@ max-line-length = 120
 # D401 First line should be in imperative mood
 
 ignore =
-    E501,
-    W503,
-    E203,
-    D202,
+  E501,
+  W503,
+  E203,
+  D202,
 
-    D100,
-    D101,
-    D102,
-    D103,
-    D104,
-    D105,
-    D107,
-    D200,
-    D205,
-    D209,
-    D400,
-    D401,
+  D100,
+  D101,
+  D102,
+  D103,
+  D104,
+  D105,
+  D107,
+  D200,
+  D205,
+  D209,
+  D400,
+  D401,
 
 exclude = api_pb2.py
-
-[bdist_wheel]
-universal = 1

.github/actions/build-image/action.yaml

@@ -34,16 +34,26 @@ runs:
           echo $l >> $GITHUB_OUTPUT
         done
 
+    # set cache-to only if dev branch
+    - id: cache-to
+      shell: bash
+      run: |-
+        if [[ "${{ github.ref }}" == "refs/heads/dev" ]]; then
+          echo "value=type=gha,mode=max" >> $GITHUB_OUTPUT
+        else
+          echo "value=" >> $GITHUB_OUTPUT
+        fi
+
     - name: Build and push to ghcr by digest
       id: build-ghcr
-      uses: docker/build-push-action@v5.0.0
+      uses: docker/build-push-action@v6.0.1
       with:
         context: .
         file: ./docker/Dockerfile
         platforms: ${{ inputs.platform }}
         target: ${{ inputs.target }}
         cache-from: type=gha
-        cache-to: type=gha,mode=max
+        cache-to: ${{ steps.cache-to.outputs.value }}
         build-args: |
           BASEIMGTYPE=${{ inputs.baseimg }}
           BUILD_VERSION=${{ inputs.version }}
@@ -57,24 +67,16 @@ runs:
         digest="${{ steps.build-ghcr.outputs.digest }}"
         touch "/tmp/digests/${{ inputs.target }}/ghcr/${digest#sha256:}"
 
-    - name: Upload ghcr digest
-      uses: actions/[email protected]
-      with:
-        name: digests-${{ inputs.target }}-ghcr
-        path: /tmp/digests/${{ inputs.target }}/ghcr/*
-        if-no-files-found: error
-        retention-days: 1
-
     - name: Build and push to dockerhub by digest
       id: build-dockerhub
-      uses: docker/build-push-action@v5.0.0
+      uses: docker/build-push-action@v6.0.1
       with:
         context: .
         file: ./docker/Dockerfile
         platforms: ${{ inputs.platform }}
         target: ${{ inputs.target }}
         cache-from: type=gha
-        cache-to: type=gha,mode=max
+        cache-to: ${{ steps.cache-to.outputs.value }}
         build-args: |
           BASEIMGTYPE=${{ inputs.baseimg }}
           BUILD_VERSION=${{ inputs.version }}
@@ -87,11 +89,3 @@ runs:
         mkdir -p /tmp/digests/${{ inputs.target }}/dockerhub
         digest="${{ steps.build-dockerhub.outputs.digest }}"
         touch "/tmp/digests/${{ inputs.target }}/dockerhub/${digest#sha256:}"
-
-    - name: Upload dockerhub digest
-      uses: actions/[email protected]
-      with:
-        name: digests-${{ inputs.target }}-dockerhub
-        path: /tmp/digests/${{ inputs.target }}/dockerhub/*
-        if-no-files-found: error
-        retention-days: 1

.github/actions/restore-python/action.yml

@@ -17,22 +17,31 @@ runs:
   steps:
     - name: Set up Python ${{ inputs.python-version }}
       id: python
-      uses: actions/setup-python@v5.0.0
+      uses: actions/setup-python@v5.1.0
       with:
         python-version: ${{ inputs.python-version }}
     - name: Restore Python virtual environment
       id: cache-venv
-      uses: actions/cache/restore@v3.3.2
+      uses: actions/cache/restore@v4.0.2
       with:
         path: venv
         # yamllint disable-line rule:line-length
         key: ${{ runner.os }}-${{ steps.python.outputs.python-version }}-venv-${{ inputs.cache-key }}
     - name: Create Python virtual environment
-      if: steps.cache-venv.outputs.cache-hit != 'true'
+      if: steps.cache-venv.outputs.cache-hit != 'true' && runner.os != 'Windows'
       shell: bash
       run: |
         python -m venv venv
-        . venv/bin/activate
+        source venv/bin/activate
+        python --version
+        pip install -r requirements.txt -r requirements_optional.txt -r requirements_test.txt
+        pip install -e .
+    - name: Create Python virtual environment
+      if: steps.cache-venv.outputs.cache-hit != 'true' && runner.os == 'Windows'
+      shell: bash
+      run: |
+        python -m venv venv
+        ./venv/Scripts/activate
         python --version
         pip install -r requirements.txt -r requirements_optional.txt -r requirements_test.txt
         pip install -e .

.github/dependabot.yml

@@ -13,3 +13,13 @@ updates:
     schedule:
       interval: daily
     open-pull-requests-limit: 10
+  - package-ecosystem: github-actions
+    directory: "/.github/actions/build-image"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+  - package-ecosystem: github-actions
+    directory: "/.github/actions/restore-python"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10

.github/workflows/ci-api-proto.yml

@@ -0,0 +1,80 @@
+name: API Proto CI
+
+on:
+  pull_request:
+    paths:
+      - "esphome/components/api/api.proto"
+      - "esphome/components/api/api_pb2.cpp"
+      - "esphome/components/api/api_pb2.h"
+      - "esphome/components/api/api_pb2_service.cpp"
+      - "esphome/components/api/api_pb2_service.h"
+      - "script/api_protobuf/api_protobuf.py"
+      - ".github/workflows/ci-api-proto.yml"
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  check:
+    name: Check generated files
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/[email protected]
+      - name: Set up Python
+        uses: actions/[email protected]
+        with:
+          python-version: "3.11"
+
+      - name: Install apt dependencies
+        run: |
+          sudo apt update
+          sudo apt-cache show protobuf-compiler
+          sudo apt install -y protobuf-compiler
+          protoc --version
+      - name: Install python dependencies
+        run: pip install aioesphomeapi -c requirements.txt -r requirements_dev.txt
+      - name: Generate files
+        run: script/api_protobuf/api_protobuf.py
+      - name: Check for changes
+        run: |
+          if ! git diff --quiet; then
+            echo "## Job Failed" | tee -a $GITHUB_STEP_SUMMARY
+            echo "You have altered the generated proto files but they do not match what is expected." | tee -a $GITHUB_STEP_SUMMARY
+            echo "Please run 'script/api_protobuf/api_protobuf.py' and commit the changes." | tee -a $GITHUB_STEP_SUMMARY
+            exit 1
+          fi
+      - if: failure()
+        name: Review PR
+        uses: actions/[email protected]
+        with:
+          script: |
+            await github.rest.pulls.createReview({
+              pull_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              event: 'REQUEST_CHANGES',
+              body: 'You have altered the generated proto files but they do not match what is expected.\nPlease run "script/api_protobuf/api_protobuf.py" and commit the changes.'
+            })
+      - if: success()
+        name: Dismiss review
+        uses: actions/[email protected]
+        with:
+          script: |
+            let reviews = await github.rest.pulls.listReviews({
+              pull_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo
+            });
+            for (let review of reviews.data) {
+              if (review.user.login === 'github-actions[bot]' && review.state === 'CHANGES_REQUESTED') {
+                await github.rest.pulls.dismissReview({
+                  pull_number: context.issue.number,
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  review_id: review.id,
+                  message: 'Files now match the expected proto files.'
+                });
+              }
+            }

.github/workflows/ci-docker.yml

@@ -2,7 +2,7 @@
 name: CI for docker images
 
 # Only run when docker paths change
-# yamllint disable-line rule:truthy
+
 on:
   push:
     branches: [dev, beta, release]
@@ -40,13 +40,13 @@ jobs:
         arch: [amd64, armv7, aarch64]
         build_type: ["ha-addon", "docker", "lint"]
     steps:
-      - uses: actions/[email protected].1
+      - uses: actions/[email protected].6
       - name: Set up Python
-        uses: actions/setup-python@v5.0.0
+        uses: actions/setup-python@v5.1.0
         with:
           python-version: "3.9"
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3.0.0
+        uses: docker/setup-buildx-action@v3.3.0
       - name: Set up QEMU
         uses: docker/[email protected]