Merge private-beta version as initial release

.github/ISSUE_TEMPLATE/bug-report--.md

@@ -0,0 +1,22 @@
+---
+name: "Bug report \U0001F41E"
+about: Create a bug report
+labels: bug
+
+---
+
+## Describe the bug
+A clear and concise description of what the bug is.
+
+### Steps to reproduce
+Steps to reproduce the behavior.
+
+### Expected behavior
+A clear and concise description of what you expected to happen.
+
+### Environment
+ - OS: [e.g. Arch Linux]
+ - Other details that you think may affect.
+
+### Additional context
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature-request--.md

@@ -0,0 +1,15 @@
+---
+name: "Feature request \U0001F680"
+about: Suggest an idea
+labels: enhancement
+
+---
+
+## Summary
+Brief explanation of the feature.
+
+### Basic example
+Include a basic example or links here.
+
+### Motivation
+Why are we doing this? What use cases does it support? What is the expected outcome?

.github/workflows/build_latest.yaml

@@ -1,100 +1,48 @@
-name: ESPHome-latest
+name: Build-Satellite-Firmware
 
 on:
-  - push
-  - pull_request
-  - workflow_dispatch
+  push:
+    branches:
+      - develop
+  workflow_dispatch:
 
 env:
   DEFAULT_PYTHON: "3.9"
 
-
 jobs:
-  common:
-    name: Create common environment
-    runs-on: ubuntu-latest
-    outputs:
-      cache-key: ${{ steps.cache-key.outputs.key }}
-    steps:
-      - name: Check out code from GitHub
-        uses: actions/[email protected]
-      - name: Generate cache-key
-        id: cache-key
-        run: echo key="${{ hashFiles('requirements.txt') }}" >> $GITHUB_OUTPUT
-      - name: Set up Python ${{ env.DEFAULT_PYTHON }}
-        id: python
-        uses: actions/[email protected]
-        with:
-          python-version: ${{ env.DEFAULT_PYTHON }}
-      - name: Restore Python virtual environment
-        id: cache-venv
-        uses: actions/[email protected]
-        with:
-          path: venv
-          # yamllint disable-line rule:line-length
-          key: ${{ runner.os }}-${{ steps.python.outputs.python-version }}-venv-${{ steps.cache-key.outputs.key }}
-      - name: Create Python virtual environment
-        if: steps.cache-venv.outputs.cache-hit != 'true'
-        run: |
-          python -m venv venv
-          . venv/bin/activate
-          python --version
-          pip install -r requirements.txt
 
-  build-list:
-    runs-on: ubuntu-latest
-    outputs:
-      matrix: ${{ steps.set-matrix.outputs.matrix }}
-    steps:
-      - name: Check out code from GitHub
-        uses: actions/[email protected]
-      - name: Find all YAML satellite files
-        id: set-matrix
-        run: echo "matrix=$(ls config/satellite*.yaml | jq -R -s -c 'split("\n")[:-1]')" >> $GITHUB_OUTPUT
+  build-firmware:
+    uses: esphome/workflows/.github/workflows/build.yml@main
+    with:
+      files: |
+        config/satellite1.yaml
+      esphome-version: 2024.11.2
+      release-summary: develop-branch
+      release-url: 
+      release-version: 
 
 
-  build:
-    name: Build YAML config ${{ matrix.file }}
-    runs-on: ubuntu-latest
+  create_artifact_matrix:
+    name: Create artifact matrix
     needs:
-      - common
-      - build-list
-    strategy:
-      fail-fast: false
-      max-parallel: 2
-      matrix:
-        file: ${{ fromJson(needs.build-list.outputs.matrix) }}
+      - build-firmware
+    outputs:
+      matrix: ${{ steps.artifacts.outputs.matrix }}
+    runs-on: ubuntu-latest
     steps:
-      - name: Check out code from GitHub
-        uses: actions/[email protected]
-      - name: Restore Python
-        uses: ./.github/actions/restore-python
-        with:
-          python-version: ${{ env.DEFAULT_PYTHON }}
-          cache-key: ${{ needs.common.outputs.cache-key }}
-
-      - name: Run esphome compile ${{ matrix.file }}
-        run: |
-          . venv/bin/activate
-          esphome compile ${{ matrix.file }}
-          esphome config ${{ matrix.file }} >> ${{ matrix.file }}.cmpl.yaml 
-
-      - name: Parse name
-        id: get_node_name
-        uses: mikefarah/yq@master
+      - name: Download artifacts
+        uses: actions/[email protected]
         with:
