docs: update changelog for version 1.2.16

.github/workflows/providers/gitea-release.yml

@@ -1,18 +1,23 @@
 name: Gitea Release
 
 on:
-  workflow_call:  # This workflow will only be triggered when called by another workflow
+  workflow_call:
+    inputs:
+      version:
+        required: true
+        type: string
+      changelog:
+        required: true
+        type: string
 
 permissions:
-  contents: write      # Required for creating releases
-  issues: read        # Required for reading changelog
-  pull-requests: read # Required for reading changelog
+  contents: write
+  issues: read
+  pull-requests: read
 
 jobs:
   build:
     runs-on: ubuntu-latest
-    permissions:
-      contents: write
     steps:
     - uses: actions/checkout@v4
     
@@ -21,19 +26,17 @@ jobs:
       with:
         python-version: '3.x'
     
-    - name: Install PlatformIO
+    - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install --upgrade platformio
+        pip install --upgrade platformio esptool
+        sudo apt-get update
+        sudo apt-get install -y jq
     
     - name: Build Firmware
       run: |
-        pio run -t buildfs  # Build SPIFFS
-        pio run            # Build firmware
-        
-    - name: Install esptool
-      run: |
-        pip install esptool
+        pio run -t buildfs
+        pio run
         
     - name: Merge firmware and SPIFFS
       run: |
@@ -48,20 +51,7 @@ jobs:
           0x290000 .pio/build/esp32dev/spiffs.bin
 
     - name: Prepare OTA firmware
-      run: |
-        cp .pio/build/esp32dev/firmware.bin .pio/build/esp32dev/filaman_ota.bin
-    
-    - name: Get version from tag
-      id: get_version
-      run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
-      
-    - name: Read CHANGELOG.md
-      id: changelog
-      run: |
-        CHANGELOG=$(awk "/## \\[${{ steps.get_version.outputs.VERSION }}\\]/{p=1;print;next} /## \\[/{p=0} p" CHANGELOG.md)
-        echo "CHANGES<<EOF" >> $GITHUB_OUTPUT
-        echo "$CHANGELOG" >> $GITHUB_OUTPUT
-        echo "EOF" >> $GITHUB_OUTPUT
+      run: cp .pio/build/esp32dev/firmware.bin .pio/build/esp32dev/filaman_ota.bin
     
     - name: Create Release
       env:
@@ -69,33 +59,46 @@ jobs:
         GITEA_API_URL: ${{ secrets.GITEA_API_URL }}
         GITEA_REPOSITORY: ${{ secrets.GITEA_REPOSITORY }}
       run: |
