feat: Added workflow to automatically update files, create PR and build installer

jakub-kocka · jakub-kocka · commit be5b2c574dec · 2024-03-08T20:20:14.000+01:00
diff --git a/.github/workflows/build-espressif-ide-installer.yml b/.github/workflows/build-espressif-ide-installer.yml
@@ -1,33 +1,26 @@
 name: build-espressif-ide-installer
 
 on:
-  workflow_dispatch:
+  workflow_call:
     inputs:
-      espressif_ide_version:
-        description: 'Espressif IDE version'
-        required: true
-        default: '2.9.1'
       esp_idf_version:
-        description: 'ESP-IDF version'
         required: true
-        default: '5.0.1'
-      python_version:
-        description: 'Python version'
+        type: string
+      espressif_ide_version:
         required: true
-        default: '3.11'
+        type: string
 
 jobs:
   build-espressif-ide-installer:
     name: Build Installer
     runs-on: windows-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Inputs Logged
         run: |
           echo "Received Espressif IDE Version: ${{ github.event.inputs.espressif_ide_version }}"
           echo "Received ESP-IDF Version: ${{ github.event.inputs.esp_idf_version }}"
-          echo "Received Python Version: ${{ github.event.inputs.python_version }}"
       - name: Map local long path to new drive
         id: map_path
         shell: pwsh
@@ -36,9 +29,9 @@ jobs:
         shell: pwsh
         run: choco install innosetup
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
-          python-version: '${{ github.event.inputs.python_version }}'
+          python-version: '3.11'
       - name: Install Inno Setup Download plugin
         shell: pwsh
         run: Invoke-WebRequest -Uri https://github.com/espressif/inno-download-plugin/releases/download/v1.5.1/idpsetup-1.5.1.exe -OutFile idpsetup.exe; .\idpsetup.exe /SILENT; Sleep 5
@@ -48,15 +41,15 @@ jobs:
           CERTIFICATE_PASSWORD: ${{ secrets.CERTIFICATE_PASSWORD }}
         shell: pwsh
         working-directory: "P:"
-        run: .\Build-Installer.ps1 -InstallerType espressif-ide -OfflineBranch "v${{ github.event.inputs.esp_idf_version }}" -EspressifIdeVersion "${{ github.event.inputs.espressif_ide_version }}"
+        run: .\Build-Installer.ps1 -InstallerType espressif-ide -OfflineBranch "v${{ inputs.esp_idf_version }}" -EspressifIdeVersion "${{ inputs.espressif_ide_version }}"
       - name: Create Release
         id: create_release
         uses: actions/create-release@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          tag_name: espressif-ide-${{ github.event.inputs.espressif_ide_version }}-esp-idf-${{ github.event.inputs.esp_idf_version }}
-          release_name: Release of Espressif IDE ${{ github.event.inputs.espressif_ide_version }} with ESP-IDF ${{ github.event.inputs.esp_idf_version }}
+          tag_name: espressif-ide-${{ inputs.espressif_ide_version }}-esp-idf-${{ inputs.esp_idf_version }}
+          release_name: Release of Espressif IDE ${{ inputs.espressif_ide_version }} with ESP-IDF ${{ inputs.esp_idf_version }}
           draft: true
           prerelease: true
       - name: Upload Release Asset To Github
@@ -66,8 +59,8 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           upload_url: ${{ steps.create_release.outputs.upload_url }}
-          asset_path: ./build/espressif-ide-setup-espressif-ide-with-esp-idf-${{ github.event.inputs.esp_idf_version }}-signed.exe
-          asset_name: espressif-ide-setup-${{ github.event.inputs.espressif_ide_version }}-with-esp-idf-${{ github.event.inputs.esp_idf_version }}.exe
+          asset_path: ./build/espressif-ide-setup-espressif-ide-with-esp-idf-${{ inputs.esp_idf_version }}-signed.exe
+          asset_name: espressif-ide-setup-${{ inputs.espressif_ide_version }}-with-esp-idf-${{ inputs.esp_idf_version }}.exe
           asset_content_type: application/octet-stream
       - name: Upload Release Asset To dl.espressif.com
         id: upload-release-asset-espressif
@@ -76,4 +69,4 @@ jobs:
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           AWS_DEFAULT_REGION: ${{ secrets.AWS_DEFAULT_REGION }}
         shell: pwsh