-          cmd: yq '.esphome.name' ${{ matrix.file }}.cmpl.yaml
+          path: files
 
-      - name: 'Upload Artifact'
-        uses: actions/upload-artifact@v4
-        with:
-          name: ${{ steps.get_node_name.outputs.result }}.firmware.factory.bin
-          path: config/.esphome/build/${{ steps.get_node_name.outputs.result }}/.pioenvs/${{ steps.get_node_name.outputs.result }}/firmware.factory.bin
-          retention-days: 30
+      - run: tree
 
-      - name: 'Upload Artifact'
-        uses: actions/upload-artifact@v4
-        with:
-          name: ${{ steps.get_node_name.outputs.result }}.firmware.bin
-          path: config/.esphome/build/${{ steps.get_node_name.outputs.result }}/.pioenvs/${{ steps.get_node_name.outputs.result }}/firmware.bin
-          retention-days: 30
+      - name: Get artifact names
+        id: artifacts
+        run: |
+          artifacts=$(ls --format=single-column files)
+          echo "artifacts<<EOF" >> $GITHUB_OUTPUT
+          echo "$artifacts" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT 
+          echo "matrix=$(ls files | jq -R -s -c 'split("\n")[:-1]')" >> $GITHUB_OUTPUT
+

.github/workflows/build_release.yaml

