release-stable.yml

# Release a stable version of icestudio
# 1. The binaries are generated for all the platforms
# 2. A new release is created
# 3. The binaries are uploaded to the Release page

name: Stable Release

# Manual activation
on: [workflow_dispatch]

jobs:
  #-- Build for Linux and windows
  build-LinWin:
    runs-on: ubuntu-22.04
    outputs:
      #-- URL to upload the binaries for
      #-- the jobs executed after build-LinWin
      upload_url: ${{ steps.create_release.outputs.upload_url }}
    steps:
      # Debug: It is for testing if the `certificate has expired`
      # Error is solved
      - name: 'Debug: No SSL verification'
        run: |
          git config --global http.sslVerify false

      # Checkout the master repo branch
      - name: Checkout!
        uses: actions/checkout@v5
        with:
          ref: master

      # jq is bash command for reading properties from a json file
      - name: Install jq package
        run: sudo apt install jq

      # Read the icestudio version from package.json (version property)
      - name: Read the package.json file
        id: icestudio_json
        run: |
          version=$(jq -r '.version' package.json)
          echo "icestudio_version=${version}" >> $GITHUB_OUTPUT
          echo $version

      # -- Debug: Print the icestudio version
      - name: Get the Icestudio version
        env:
          VERSION: '${{steps.icestudio_json.outputs.icestudio_version}}'
        run: |
          echo "VERSION: ${{ env.VERSION }}"

      # Install Node
      - name: Setup Nodejs version
        uses: actions/setup-node@v5
        with:
          node-version: '22.7.0'

      - name: Install npm dependencies
        run: |
          npm install --legacy-peer-deps

      # NSIS (makensis) builds the Windows installer. wine/wine-mono are no
      # longer needed: nw-builder sets the .exe icon via resedit (pure JS) and
      # makensis runs natively on Linux.
      - name: Install NSIS
        run: |
          sudo add-apt-repository -y universe
          sudo apt-get update
          sudo apt-get install -y nsis

      # -- Build For windows!!
      - name: Build Microsoft Windows package
        run: |
          export DISPLAY=:0.0 
          npm run buildWindows
          echo "====> DEBUG: Contents of the dist folder..."
          ls -l dist

      #-- Create the Release (draft) and Upload Window binaries
      - name: Create the Stable Release
        id: create_release
        uses: softprops/action-gh-release@v3
        env:
          VERSION: '${{steps.icestudio_json.outputs.icestudio_version}}'
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          draft: true
          prerelease: false
          tag_name: v${{ env.VERSION }}
          files: |
            dist/icestudio-${{env.VERSION}}-win64.exe
            dist/icestudio-${{env.VERSION}}-win64.zip
          body: A new release (Draft)

      #-- Build for linux
      - name: Build Linux
        run: |
          sudo apt install -y libfuse2
          export DISPLAY=:0.0 
          npm run buildLinux64
          echo "====> DEBUG: Contents of the dist folder..."
          ls -l dist

      # ---------------------------------------
      # -- Upload the Linux binaries to the release
      # ---------------------------------------
      - name: Upload Linux64 binaries
        uses: softprops/action-gh-release@v3
        env:
          VERSION: '${{steps.icestudio_json.outputs.icestudio_version}}'
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          draft: true
          prerelease: false
          tag_name: v${{ env.VERSION }}
          files: |
            dist/icestudio-${{env.VERSION}}-linux64.AppImage
            dist/icestudio-${{env.VERSION}}-linux64.zip

  # Build for macos
  build-macos:
    # -- It is only run if the build for linux/win is ok, and
    # -- the release was already created
    needs: build-LinWin

    runs-on: macos-15

    steps:
      - name: Checkout the master repo branch
        uses: actions/checkout@v5
        with:
          ref: master

      - name: Setup Nodejs version
        uses: actions/setup-node@v5
        with:
          node-version: '21.1.0'

      - name: Install npm dependencies
        run: |
          # Merge macOS-only deps (grunt-appdmg, fs-xattr) into "dependencies"
          # so npm installs them. A plain rename would create a duplicate
          # "dependencies" key (package.json already has an empty one) and npm
          # keeps the last, empty one -> grunt-appdmg was never installed.
          node -e "const fs=require('fs');const p=JSON.parse(fs.readFileSync('package.json'));p.dependencies=Object.assign({},p.dependencies,p.darwinDependencies);delete p.darwinDependencies;fs.writeFileSync('package.json',JSON.stringify(p,null,2))"
          npm install --legacy-peer-deps

      # Ad-hoc code signing (no Apple Developer certificate / secrets).
      - name: Build OSX ARM64 packages (ad-hoc signed)
        env:
          CODESIGN_ID: '-'
        run: |
          npm run buildOSXARM64
          ls dist/

        # Loading vars from icestudio package.json
      - id: icestudio_json
        run: |
          content=`tr '\n' ' ' < package.json`
          echo "packageJson=${content}" >> $GITHUB_OUTPUT

      # Read the icestudio version from package.json (version property)
      - id: icestudio_version_json
        run: |
          version=$(jq -r '.version' package.json)
          echo "icestudio_version=${version}" >> $GITHUB_OUTPUT

      # NOTE: no separate "Sign DMG" step — the build already ad-hoc signs the
      # .dmg (repairOSXarm64dmg.sh, CODESIGN_ID=-) and sets its Finder icon.

      # ---------------------------------------
      # -- Upload Mac binaries to the release
      # ---------------------------------------
      - name: 'Upload DMG/OSX64'
        uses: softprops/action-gh-release@v3
        env:
          # VERSION: "${{fromJson(steps.icestudio_json.outputs.packageJson).version}}"
          VERSION: '${{steps.icestudio_version_json.outputs.icestudio_version}}'
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          draft: true
          prerelease: false
          tag_name: v${{ env.VERSION }}
          files: |
            dist/icestudio-${{env.VERSION}}-osxarm64.dmg

  # Build for ARM 64
  build-arm:
    # -- It is only run if the build for linux/win is ok, and
    # -- the release already created
    needs: build-LinWin

    # The type of runner that the job will run on
    runs-on: ubuntu-24.04

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
      # Checkout the develop branch
      - uses: actions/checkout@v5
        with:
          ref: master

      - name: Setup Nodejs version
        uses: actions/setup-node@v5
        with:
          node-version: '23.3.0'

      - name: Install npm dependencies
        run: npm install --legacy-peer-deps

      - name: Build ARM
        env:
          NW_FLAVOR: normal
        run: |
          sudo apt install -y libfuse2
          export DISPLAY=:0.0
          npm run buildAarch64
          echo "====> DEBUG: Contents of the dist folder..."
          ls -l dist

      # jq is bash command for reading properties from a json file
      - name: Install jq package
        run: sudo apt install jq

      # Read the icestudio version from package.json (version property)
      - id: icestudio_json
        run: |
          version=$(jq -r '.version' package.json)
          echo "icestudio_version=${version}" >> $GITHUB_OUTPUT

      # -- Debug: Print the icestudio version
      # -- It is read from the package.json
      - name: Get the Icestudio version
        env:
          VERSION: '${{steps.icestudio_json.outputs.icestudio_version}}'
        run: |
          echo "VERSION: ${{ env.VERSION }}"

      # ---------------------------------------
      # -- Upload ARM binaries to the release
      # ---------------------------------------
      - name: 'Upload ZIP/Aarch64'
        uses: softprops/action-gh-release@v3
        env:
          VERSION: '${{steps.icestudio_json.outputs.icestudio_version}}'
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          draft: true
          prerelease: false
          tag_name: v${{ env.VERSION }}
          files: |
            dist/icestudio-${{env.VERSION}}-aarch64.zip