-        run: aws s3 cp --acl=public-read --no-progress ./build/espressif-ide-setup-espressif-ide-with-esp-idf-${{ github.event.inputs.esp_idf_version }}-signed.exe s3://${{ secrets.DL_BUCKET }}/dl/idf-installer/espressif-ide-setup-${{ github.event.inputs.espressif_ide_version }}-with-esp-idf-${{ github.event.inputs.esp_idf_version }}.exe
+        run: aws s3 cp --acl=public-read --no-progress ./build/espressif-ide-setup-espressif-ide-with-esp-idf-${{ inputs.esp_idf_version }}-signed.exe s3://${{ secrets.DL_BUCKET }}/dl/idf-installer/espressif-ide-setup-${{ inputs.espressif_ide_version }}-with-esp-idf-${{ inputs.esp_idf_version }}.exe
diff --git a/.github/workflows/build-installer.yml b/.github/workflows/build-installer.yml
@@ -0,0 +1,115 @@
+name: build-installer-any
+
+on:
+    workflow_dispatch:
+        inputs:
+            installer_type:
+                type: choice
+                description: 'Installer Type'
+                required: true
+                options:
+                    - offline
+                    - espressif-ide
+                    - online
+            esp_idf_version:
+                description: 'ESP-IDF version (e.g. 5.2 or 5.2.1)'
+                required: false
+                default: '5.2.1'
+            espressif_ide_version:
+                description: 'Espressif IDE version (e.g. 2.0.0)'
+                required: false
+                default: ''
+            online_installer_version:
+                description: 'Online Installer version (e.g. 2.0)'
+                required: false
+                default: ''
+    pull_request:   # TODO Remove this once the workflow is tested
+
+env:
+    INSTALLER_TYPE: "offline" #${{ inputs.installer_type }}
+    ESP_IDF_VERSION: "4.4.7"  #${{ inputs.esp_idf_version }}
+    ESPRESSIF_IDE_VERSION: #${{ inputs.espressif_ide_version }}
+    ONLINE_INSTALLER_VERSION: "" #${{ inputs.online_installer_version }}
+
+jobs:
+    # build-installer-online:
+    #     #needs: update-docs-files
+    #     name: Build Online Installer
+    #     #if: ${{ env.INSTALLER_TYPE }} == 'online'
+    #     uses: espressif/idf-installer/.github/workflows/build-online-installer.yml@feat/automatic_installer_release # TODO
+    #     with:
+    #         online_installer_version: ${{ inputs.online_installer_version }}
+    #     secrets: inherit
+
+    build-installer-offline:
+        #needs: update-docs-files
+        name: Build Offline Installer
+        # if: ${{ env.INSTALLER_TYPE }} == 'offline'
+        uses: espressif/idf-installer/.github/workflows/build-offline-installer.yml@feat/automatic_installer_release # TODO
+        with:
+            esp_idf_version: "4.4.7"
+        secrets: inherit
+
+    # build-installer-ide:
+    #     needs: update-docs-files
+    #     name: Build IDE Installer
+    #     if: ${{ env.INSTALLER_TYPE }} == 'espressif-ide'
+    #     uses: espressif/idf-installer/.github/workflows/build-espressif-ide-installer.yml@feat/automatic_installer_release # TODO
+    #     with:
+    #         esp_idf_version: ${{ env.ESP_IDF_VERSION }}
+    #         espressif_ide_version: ${{ env.ESPRESSIF_IDE_VERSION }}
+    #     secrets: inherit
+
+    update-docs-files:
+        needs: build-installer-offline
+        name: Build ${{ inputs.installer_type}} Installer 
+        runs-on: windows-latest
+        strategy:
+            fail-fast: false
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+            
+            - name: Set up Python
+              uses: actions/setup-python@v5
+              with:
+                python-version: '3.11'
+
+            - name: Download artifacts
+              uses: actions/download-artifact@v4
+              with:
+                name: installer-size
+                path: ./
+            
+            - name: Get size of online installer and Update docs files
+              run: |
+                echo "Instaler size from variable is $(Get-Content variables.txt)"
+
+                $size_bytes = [int]$(Get-Content variables.txt)
+                # Check if the content is larger than 100000
+                if ($size_bytes -gt 9999999) {
+                    $result = [math]::Round($size_bytes / 1000000000,2)
+                    $installer_size = "$result GB"
+                    echo "INSTALLER_SIZE: $installer_size"
+                } else {
+                    $result = [math]::Round($size_bytes / 1000000,2)
+                    $installer_size = "$result MB"
+                    echo "INSTALLER_SIZE: $installer_size"
+                }
+
+                python scripts/docs_update_release.py $installer_size
+
+            - name: Delete variables.txt
+              run: |
+                Remove-Item -Path variables.txt -Force
+
+            - name: Create Pull Request
+              uses: peter-evans/create-pull-request@v6
+              with:
+                token: ${{ secrets.GITHUB_TOKEN }}
+                commit-message: 'Release ${{ env.INSTALLER_TYPE }} installer ${{env.ESPRESSIF_IDE_VERSION}}${{env.ONLINE_INSTALLER_VERSION}} with ESP-IDF v${{ env.ESP_IDF_VERSION }}'
+                title: 'Release ${{ env.INSTALLER_TYPE }} installer ${{env.ESPRESSIF_IDE_VERSION}}${{env.ONLINE_INSTALLER_VERSION}} with ESP-IDF v${{ env.ESP_IDF_VERSION }}'
+                body: '- Updated docs files'
+                branch: 'release-${{ env.INSTALLER_TYPE }}-installer'
+                delete-branch: true
+                base: 'main'
diff --git a/.github/workflows/build-offline-installer.yml b/.github/workflows/build-offline-installer.yml
@@ -1,54 +1,62 @@
 name: build-offline-installer
 
 on:
