build-release.yml

name: 📣 Build release of QOwnNotes

on:
  workflow_dispatch:
  push:
    branches:
      - release
    tags-ignore:
      - "*"

defaults:
  run:
    working-directory: src

#--------------------------------------------------------------------------------
# Define application name & version
#--------------------------------------------------------------------------------

env:
  EXECUTABLE: "QOwnNotes"
  APPLICATION: "QOwnNotes"
  UNIXNAME: "QOwnNotes"
  QMAKE_PROJECT: "QOwnNotes.pro"
  PUBLISHER: "Patrizio Bekerle"
  REPO_DIR: "/home/runner/work/QOwnNotes"
  QT_MODULES: ""
  QT6_MODULES: "qtwebsockets"
  QMAKE: qmake
  CORES: 16

jobs:
  create_release:
    name: "🗃️️ Prepare release"
    permissions:
      contents: write # for actions/create-release to create a release
    runs-on: ubuntu-latest
    outputs:
      upload_url: ${{ steps.create_release.outputs.upload_url }}
      release_id: ${{ steps.create_release.outputs.id }}
    steps:
      - uses: actions/checkout@v6
      - name: Set Env
        run: |
          export VERSION=$(cat version.h | sed 's/[^0-9,.]//g')
          #export TAG=v${VERSION}.${GITHUB_RUN_ID}.${GITHUB_RUN_NUMBER}
          export TAG=v${VERSION}
          export RELEASE_TEXT=$(grep -Pzo "## ${VERSION}\n(\n|.)+?\n##" ../CHANGELOG.md | sed '$ d')
          echo "VERSION=${VERSION}" >> $GITHUB_ENV
          echo "TAG=${TAG}" >> $GITHUB_ENV
          # add multiline release text
          echo "RELEASE_TEXT<<EOF" >> $GITHUB_ENV
          echo "${RELEASE_TEXT}" >> $GITHUB_ENV
          echo "EOF" >> $GITHUB_ENV
      - name: Printenv
        run: |
          echo "VERSION=${VERSION}"
          echo "TAG=${TAG}"
          echo "RELEASE_TEXT=${RELEASE_TEXT}"
          printenv
      - name: Create release
        id: create_release
        uses: softprops/action-gh-release@v2
        with:
          tag_name: ${{ env.TAG }}
          name: Release v${{ env.VERSION }}
          body: ${{ env.RELEASE_TEXT }}
          # we want other build systems to immediately use this release after we uploaded the source archive
          draft: false
          prerelease: false
          generate_release_notes: false

  #--------------------------------------------------------------------------------
  # Workflow jobs (GNU/Linux, macOS & Windows)
  #--------------------------------------------------------------------------------

  #
  # AppImage Qt6 build
  #
  build-appimage:
    needs: create_release
    runs-on: ubuntu-22.04
    env:
      # aqt Qt versions: https://ddalcino.github.io/aqt-list-server/
      # Qt 6.10.0, 6.9.1, 6.8.3, 6.7.3, 6.6.3: ERROR: Could not find dependency: libmimerapi.so
      QT_VERSION: 6.10.2
      # qtwaylandcompositor provides the Wayland platform plugins (libqwayland.so)
      QT_MODULES: "qtwebsockets qtwaylandcompositor"
      BUILD_DIR: build
    name: "🐧 AppImage Qt 6.10.2"
    steps:
      - name: "🧰 Checkout"
        uses: actions/checkout@v6
        with:
          submodules: recursive

      - name: "⚙️ Install Qt"
        uses: jurplel/install-qt-action@v4
        with:
          version: ${{env.QT_VERSION}}
          modules: ${{env.QT_MODULES}}
          cache: true

      - name: "⚙️ Install dependencies"
        run: |
          sudo apt-get update
          sudo apt install libfuse2 desktop-file-utils libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-render-util0 libxcb-xinerama0 libxcb-composite0 libxcb-cursor0 libxcb-damage0 libxcb-dpms0 libxcb-dri2-0 libxcb-dri3-0 libxcb-ewmh2 libxcb-glx0 libxcb-present0 libxcb-randr0 libxcb-record0 libxcb-render0 libxcb-res0 libxcb-screensaver0 libxcb-shape0 libxcb-shm0 libxcb-sync1 libxcb-util1 libxkbcommon-x11-0
      - name: "🚧 Compile application"
        run: |
          echo "#define RELEASE \"AppImage\"" > release.h
          ${{env.QMAKE}} ${{env.QMAKE_PROJECT}} CONFIG+=release PREFIX=/usr
          lrelease QOwnNotes.pro
          make -j${{env.CORES}}
      - name: "⚙️ Install linuxdeploy"
        run: |
          export LINUXDEPLOY_VERSION=1-alpha-20240109-1
          wget https://github.com/linuxdeploy/linuxdeploy/releases/download/${LINUXDEPLOY_VERSION}/linuxdeploy-x86_64.AppImage
          wget https://github.com/linuxdeploy/linuxdeploy-plugin-qt/releases/download/${LINUXDEPLOY_VERSION}/linuxdeploy-plugin-qt-x86_64.AppImage
          chmod +x linuxdeploy-x86_64.AppImage
          chmod +x linuxdeploy-plugin-qt-x86_64.AppImage
      - name: "📦 Create AppImage"
        run: |
          export QMAKE=${{env.REPO_DIR}}/Qt/${{env.QT_VERSION}}/gcc_64/bin/${{env.QMAKE}}
          export PATH=${{env.REPO_DIR}}/Qt/${{env.QT_VERSION}}/gcc_64/libexec:$PATH
          QT_DIR=${{env.REPO_DIR}}/Qt/${{env.QT_VERSION}}/gcc_64
          # Qt 6.10+ unified the Wayland platform plugins into a single libqwayland.so
          # (older versions shipped libqwayland-egl.so and libqwayland-generic.so separately)
          export EXTRA_PLATFORM_PLUGINS="libqwayland.so"

          copy_qt_plugin_dir() {
            local plugin_dir="$1"
            if [ -d "${QT_DIR}/plugins/${plugin_dir}" ]; then
              mkdir -p "${{env.BUILD_DIR}}/usr/plugins/${plugin_dir}"
              cp -a "${QT_DIR}/plugins/${plugin_dir}/." "${{env.BUILD_DIR}}/usr/plugins/${plugin_dir}/"
            fi
          }

          assert_wayland_platform_plugins() {
            test -f "${{env.BUILD_DIR}}/usr/plugins/platforms/libqwayland.so"
          }

          # Set the extra Qt modules to include (Quick is needed by the Qt6 build's script engine)
          export EXTRA_QT_MODULES="Qml;QmlWorkerScript;QmlModels;Quick"

          # Tell linuxdeploy-plugin-qt where to find QML files so it scans and
          # bundles the QML import modules (QtQml, QtQuick, etc.) that the
          # QQmlEngine needs at runtime for user scripts.
          # We point it at our example scripts which all do "import QtQml 2.0".
          export QML_SOURCES_PATHS="../docs/scripting/examples"
          export QML_MODULES_PATHS="${QT_DIR}/qml"

          cp ../icons/icon.png QOwnNotes.png

          # Remove SQL driver plugins that require external client libraries
          # (Oracle, MySQL, PostgreSQL, etc.) which are not available in the
          # build environment. QOwnNotes only needs the SQLite driver.
          find "${QT_DIR}/plugins/sqldrivers" -name '*.so' ! -name '*sqlite*' -delete || true

          # Copy additional resources
          mkdir -p ${{env.BUILD_DIR}}/usr/plugins/iconengines && cp -r ${QT_DIR}/plugins/iconengines/libqsvgicon.so ${{env.BUILD_DIR}}/usr/plugins/iconengines
          mkdir -p ${{env.BUILD_DIR}}/usr/languages && cp -r languages/*.qm ${{env.BUILD_DIR}}/usr/languages

          ./linuxdeploy-x86_64.AppImage \
            --appdir ${{env.BUILD_DIR}} \
            -e ${{env.UNIXNAME}} \
            -i ${{env.UNIXNAME}}.png \
            -d PBE.QOwnNotes.desktop \
            --plugin qt

          # linuxdeploy-plugin-qt only deploys xcb by default, so copy the Wayland
          # platform and helper plugins explicitly for Wayland-only systems.
          copy_qt_plugin_dir platforms
          copy_qt_plugin_dir wayland-decoration-client
          copy_qt_plugin_dir wayland-graphics-integration-client
          copy_qt_plugin_dir wayland-shell-integration
          assert_wayland_platform_plugins

          # Ensure QML import directories are present in the AppImage.
          # linuxdeploy-plugin-qt should deploy them via QML_SOURCES_PATHS,
          # but we copy them explicitly as a safety net so "import QtQml 2.0"
          # always resolves from within the bundle instead of the host system.
          QML_DEST=${{env.BUILD_DIR}}/usr/qml
          for mod in QtQml QtQuick QtQml/WorkerScript; do
            if [ -d "${QT_DIR}/qml/${mod}" ] && [ ! -d "${QML_DEST}/${mod}" ]; then
              mkdir -p "${QML_DEST}/${mod}"
              cp -a "${QT_DIR}/qml/${mod}/." "${QML_DEST}/${mod}/"
            fi
          done

          # Write qt.conf AFTER linuxdeploy to ensure it is not overwritten.
          # This forces Qt to load plugins and QML imports from the AppImage bundle
          # instead of from the host system (e.g. Nix store paths).
          cat > ${{env.BUILD_DIR}}/usr/bin/qt.conf <<'QTCONF'
          [Paths]
          Prefix = ..
          Plugins = plugins
          Qml2Imports = qml
          QmlImports = qml
          QTCONF

          # Strip leading whitespace that YAML indentation adds to the heredoc
          sed -i 's/^[[:space:]]*//' ${{env.BUILD_DIR}}/usr/bin/qt.conf

          # Bundle OpenSSL libraries explicitly so QtNetwork keeps working in the AppImage
          # even when the target system exposes a different OpenSSL runtime.
          mkdir -p ${{env.BUILD_DIR}}/usr/lib
          cp -L /usr/lib/x86_64-linux-gnu/libssl.so.3 ${{env.BUILD_DIR}}/usr/lib/
          cp -L /usr/lib/x86_64-linux-gnu/libcrypto.so.3 ${{env.BUILD_DIR}}/usr/lib/

          find ${{env.BUILD_DIR}}

          ./linuxdeploy-x86_64.AppImage --appdir ${{env.BUILD_DIR}} --output appimage

          # Cleanup
          rm linuxdeploy-x86_64.AppImage linuxdeploy-plugin-qt-x86_64.AppImage
          # Keep the same asset name as the old Qt5 AppImage so the update process can find it
          mv *.AppImage ${{env.EXECUTABLE}}-x86_64.AppImage ||:
          sha256sum ${{env.EXECUTABLE}}-x86_64.AppImage > ${{env.EXECUTABLE}}-x86_64.AppImage.sha256sum
          ls -hal *.AppImage

      - name: "📤 Release AppImage for Linux"
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ needs.create_release.outputs.upload_url }}
          asset_path: ./src/QOwnNotes-x86_64.AppImage
          asset_name: QOwnNotes-x86_64.AppImage
          asset_content_type: application/vnd.appimage
      - name: "📤 Release AppImage sha256sum"
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ needs.create_release.outputs.upload_url }}
          asset_path: ./src/QOwnNotes-x86_64.AppImage.sha256sum
          asset_name: QOwnNotes-x86_64.AppImage.sha256sum
          asset_content_type: text/plain

  #
  # Snap build
  #
  build-snap:
    needs: create_release
    runs-on: ubuntu-latest
    env:
      QT_VERSION: 5.15.2
    name: "🐧 Snap Qt 5.15.2"
    steps:
      - name: "🧰 Checkout"
        uses: actions/checkout@v6
        with:
          submodules: recursive

      - name: "⚙️ Set Env"
        shell: bash
        run: |
          export VERSION=$(cat version.h | sed 's/[^0-9,.]//g')
          echo "VERSION=${VERSION}" >> $GITHUB_ENV

      - name: "⚙️ Install Qt"
        uses: jurplel/install-qt-action@v4
        with:
          version: ${{env.QT_VERSION}}
          modules: ${{env.QT_MODULES}}
          cache: true

      - name: "⚙️ Printenv"
        shell: bash
        run: |
          echo "VERSION=${VERSION}"
          printenv

      - name: "🚧 Compile application"
        uses: snapcore/action-build@v1
        id: snapcraft

      - name: "📤 Release Snap for Linux"
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ needs.create_release.outputs.upload_url }}
          asset_path: ./qownnotes_${{ env.VERSION }}_amd64.snap
          asset_name: QOwnNotes-amd64.snap
          asset_content_type: application/octet-stream

      - name: "📤 Deploy Snap"
        continue-on-error: true
        timeout-minutes: 10
        shell: bash
        env:
          # `snapcraft export-login --snaps=qownnotes --acls package_access,package_push,package_update,package_release -`, token valid for one year
          SNAPCRAFT_STORE_CREDENTIALS: ${{ secrets.SNAP_TOKEN_GH }}
        run: |
          # Install snapcraft if not available
          sudo snap install snapcraft --classic

          # Upload and release the snap in one command
          # The --release flag publishes to stable channel immediately
          snapcraft upload /home/runner/work/QOwnNotes/QOwnNotes/qownnotes_${{ env.VERSION }}_amd64.snap --release stable || {
            echo "Snap upload timed out or failed, but the snap was likely uploaded successfully."
            echo "Check the Snap Store dashboard for processing status."
            exit 0
          }

  #      - name: '📤 Upload artifact: Snap'
  #        uses: actions/upload-artifact@v4
  #        with:
  #          name: qownnotes_${{ env.VERSION }}_amd64.snap
  #          path: /home/runner/work/QOwnNotes/QOwnNotes/qownnotes_${{ env.VERSION }}_amd64.snap

  #
  # Windows build
  #
  build-windows:
    name: "🧊 Windows Qt6"
    needs: create_release
    # https://github.com/pbek/QOwnNotes/issues/2558 error on windows-2022!
    runs-on: windows-2025
    env:
      QT_VERSION: 6.10.1
    steps:
      - name: "🧰 Checkout"
        uses: actions/checkout@v6
        with:
          submodules: recursive

      - name: "⚙️ Install Qt"
        uses: jurplel/install-qt-action@v4
        with:
          version: ${{env.QT_VERSION}}
          # https://download.qt.io/online/qtsdkrepository/windows_x86/desktop/qt6_650/qt.qt6.650.win64_mingw/
          # https://aqtinstall.readthedocs.io/en/latest/getting_started.html
          # https://ddalcino.github.io/aqt-list-server/
          modules: ${{env.QT6_MODULES}}
          cache: true

      - name: "⚙️ Set Env"
        shell: bash
        run: |
          export VERSION=$(cat version.h | sed 's/[^0-9,.]//g')
          echo "VERSION=${VERSION}" >> $GITHUB_ENV

      - name: Make sure MSVC is found
        uses: ilammy/msvc-dev-cmd@v1

      - name: "⚙️ Printenv"
        shell: bash
        run: |
          echo "VERSION=${VERSION}"
          printenv

      - name: "🚧 Compile application"
        run: '& ..\build-systems\github\windows\build-zip-qt6.ps1'

      #      - name: '📤 Upload artifact: Windows'
      #        uses: actions/upload-artifact@v4
      #        with:
      #          name: QOwnNotes.zip
      #          path: QOwnNotes.zip
      #      - name: '📤 Upload artifact: Windows sha256sum'
      #        uses: actions/upload-artifact@v4
      #        with:
      #          name: QOwnNotes.zip.sha256
      #          path: QOwnNotes.zip.sha256

      - name: "📤 Release ZIP"
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ needs.create_release.outputs.upload_url }}
          asset_path: QOwnNotes.zip
          asset_name: QOwnNotes.zip
          asset_content_type: application/zip
      - name: "📤 Release sha256 sum"
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ needs.create_release.outputs.upload_url }}
          asset_path: QOwnNotes.zip.sha256
          asset_name: QOwnNotes.zip.sha256
          asset_content_type: text/plain
      - name: "📤 Release clickable sha256 sum"
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ needs.create_release.outputs.upload_url }}
          asset_path: QOwnNotes.zip.sha256sum
          asset_name: QOwnNotes.zip.sha256sum
          asset_content_type: text/plain

  #
  # macOS Qt6 build
  #
  build-macos:
    name: "🍎 macOS Qt6"
    needs: create_release
    runs-on: macos-15
    env:
      # Qt 6.5 doesn't support macOS 10 anymore!
      QT_VERSION: 6.10.1
    steps:
      - name: "🧰 Checkout"
        uses: actions/checkout@v6
        with:
          submodules: recursive

      # https://download.qt.io/online/qtsdkrepository/mac_x64/desktop/
      - name: "⚙️ Install Qt"
        uses: jurplel/install-qt-action@v4
        with:
          version: ${{env.QT_VERSION}}
          modules: ${{env.QT6_MODULES}}
          cache: true

      - name: "⚙️ Set Env"
        shell: bash
        run: |
          export VERSION=$(cat version.h | sed 's/[^0-9,.]//g')
          echo "VERSION=${VERSION}" >> $GITHUB_ENV

      - name: "⚙️ Printenv"
        shell: bash
        run: |
          echo "VERSION=${VERSION}"
          printenv

      - name: "🚧 Compile application"
        run: |
          echo "#define RELEASE \"GitHub Actions\"" > release.h
          lrelease QOwnNotes.pro
          #ls ${Qt5_Dir}/bin
          ${{env.QMAKE}} QOwnNotes.pro CONFIG+=release QMAKE_APPLE_DEVICE_ARCHS="x86_64 arm64"
          make -j ${{env.CORES}}
          ../build-systems/github/macos/create-dmg-qt6.sh

      - name: "📤 Release DMG"
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ needs.create_release.outputs.upload_url }}
          asset_path: src/QOwnNotes.dmg
          asset_name: QOwnNotes.dmg
          asset_content_type: application/x-apple-diskimage

  #
  # macOS Qt5 build
  #
  build-macos-qt5:
    name: "🍎 macOS Qt5"
    needs: create_release
    runs-on: macos-15
    env:
      QT_VERSION: 5.15.2
    steps:
      - name: "🧰 Checkout"
        uses: actions/checkout@v6
        with:
          submodules: recursive

      # https://download.qt.io/online/qtsdkrepository/mac_x64/desktop/
      - name: "⚙️ Install Qt"
        uses: jurplel/install-qt-action@v4
        with:
          version: ${{env.QT_VERSION}}
          modules: ${{env.QT_MODULES}}
          aqtversion: "==2.0.0"
          cache: true

      - name: "⚙️ Set Env"
        shell: bash
        run: |
          export VERSION=$(cat version.h | sed 's/[^0-9,.]//g')
          echo "VERSION=${VERSION}" >> $GITHUB_ENV

      - name: "⚙️ Printenv"
        shell: bash
        run: |
          echo "VERSION=${VERSION}"
          printenv

      # qmake workaround: https://bugreports.qt.io/browse/QTBUG-117225?focusedId=754625&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-754625
      # See https://github.com/pbek/QOwnNotes/issues/3018
      - name: "🚧 Compile application"
        run: |
          echo "#define RELEASE \"GitHub Actions\"" > release.h
          lrelease QOwnNotes.pro
          #ls ${Qt5_Dir}/bin
          ${{env.QMAKE}} -early QMAKE_DEFAULT_LIBDIRS=$(xcrun -show-sdk-path)/usr/lib
          make -j ${{env.CORES}}
          ../build-systems/github/macos/create-dmg.sh

      #      - name: '📤 Upload artifact: macOS'
      #        uses: actions/upload-artifact@v4
      #        with:
      #          name: QOwnNotes.dmg
      #          path: src/QOwnNotes.dmg

      - name: "📤 Release DMG"
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ needs.create_release.outputs.upload_url }}
          asset_path: src/QOwnNotes.dmg
          asset_name: QOwnNotesQt5.dmg
          asset_content_type: application/x-apple-diskimage
#  publish_release:
#    name: 📣 Publish release
#    runs-on: ubuntu-latest
#    needs: [create_release, build-appimage, build-windows, build-macos, build-macos-qt5, build-snap]
#    steps:
#      - name: 📣 Publish draft release
#        uses: eregon/publish-release@v1
#        env:
#          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
#        with:
#          release_id: ${{ needs.create_release.outputs.release_id }}