@@ -0,0 +1,166 @@
+name: Build-and-Release-Satellite-Firmware
+
+on:
+  push:
+    branches:
+      - main
+      - staging
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Tag for the release (optional). If not provided, it will be auto-generated.'
+        required: false
+
+env:
+  DEFAULT_PYTHON: "3.9"
+permissions:
+  contents: write
+  pull-requests: read
+jobs:
+  prepare:
+    runs-on: ubuntu-latest
+    outputs:
+      commit_id: ${{ steps.dump.outputs.commit }}
+      previous_tag: ${{ steps.dump.outputs.previous_tag }}
+      next_tag: ${{ steps.set_release_tag.outputs.release_tag }}
+    steps:
+      - name: Check out code from GitHub
+        uses: actions/[email protected]
+        with:
+          fetch-depth: 0
+
+      - name: Set Manual Tag (if provided)
+        id: set_tag
+        if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.tag != '' }}
+        run: echo "manual_tag=${{ github.event.inputs.tag }}" >> $GITHUB_OUTPUT
+
+      - name: Bump version
+        # if manual tag is provided, use it
+        if: ${{ !steps.set_tag.outputs.manual_tag }}
+        uses: anothrNick/[email protected]
+        id: bump
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # To create a major bump add #major to commit message
+          DEFAULT_BUMP: 'patch'
+          WITH_V: true
+          PRERELEASE: ${{ github.ref_name != 'main' }}
+          PRERELEASE_SUFFIX: ${{ github.ref_name == 'staging' && 'beta' || 'alpha' }}
+          DRY_RUN: true # Prevent action from pushing the tag.
+          INITIAL_VERSION: 0.0.0
+
+      - name: Set tag for release
+        if: ${{ steps.set_tag.outputs.manual_tag || steps.bump.outputs.tag }}
+        id: set_release_tag
+        run: |
+            if [ -z "${{ steps.set_tag.outputs.manual_tag }}" ]; then
+              echo "release_tag=${{ steps.bump.outputs.tag }}" >> $GITHUB_OUTPUT
+            else
+              echo "release_tag=${{ steps.set_tag.outputs.manual_tag }}" >> $GITHUB_OUTPUT
+            fi
+
+      - id: dump
+        name: Set outputs
+        run: |
+          echo "gh_env=${{ github.ref_name == 'main' && 'production' || github.ref_name == 'staging' && 'beta' || 'alpha' }}" >> $GITHUB_OUTPUT
+          echo "commit=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT
+          echo "long_version=${{ steps.set_release_tag.outputs.release_tag }}_$(date +%Y-%m-%d)_$(git rev-parse HEAD)" >> $GITHUB_OUTPUT
+          echo "label_version=$(echo "${{ steps.set_release_tag.outputs.release_tag }}" | sed 's/\./dot/g' | sed 's/-/dash/g')" >> $GITHUB_OUTPUT
+          echo "previous_tag=$(git describe --abbrev=0 --tags)" >> $GITHUB_OUTPUT
+          echo "files=$(ls config/satellite*.yaml | jq --slurp --raw-input )" >> $GITHUB_OUTPUT     
+
+      - name: Update YAML files
+        run: |
+          files=$(echo ${{ steps.dump.outputs.files }} \
+                | sed 's/^"//' \
+                | sed 's/"$//' \
+                | sed 's/\\n/\n/g')
+          tag="${{ steps.set_release_tag.outputs.release_tag }}"
+          for file in $files; do
+            echo "Updating $file"
+            # Use sed to match the esp32_fw_version line and replace its value
+            sed -i "s/^\(\s*esp32_fw_version:\s*\).*/\1\"${tag}\"/" "$file"
+          done
+  build-firmware:
+    name: Build Firmware
+    needs:
+      - prepare
+    uses: esphome/workflows/.github/workflows/build.yml@main
+    with:
+      files: |
+        config/satellite1.yaml
+      esphome-version: 2024.11.2
+      release-version: ${{ needs.prepare.outputs.next_tag }}
+
+  push-tag:
+    name: Push tag to repository and build changelog.
+    needs:
+      - prepare
+      - build-firmware
+    runs-on: ubuntu-latest
+    outputs:
+      changelog: ${{ steps.changelog.outputs.changelog }}
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+              fetch-depth: 0
+
+      - name: Bump version and push tag
+        if: ${{ !github.event.inputs.tag }}
+        uses: anothrNick/[email protected]
+        id: bump
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # To create a major bump add #major to commit message
+          DEFAULT_BUMP: 'patch'
+          WITH_V: true
+          PRERELEASE: ${{ github.ref_name != 'main' }}
+          PRERELEASE_SUFFIX: ${{ github.ref_name == 'staging' && 'beta' || 'alpha' }}
+          DRY_RUN: false # Set the tag to the commit.
+          INITIAL_VERSION: 0.0.0
+
+      - name: Release Changelog Builder
+        id: changelog
+        uses: mikepenz/release-changelog-builder-action@v5
+        with:
+          fromTag: ${{ needs.prepare.outputs.previous_tag }}
+
+  create_release:
+    name: Create Release
+    # only build release for staging and main branches
+    # if: github.ref_name == 'main' || github.ref_name == 'staging' 
+    needs:
+      - push-tag
+      - prepare
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: files
+
+      - name: Create zip files
+        run: |
+          mkdir -p build
+          echo "Copying all files to build directory"
+          find files -name "*.bin" -exec cp {} build/ \;
+
+      - name: Create release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: build/*.bin
+          generate_release_notes: true
+          append_body: true
+          body: ${{ needs.push-tag.outputs.changelog }}
+          tag_name: ${{ needs.prepare.outputs.next_tag }}
+
+      - name: Update Documentation
+        run: |
+          curl -X POST \
+            -H "Accept: application/vnd.github+json" \
+            -H "Authorization: Bearer ${{ secrets.SECOND_REPO_PAT }}" \
+            https://api.github.com/repos/FutureProofHomes/Documentation/actions/workflows/update-binaries-esp32.yaml/dispatches \
+            -d '{"ref":"main", "inputs": {"esphome_release_tag": "${{ needs.prepare.outputs.next_tag }}"}}'
+        env:
+          SECOND_REPO_PAT: ${{ secrets.SECOND_REPO_PAT }}

.gitignore

@@ -1,7 +1,6 @@
 __pycache__
 *.pyc
 .venv/
-**/.esphome/
 *.egg-info/
 
 .esphome_repo
@@ -17,4 +16,11 @@ managed_components/
 sdkconfig.esp32-idf
 sdkconfig.esp32-s3-idf
 
-*/**/secrets.yaml
+**/.esphome/
+**/secrets.yaml
+
+/testdata
+/wake-word-benchmark/
+/Docker/firmware_server/shared-folder
+
+**/.DS_Store

Docker/firmware_server/Dockerfile

@@ -0,0 +1 @@
+FROM nginx:alpine

Docker/firmware_server/config/default.conf

@@ -0,0 +1,15 @@
+server {
+    listen       80;
+    server_name  localhost;
+
+    location / {
+        root   /usr/share/nginx/html;
+        index  index.html index.htm;
+        autoindex on;
+    }
+
+    error_page   500 502 503 504  /50x.html;
+    location = /50x.html {
+        root   /usr/share/nginx/html;
+    }
+}

Docker/firmware_server/docker-compose.yaml

@@ -0,0 +1,10 @@
+version: '2'
+
+services:
+    web:
+        build: .
+        volumes:
+            - ./config/default.conf:/etc/nginx/conf.d/default.conf
+            - ./shared-folder:/usr/share/nginx/html
+        ports:
+            - 8080:80