-  workflow_dispatch:
-  
-  push:
-    tags:
-      - offline-*
+  workflow_call:
+    inputs:
+      esp_idf_version:
+        required: true
+        type: string
+
+env:
+  IDF_BRANCH: ${{ inputs.esp_idf_version }}
+  VERSION: 'offline-${{ inputs.esp_idf_version }}'
 
 jobs:
   build-offline-installer:
     name: Build Installer
     runs-on: windows-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
-      - name: Get the version
-        id: get_version
-        run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
-        shell: bash
-      - name: Get the installer type
-        id: get_installer_type
-        run: echo ::set-output name=INSTALLER_TYPE::${${{ steps.get_version.outputs.VERSION }}//-*}
-        shell: bash
-      - name: Get version for branch
-        id: get_branch_version
-        run: echo ::set-output name=BRANCH_VERSION::${GITHUB_REF/refs\/tags\/offline-/}
-        shell: bash
+        uses: actions/checkout@v4
+
       - name: Set up Python 3.11
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.11'
+
       - name: Install Inno Setup Download plugin
         shell: pwsh
         run: Invoke-WebRequest -Uri https://github.com/espressif/inno-download-plugin/releases/download/v1.5.1/idpsetup-1.5.1.exe -OutFile idpsetup.exe; .\idpsetup.exe /SILENT; Sleep 5
+
       - name: Build Installer
         env:
           CERTIFICATE: ${{ secrets.CERTIFICATE }}
           CERTIFICATE_PASSWORD: ${{ secrets.CERTIFICATE_PASSWORD }}
         shell: pwsh
-        run: .\Build-Installer.ps1 -InstallerType offline -OfflineBranch v${{ steps.get_branch_version.outputs.BRANCH_VERSION }}
+        run: .\Build-Installer.ps1 -InstallerType offline -OfflineBranch v${{ env.IDF_BRANCH }}
+
       - name: Create Release
         id: create_release
         uses: actions/create-release@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          tag_name: ${{ github.ref }}
-          release_name: Release ${{ github.ref }}
+          tag_name: ${{ env.VERSION }}-esp-idf-v${{ env.IDF_BRANCH }}
+          release_name: Release ${{ env.VERSION }}
           draft: false
           prerelease: false
+
+      - name: Get installer size and store it to file
+        run: |
+          echo $(Get-ItemProperty -Path .\build\esp-idf-tools-setup-offline-signed.exe | Select-Object -ExpandProperty Length) > variables.txt
+          echo "Instaler size from variable is $(Get-Content variables.txt)"
+        
+      - name: Upload artifacts of installer size
+        uses: actions/upload-artifact@v4
+        with:
+          name: installer-size
+          path: ./variables.txt
+
       - name: Upload Release Asset To Github
         id: upload-release-asset
         uses: actions/upload-release-asset@v1
@@ -57,13 +65,14 @@ jobs:
         with:
           upload_url: ${{ steps.create_release.outputs.upload_url }}
           asset_path: ./build/esp-idf-tools-setup-offline-signed.exe
-          asset_name: esp-idf-tools-setup-${{ steps.get_version.outputs.VERSION }}.exe
+          asset_name: esp-idf-tools-setup-${{ env.VERSION }}.exe
           asset_content_type: application/octet-stream
+
       - name: Upload Release Asset To dl.espressif.com
         id: upload-release-asset-espressif
         env:
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           AWS_DEFAULT_REGION: ${{ secrets.AWS_DEFAULT_REGION }}
         shell: pwsh
-        run: aws s3 cp --acl=public-read --no-progress ./build/esp-idf-tools-setup-offline-signed.exe s3://${{ secrets.DL_BUCKET }}/dl/idf-installer/esp-idf-tools-setup-${{ steps.get_version.outputs.VERSION }}.exe
+        run: aws s3 cp --acl=public-read --no-progress ./build/esp-idf-tools-setup-offline-signed.exe s3://${{ secrets.DL_BUCKET }}/dl/idf-installer/esp-idf-tools-setup-${{ env.VERSION }}.exe
diff --git a/.github/workflows/build-online-installer.yml b/.github/workflows/build-online-installer.yml
@@ -1,44 +1,56 @@
 name: build-online-installer
 
 on:
-  push:
-    tags:
-      - online-*
+  workflow_call:
+    inputs:
+      online_installer_version:
+        required: true
+        type: string
+
+env:
+  VERSION: 'online-${{ inputs.online_installer_version }}'
 
 jobs:
   build-online-installer:
     name: Build Installer
     runs-on: windows-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
-      - name: Get the version
-        id: get_version
-        run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
-        shell: bash
-      - name: Get the installer type
-        id: get_installer_type
-        run: echo ::set-output name=INSTALLER_TYPE::${${{ steps.get_version.outputs.VERSION }}//-*}
-        shell: bash
+        uses: actions/checkout@v4
+
       - name: Install Inno Setup Download plugin
         shell: pwsh
         run: ./src/PowerShell/Install-IdpSetup.ps1
+
       - name: Build Installer
         env:
           CERTIFICATE: ${{ secrets.CERTIFICATE }}
           CERTIFICATE_PASSWORD: ${{ secrets.CERTIFICATE_PASSWORD }}
         shell: pwsh
         run: .\Build-Installer.ps1 -InstallerType online
+
       - name: Create Release
         id: create_release
         uses: actions/create-release@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          tag_name: ${{ github.ref }}
-          release_name: Release ${{ github.ref }}
+          tag_name: ${{ env.VERSION }}
+          release_name: Release ${{ env.VERSION }}
           draft: false
           prerelease: false
+
+      - name: Get installer size and store it to file
+        run: |
+          echo $(Get-ItemProperty -Path .\build\esp-idf-tools-setup-online-signed.exe | Select-Object -ExpandProperty Length) > variables.txt
+          echo "Instaler size from variable is $(Get-Content variables.txt)"
+      
+      - name: Upload artifacts of installer size
+        uses: actions/upload-artifact@v4
+        with:
+          name: installer-size
+          path: ./variables.txt
+
       - name: Upload Release Asset To Github
         id: upload-release-asset
         uses: actions/upload-release-asset@v1
@@ -47,7 +59,7 @@ jobs:
         with:
           upload_url: ${{ steps.create_release.outputs.upload_url }}
           asset_path: ./build/esp-idf-tools-setup-online-signed.exe
-          asset_name: esp-idf-tools-setup-${{ steps.get_version.outputs.VERSION }}.exe
+          asset_name: esp-idf-tools-setup-${{ env.VERSION }}.exe
           asset_content_type: application/octet-stream
       - name: Upload Release Asset To dl.espressif.com
         id: upload-release-asset-espressif
@@ -56,4 +68,4 @@ jobs:
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           AWS_DEFAULT_REGION: ${{ secrets.AWS_DEFAULT_REGION }}
         shell: pwsh
-        run: aws s3 cp --acl=public-read --no-progress ./build/esp-idf-tools-setup-online-signed.exe s3://${{ secrets.DL_BUCKET }}/dl/idf-installer/esp-idf-tools-setup-${{ steps.get_version.outputs.VERSION }}.exe
+        run: aws s3 cp --acl=public-read --no-progress ./build/esp-idf-tools-setup-online-signed.exe s3://${{ secrets.DL_BUCKET }}/dl/idf-installer/esp-idf-tools-setup-${{ env.VERSION }}.exe
diff --git a/scripts/docs_update_release.py b/scripts/docs_update_release.py