-        # Create release using Gitea API
-        RESPONSE=$(curl -X POST \
-        -H "Authorization: token ${GITEA_TOKEN}" \
-        -H "Content-Type: application/json" \
-        -H "accept: application/json" \
-        "${GITEA_API_URL}/repos/${GITEA_REPOSITORY}/releases" \
-        -d '{
-            "tag_name": "${{ github.ref_name }}",
-            "name": "Release ${{ steps.get_version.outputs.VERSION }}",
-            "body": "${{ steps.changelog.outputs.CHANGES }}",
-            "draft": false,
-            "prerelease": false
-        }')
+        # Validate and sanitize API URL
+        if [[ ! "$GITEA_API_URL" =~ ^https?:// ]]; then
+          echo "Error: GITEA_API_URL must start with http:// or https://"
+          exit 1
+        fi
         
-        # Extract release ID from response
-        RELEASE_ID=$(echo $RESPONSE | jq -r .id)
+        # Remove trailing slash and ensure /api/v1
+        GITEA_API_URL="${GITEA_API_URL%/}"
+        if [[ ! "$GITEA_API_URL" =~ /api/v1$ ]]; then
+          GITEA_API_URL="${GITEA_API_URL}/api/v1"
+        fi
         
-        # Upload full firmware
-        curl -X POST \
-        -H "Authorization: token ${GITEA_TOKEN}" \
-        -H "Content-Type: application/octet-stream" \
-        "${GITEA_API_URL}/repos/${GITEA_REPOSITORY}/releases/${RELEASE_ID}/assets?name=filaman_full.bin" \
-        --data-binary @.pio/build/esp32dev/filaman_full.bin
+        echo "Creating Gitea release..."
+        release_data="{\"tag_name\":\"${{ github.ref_name }}\",\"name\":\"Release ${{ inputs.version }}\",\"body\":${{ toJSON(inputs.changelog) }},\"draft\":false,\"prerelease\":false}"
+        RESPONSE=$(curl -sS -X POST \
+          -H "Authorization: token ${GITEA_TOKEN}" \
+          -H "Content-Type: application/json" \
+          -H "Accept: application/json" \
+          "${GITEA_API_URL}/repos/${GITEA_REPOSITORY}/releases" \
+          -d "$release_data")
         
-        # Upload OTA firmware
-        curl -X POST \
-        -H "Authorization: token ${GITEA_TOKEN}" \
-        -H "Content-Type: application/octet-stream" \
-        "${GITEA_API_URL}/repos/${GITEA_REPOSITORY}/releases/${RELEASE_ID}/assets?name=filaman_ota.bin" \
-        --data-binary @.pio/build/esp32dev/filaman_ota.bin
+        # Extract and validate release ID
+        RELEASE_ID=$(echo "$RESPONSE" | jq -r .id)
+        if [ -z "$RELEASE_ID" ] || [ "$RELEASE_ID" = "null" ]; then
+          echo "Error: Failed to get release ID"
+          echo "API Response:"
+          echo "$RESPONSE" | jq .
+          exit 1
+        fi
+        
+        # Upload binary files
+        for file in "filaman_full.bin" "filaman_ota.bin"; do
+          echo "Uploading $file..."
+          if ! curl -sS -X POST \
+            -H "Authorization: token ${GITEA_TOKEN}" \
+            -H "Content-Type: application/octet-stream" \
+            "${GITEA_API_URL}/repos/${GITEA_REPOSITORY}/releases/${RELEASE_ID}/assets?name=${file}" \
+            --data-binary "@.pio/build/esp32dev/${file}"; then
+            echo "Error: Failed to upload $file"
+            exit 1
+          fi
+          echo "Successfully uploaded $file"
+        done

.github/workflows/providers/github-release.yml

@@ -1,18 +1,21 @@
 name: GitHub Release
 
 on:
-  workflow_call:  # This workflow will only be triggered when called by another workflow
+  workflow_call:
+    inputs:
+      version:
+        required: true
+        type: string
+      changelog:
+        required: true
+        type: string
 
 permissions:
-  contents: write      # Required for creating releases
-  issues: read        # Required for reading changelog
-  pull-requests: read # Required for reading changelog
+  contents: write
 
 jobs:
   build:
     runs-on: ubuntu-latest
-    permissions:
-      contents: write # Required for creating releases at job level
     steps:
     - uses: actions/checkout@v4
     
@@ -21,19 +24,15 @@ jobs:
       with:
         python-version: '3.x'
     
-    - name: Install PlatformIO
+    - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install --upgrade platformio
+        pip install --upgrade platformio esptool
     
     - name: Build Firmware
       run: |
-        pio run -t buildfs  # Build SPIFFS
-        pio run            # Build firmware
-        
-    - name: Install esptool
-      run: |
-        pip install esptool
+        pio run -t buildfs
+        pio run
         
     - name: Merge firmware and SPIFFS
       run: |
@@ -48,36 +47,14 @@ jobs:
           0x290000 .pio/build/esp32dev/spiffs.bin
 
     - name: Prepare OTA firmware
-      run: |
-        # Use PlatformIO to create a proper OTA image
-        cp .pio/build/esp32dev/firmware.bin .pio/build/esp32dev/filaman_ota.bin
+      run: cp .pio/build/esp32dev/firmware.bin .pio/build/esp32dev/filaman_ota.bin
     
-    - name: Get version from tag
-      id: get_version
-      run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
-      
-    - name: Read CHANGELOG.md
-      id: changelog
-      run: |
-        CHANGELOG=$(awk "/## \\[${{ steps.get_version.outputs.VERSION }}\\]/{p=1;print;next} /## \\[/{p=0} p" CHANGELOG.md)
-        echo "CHANGES<<EOF" >> $GITHUB_OUTPUT
-        echo "$CHANGELOG" >> $GITHUB_OUTPUT
-        echo "EOF" >> $GITHUB_OUTPUT
-    
-    - name: Install and Configure GitHub CLI
-      run: |
-        curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg \
-        && sudo chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg \
-        && echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null \
-        && sudo apt update \
-        && sudo apt install gh -y
-        
-    - name: Create Release with GitHub CLI
+    - name: Create GitHub Release
       env:
-        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       run: |
         gh release create "${{ github.ref_name }}" \
-          --title "Release ${{ steps.get_version.outputs.VERSION }}" \
-          --notes "${{ steps.changelog.outputs.CHANGES }}" \
+          --title "Release ${{ inputs.version }}" \
+          --notes "${{ inputs.changelog }}" \
           ".pio/build/esp32dev/filaman_full.bin#filaman_full.bin" \
           ".pio/build/esp32dev/filaman_ota.bin#filaman_ota.bin"

.github/workflows/release.yml

@@ -6,50 +6,28 @@ on:
       - 'v*'
 
 jobs:
-  release:
+  get-version-and-changelog:
     runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.get_version.outputs.VERSION }}
+      changelog: ${{ steps.changelog.outputs.CHANGES }}
     steps:
       - uses: actions/checkout@v4
       
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.x'
-    
-      - name: Install PlatformIO
-        run: |
-          python -m pip install --upgrade pip
-          pip install --upgrade platformio
-    
-      - name: Build Firmware
-        run: |
-          pio run -t buildfs  # Build SPIFFS
-          pio run            # Build firmware
-        
-      - name: Install esptool
-        run: |
-          pip install esptool
-        
-      - name: Merge firmware and SPIFFS
-        run: |
-          esptool.py --chip esp32 merge_bin \
-            --flash_mode dio \
-            --flash_freq 40m \
-            --flash_size 4MB \
-            -o .pio/build/esp32dev/filaman_full.bin \
-            0x1000 .pio/build/esp32dev/bootloader.bin \
-            0x8000 .pio/build/esp32dev/partitions.bin \
-            0x10000 .pio/build/esp32dev/firmware.bin \
-            0x290000 .pio/build/esp32dev/spiffs.bin
-
-      - name: Prepare OTA firmware
-        run: |
-          cp .pio/build/esp32dev/firmware.bin .pio/build/esp32dev/filaman_ota.bin
-      
       - name: Get version from tag
         id: get_version
         run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
       
+      - name: Verify version match
+        run: |
+          PIO_VERSION=$(grep '^version = ' platformio.ini | cut -d'"' -f2)
+          TAG_VERSION=${{ steps.get_version.outputs.VERSION }}
+          
+          if [ "$PIO_VERSION" != "$TAG_VERSION" ]; then
+            echo "Error: Version mismatch between tag ($TAG_VERSION) and platformio.ini ($PIO_VERSION)"
+            exit 1
+          fi
+      
       - name: Read CHANGELOG.md
         id: changelog
         run: |
@@ -58,74 +36,20 @@ jobs:
           echo "$CHANGELOG" >> $GITHUB_OUTPUT
           echo "EOF" >> $GITHUB_OUTPUT
 
-      - name: Install jq
-        if: ${{ github.server_url != 'https://github.com' }}
-        run: sudo apt-get install -y jq
+  github-release:
+    needs: get-version-and-changelog
+    if: github.server_url == 'https://github.com'
+    uses: ./.github/workflows/providers/github-release.yml
+    with:
+      version: ${{ needs.get-version-and-changelog.outputs.version }}
+      changelog: ${{ needs.get-version-and-changelog.outputs.changelog }}
+    secrets: inherit
 
-      - name: Determine and run release process
-        env:
-          GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
-          GITEA_API_URL: ${{ secrets.GITEA_API_URL }}
-          GITEA_REPOSITORY: ${{ secrets.GITEA_REPOSITORY }}
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          if [[ "$GITHUB_SERVER_URL" == "https://github.com" ]]; then
-            echo "Creating GitHub Release..."
-            curl -X POST \
-              -H "Authorization: token ${GITHUB_TOKEN}" \
-              -H "Accept: application/vnd.github.v3+json" \
-              https://api.github.com/repos/${{ github.repository }}/releases \
-              -d '{
-                "tag_name": "${{ github.ref_name }}",
-                "name": "Release ${{ steps.get_version.outputs.VERSION }}",
-                "body": "${{ steps.changelog.outputs.CHANGES }}",
-                "draft": false,
-                "prerelease": false
-              }' > release.json
-            
-            UPLOAD_URL=$(jq -r .upload_url release.json | sed 's/{?name,label}//')
-            
-            # Upload full firmware
-            curl -X POST \
-              -H "Authorization: token ${GITHUB_TOKEN}" \
-              -H "Content-Type: application/octet-stream" \
-              "${UPLOAD_URL}?name=filaman_full.bin" \
-              --data-binary @.pio/build/esp32dev/filaman_full.bin
-            
-            # Upload OTA firmware
-            curl -X POST \
-              -H "Authorization: token ${GITHUB_TOKEN}" \
-              -H "Content-Type: application/octet-stream" \
-              "${UPLOAD_URL}?name=filaman_ota.bin" \
-              --data-binary @.pio/build/esp32dev/filaman_ota.bin
-          else
-            echo "Creating Gitea Release..."
-            RESPONSE=$(curl -X POST \
-              -H "Authorization: token ${GITEA_TOKEN}" \
-              -H "Content-Type: application/json" \
-              -H "accept: application/json" \
-              "${GITEA_API_URL}/repos/${GITEA_REPOSITORY}/releases" \
-              -d '{
-                "tag_name": "${{ github.ref_name }}",
-                "name": "Release ${{ steps.get_version.outputs.VERSION }}",
-                "body": "${{ steps.changelog.outputs.CHANGES }}",
-                "draft": false,
-                "prerelease": false
-              }')
-            
-            RELEASE_ID=$(echo $RESPONSE | jq -r .id)
-            
-            # Upload full firmware
-            curl -X POST \
-              -H "Authorization: token ${GITEA_TOKEN}" \
-              -H "Content-Type: application/octet-stream" \
-              "${GITEA_API_URL}/repos/${GITEA_REPOSITORY}/releases/${RELEASE_ID}/assets?name=filaman_full.bin" \
-              --data-binary @.pio/build/esp32dev/filaman_full.bin
-            
-            # Upload OTA firmware
-            curl -X POST \
-              -H "Authorization: token ${GITEA_TOKEN}" \
-              -H "Content-Type: application/octet-stream" \
-              "${GITEA_API_URL}/repos/${GITEA_REPOSITORY}/releases/${RELEASE_ID}/assets?name=filaman_ota.bin" \
-              --data-binary @.pio/build/esp32dev/filaman_ota.bin
-          fi
+  gitea-release:
+    needs: get-version-and-changelog
+    if: github.server_url != 'https://github.com'
+    uses: ./.github/workflows/providers/gitea-release.yml
+    with:
+      version: ${{ needs.get-version-and-changelog.outputs.version }}
+      changelog: ${{ needs.get-version-and-changelog.outputs.changelog }}
+    secrets: inherit

CHANGELOG.md

@@ -1,5 +1,40 @@
 # Changelog
 
+## [1.2.16] - 2025-02-19
+### Added
+- update Gitea release workflow and increment version to 1.2.16
+
+
+## [1.2.15] - 2025-02-19
+### Added
+- update version to 1.2.15 and clean up Gitea release workflow
+
+
+## [1.2.14] - 2025-02-19
+### Added
+- update version to 1.2.14 and refactor release workflows for improved GitHub and Gitea support
+
+
+## [1.2.13] - 2025-02-19
+### Added
+- update version to 1.2.13 and enhance release workflow with Python setup and Gitea support
+
+
+## [1.2.12] - 2025-02-19
+### Added
+- update version to 1.2.12 and refactor release workflows for improved provider detection and execution
+
+
+## [1.2.11] - 2025-02-18
+### Added
+- update version to 1.2.11 and enhance GitHub and Gitea release workflows with input validation and improved error handling
+
+
+## [1.2.10] - 2025-02-18
+### Added
+- enhance Gitea release workflow with API connection verification and URL validation; update version to 1.2.10
+
+
 ## [1.2.9] - 2025-02-18
 ### Added
 - update version to 1.2.9 in platformio.ini

README.md

@@ -124,6 +124,24 @@ german explanatory video: [Youtube](https://youtu.be/uNDe2wh9SS8?si=b-jYx4I1w62z
     - Configure WiFi settings through the captive portal.
     - Access the web interface at `http://filaman.local` or the IP address.
 
+## GitHub Actions Configuration
+
+### Required Secrets for Gitea Releases
+
+When using Gitea as your repository host, you need to configure the following secrets in your repository:
+
+- `GITEA_API_URL`: The base URL of your Gitea instance, including protocol (e.g., `https://git.example.com`)
+- `GITEA_TOKEN`: Your Gitea access token with permissions to create releases
+- `GITEA_REPOSITORY`: The repository name in format `owner/repo` (e.g., `username/filaman`)
+
+Example values:
+```
+GITEA_API_URL=https://git.example.com
+GITEA_TOKEN=abcdef1234567890
+GITEA_REPOSITORY=username/filaman
+```
+
+Make sure to set these secrets in your repository settings under Settings > Secrets and Variables > Actions.
 
 ## Documentation
 

platformio.ini

@@ -9,7 +9,7 @@
 ; https://docs.platformio.org/page/projectconf.html
 
 [common]
-version = "1.2.9"
+version = "1.2.16"
 
 [env:esp32dev]
 platform = espressif32