MaaAssistantArknights/.github/workflows/ci.yml

name: ci

on:
  push:
    tags:
      - "v*"
    branches-ignore:
      - "master"
    paths:
      - "3rdparty/include/**"
      - "include/**"
      - "src/**"
      - "cmake/**"
      - "CMakeLists.txt"
      - ".github/workflows/ci.yml"
      - "!**/*.md"
      - "tools/maadeps-download.py"
  pull_request:
    branches:
      - "dev"
    paths:
      - "3rdparty/include/**"
      - "include/**"
      - "src/**"
      - "cmake/**"
      - "CMakeLists.txt"
      - "!**/*.md"
      - "tools/maadeps-download.py"
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  meta:
    # Prevent duplicate runs on organization branches with PRs
    if: github.event_name != 'pull_request' ||
      github.event.pull_request.head.repo.full_name !=
      github.event.pull_request.base.repo.full_name

    runs-on: ubuntu-latest
    outputs:
      tag: ${{ steps.set_tag.outputs.tag }}
      prerelease: ${{ steps.set_pre.outputs.prerelease }}
    steps:
      - name: Checkout code
        uses: actions/checkout@v5
        with:
          path: temp
          show-progress: false

      - name: Fetch history
        if: ${{ !startsWith(github.ref, 'refs/pull/') }}
        run: |
          git init
          cp $GITHUB_WORKSPACE/temp/.git/config ./.git
          rm -rf $GITHUB_WORKSPACE/temp
          # git config remote.origin.fetch '+refs/*:refs/*'
          git fetch --filter=tree:0 # --update-head-ok
          git reset --hard origin/$(git branch --show-current) || true
          git checkout ${{ github.ref_name }}

      - name: Set tag
        id: set_tag
        run: |
          ${{ startsWith(github.ref, 'refs/pull/') && 'cd temp' || '' }}
          echo tag=$(git describe --tags --match "v*" ${{ github.ref }} || git rev-parse --short HEAD) | tee -a $GITHUB_OUTPUT
          exit ${PIPESTATUS[0]}

      - name: Judge pre-release
        id: set_pre
        if: ${{ startsWith(github.ref, 'refs/tags/v') }}
        run: |
          if [[ '${{ steps.set_tag.outputs.tag }}' =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
            echo prerelease=false | tee -a $GITHUB_OUTPUT
          else
            echo prerelease=true | tee -a $GITHUB_OUTPUT
          fi

      - name: Generate changelog
        if: ${{ startsWith(github.ref, 'refs/tags/v') }}
        run: |
          this_tag=${{ steps.set_tag.outputs.tag }}
          if [[ '${{ steps.set_pre.outputs.prerelease }}' != 'false' ]]; then
            last_tag=$(git describe --tags --match "v*" --abbrev=0 --exclude='${{ steps.set_tag.outputs.tag }}')
          else
            last_tag=$(git describe --tags --match "v*" --abbrev=0 --exclude='${{ steps.set_tag.outputs.tag }}' --exclude='*-*')
          fi
          echo >> CHANGELOG.md
          echo "**Full Changelog**: [$last_tag -> $this_tag](https://github.com/MaaAssistantArknights/MaaAssistantArknights/compare/${last_tag}...${this_tag})" >> CHANGELOG.md
          echo >> CHANGELOG.md
          echo "[已有 Mirror酱 CDK？前往 Mirror酱 高速下载](https://mirrorchyan.com/zh/projects?rid=MAA&source=maagh-release)" >> CHANGELOG.md

      - name: Upload changelog to Github
        uses: actions/upload-artifact@v4
        if: ${{ startsWith(github.ref, 'refs/tags/v') }}
        with:
          name: changelog
          path: CHANGELOG.md

  windows:
    # Prevent duplicate runs on organization branches with PRs
    if: github.event_name != 'pull_request' ||
      github.event.pull_request.head.repo.full_name !=
      github.event.pull_request.base.repo.full_name

    needs: meta
    strategy:
      matrix:
        arch: [arm64, x64]
      fail-fast: false
    runs-on: windows-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v5
        with:
          show-progress: false

      - name: Fetch submodules
        run: |
          git submodule update --init --depth 1 3rdparty/EmulatorExtras

      - name: Cache MaaDeps
        id: cache-maadeps
        uses: actions/cache@v4
        with:
          path: |
            ./MaaDeps
          key: ${{ runner.os }}-${{ matrix.arch }}-maadeps-${{ hashFiles('tools/maadeps-download.py') }}

      - name: Bootstrap MaaDeps
        if: steps.cache-maadeps.outputs.cache-hit != 'true'
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          python3 tools/maadeps-download.py ${{ matrix.arch }}-windows

      - name: Config cmake
        run: |
          mkdir -p build
          cmake -B build ${{ matrix.arch == 'arm64' && '-A ARM64' }} -DCMAKE_BUILD_TYPE=Release -DMAADEPS_TRIPLET='maa-${{ matrix.arch }}-windows' -DINSTALL_RESOURCE=ON -DINSTALL_PYTHON=ON -DMAA_HASH_VERSION='${{ needs.meta.outputs.tag }}' -DBUILD_WPF_GUI=OFF

      - name: Build
        run: |
          cmake --build build --config Release --parallel $env:NUMBER_OF_PROCESSORS

      - name: Install
        run: |
          mkdir -p install
          cmake --install build --prefix install --config Release

      - name: Cache .nuke/temp, ~/.nuget/packages
        id: cache-nuget
        uses: actions/cache@v4
        with:
          path: |
            .nuke/temp
            ~/.nuget/packages
          key: ${{ runner.os }}-${{ matrix.arch }}-nuget-${{ hashFiles('**/*.csproj') }}

      - name: Restore dependencies
        if: steps.cache-nuget.outputs.cache-hit != 'true'
        run: dotnet restore src/MaaWpfGui/MaaWpfGui.csproj

      - name: Taggify Version for csproj
        run: |
          $csprojPath = "src/MaaWpfGui/MaaWpfGui.csproj"
          $csprojPath = Resolve-Path -Path $csprojPath
          $tag = '${{ needs.meta.outputs.tag }}' -replace '.*?/', ''
          if ($tag -match '\d+(\.\d+){1,3}') {
              $match = $Matches[0]
          } else {
              $match = "0.0.1"
          }
          [xml]$csproj = Get-Content -Path $csprojPath
          $node = $csproj.Project.PropertyGroup | where {$_.ApplicationVersion -ne $null}
          $node.InformationalVersion = $tag
          $node.Version = $match
          $node.FileVersion = $match
          $node.AssemblyVersion = $match
          $csproj.Save($csprojPath)

      - name: Publish WPF GUI
        continue-on-error: true
        run: |
          dotnet publish src/MaaWpfGui/MaaWpfGui.csproj -c Release -o install

      - name: Organize Install Files
        shell: bash
        run: |
          rm -rf install/*.pdb
          rm -rf install/msvc-debug
          rm -rf install/*.h

          cp tools/DependencySetup_依赖库安装.bat install

      - name: Zip files
        run: |
          cd install
          Compress-Archive -Destination MAA-${{ needs.meta.outputs.tag }}-win-${{ matrix.arch }}.zip -Path ./*

      - name: Upload MAA to Github
        uses: actions/upload-artifact@v4
        with:
          name: MAA-win-${{ matrix.arch }}
          path: install/*.zip

  ubuntu:
    # Prevent duplicate runs on organization branches with PRs
    if: github.event_name != 'pull_request' ||
      github.event.pull_request.head.repo.full_name !=
      github.event.pull_request.base.repo.full_name

    needs: meta
    runs-on: ubuntu-latest
    strategy:
      matrix:
        arch: [aarch64, x86_64]
      fail-fast: false
    steps:
      - name: Checkout code
        uses: actions/checkout@v5
        with:
          show-progress: false

      - name: Fetch submodules
        run: |
          git submodule update --init --depth 1 3rdparty/EmulatorExtras
          git submodule update --init --depth 1 src/maa-cli

      - name: Cache MaaDeps
        id: cache-maadeps
        uses: actions/cache@v4
        with:
          path: ./MaaDeps
          key: ${{ runner.os }}-${{ matrix.arch == 'x86_64' && 'x64' || 'arm64' }}-maadeps-${{ hashFiles('tools/maadeps-download.py') }}

      - name: Bootstrap MaaDeps
        if: steps.cache-maadeps.outputs.cache-hit != 'true'
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          python3 tools/maadeps-download.py ${{ matrix.arch == 'x86_64' && 'x64' || 'arm64' }}-linux

      - name: Config cmake
        run: |
          mkdir -p build
          cmake -B build \
            -DCMAKE_BUILD_TYPE=Release \
            -DMAADEPS_TRIPLET='maa-${{ matrix.arch == 'x86_64' && 'x64' || 'arm64' }}-linux' \
            -DINSTALL_RESOURCE=ON \
            -DINSTALL_PYTHON=ON \
            -DMAA_HASH_VERSION='${{ needs.meta.outputs.tag }}' \
            -DCMAKE_TOOLCHAIN_FILE=MaaDeps/cmake/maa-${{ matrix.arch == 'x86_64' && 'x64' || 'arm64' }}-linux-toolchain.cmake

      - name: Build
        run: |
          cmake --build build --config Release --parallel $(nproc)
        env:
          CLICOLOR_FORCE: 1

      - name: Install
        run: |
          mkdir -p install
          cmake --install build --prefix install --config Release

      - name: Setup Cross Compile Toolchains for CLI
        uses: ./src/maa-cli/.github/actions/setup
        with:
          os: ubuntu-latest
          target_arch: ${{ matrix.arch }}

      - name: Build CLI
        run: |
          cargo build --release --locked --package maa-cli --features vendored-openssl
          cp -v target/$CARGO_BUILD_TARGET/release/maa $GITHUB_WORKSPACE/install/maa
          cargo build --release --locked --package maa-cli --no-default-features \
            --features git2,vendored-openssl
          cp -v target/$CARGO_BUILD_TARGET/release/maa $GITHUB_WORKSPACE/appimage-maa
        working-directory: src/maa-cli

      - name: Build Appimage
        run: |
          sudo add-apt-repository universe
          sudo apt update
          sudo apt install libfuse2
          mkdir -pv release
          mkdir -pv Maa.AppDir/usr/share/maa
          cp -r install/* Maa.AppDir/usr/share/maa/
          wget -c https://raw.githubusercontent.com/MaaAssistantArknights/design/main/logo/maa-logo_512x512.png -O Maa.AppDir/maa.png
          mkdir -pv Maa.AppDir/usr/share/icons/hicolor/512x512/apps/
          cp -v Maa.AppDir/maa.png Maa.AppDir/usr/share/icons/hicolor/512x512/apps/
          cp -v appimage-maa Maa.AppDir/usr/share/maa/maa
          chmod a+x Maa.AppDir/usr/share/maa/maa

          cat > Maa.AppDir/maa.desktop <<EOF
          [Desktop Entry]
          Type=Application
          Name=MaaAssistantArknights
          Icon=maa
          Exec=AppRun
          Terminal=true
          Categories=Game;StrategyGame;
          Comment=An Arknights assistant
          EOF

          ln -sv usr/share/maa/maa Maa.AppDir/AppRun
          mkdir -pv Maa.AppDir/usr/share/metainfo/
          cp -v tools/AppImage/io.github.maaassistantarknights.maaassistantarknights.metainfo.xml Maa.AppDir/usr/share/metainfo/
          wget "https://github.com/AppImage/appimagetool/releases/download/continuous/appimagetool-x86_64.AppImage"
          # appimagetool with embedded runtime does not support cross build, till AppImage/appimagetool 7a10b8
          wget "https://github.com/AppImage/type2-runtime/releases/download/old/runtime-fuse3-${{ matrix.arch }}"
          chmod a+x appimagetool-x86_64.AppImage
          ARCH=${{ matrix.arch }} ./appimagetool-x86_64.AppImage --runtime-file runtime-fuse3-${{ matrix.arch }} Maa.AppDir
          chmod a+x MaaAssistantArknights-${{ matrix.arch }}.AppImage
          mv -v MaaAssistantArknights-${{ matrix.arch }}.AppImage $GITHUB_WORKSPACE/release/MAA-${{ needs.meta.outputs.tag }}-linux-${{ matrix.arch }}.AppImage

      - name: Tar files
        run: |
          mkdir -p release
          cd install
          tar czvf $GITHUB_WORKSPACE/release/MAA-${{ needs.meta.outputs.tag }}-linux-${{ matrix.arch }}.tar.gz .

      - name: Upload MAA to Github
        uses: actions/upload-artifact@v4
        with:
          name: MAA-linux-${{ matrix.arch }}
          path: |
            release/*.AppImage
            release/*.tar.gz

  macOS-Core:
    # Prevent duplicate runs on organization branches with PRs
    if: github.event_name != 'pull_request' ||
      github.event.pull_request.head.repo.full_name !=
      github.event.pull_request.base.repo.full_name

    needs: meta
    runs-on: macos-26
    strategy:
      matrix:
        arch: [arm64, x86_64]
      fail-fast: false
    steps:
      - name: Checkout code
        uses: actions/checkout@v5
        with:
          show-progress: false

      # ninja 1.13.1 is already installed and up-to-date.
      # - name: Install Dependencies
      #   run: |
      #     brew install ninja

      - name: Cache MaaDeps
        id: cache-maadeps
        uses: actions/cache@v4
        with:
          path: ./MaaDeps
          key: ${{ runner.os }}-${{ matrix.arch == 'x86_64' && 'x64' || 'arm64' }}-maadeps-${{ hashFiles('tools/maadeps-download.py') }}

      - name: Bootstrap MaaDeps
        run: |
          [[ ${{ matrix.arch }} = "arm64" ]] && triplet="arm64-osx" || triplet="x64-osx"
          python3 tools/maadeps-download.py ${triplet}
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Config cmake
        run: |
          cmake -B build -GNinja \
            -DCMAKE_BUILD_TYPE=Release \
            -DCMAKE_OSX_ARCHITECTURES='${{ matrix.arch }}' \
            -DMAA_HASH_VERSION='${{ needs.meta.outputs.tag }}'

      - name: Build
        run: |
          cmake --build build --config Release --parallel $(sysctl -n hw.logicalcpu)

      - name: Install
        run: |
          cmake --install build --prefix install --config Release

      - name: Upload MAA to Github
        uses: actions/upload-artifact@v4
        with:
          name: MAACore-macos-${{ matrix.arch }}
          path: "install/*.dylib"

  macOS-GUI:
    # Prevent duplicate runs on organization branches with PRs
    if: github.event_name != 'pull_request' ||
      github.event.pull_request.head.repo.full_name !=
      github.event.pull_request.base.repo.full_name

    needs: [meta, macOS-Core]
    runs-on: macos-26
    steps:
      - name: Checkout code
        uses: actions/checkout@v5
        with:
          show-progress: false

      - name: Install Dependencies
        if: startsWith(github.ref, 'refs/tags/v')
        run: |
          brew install graphicsmagick imagemagick
          npm install -g create-dmg

      - name: Fetch submodules
        run: |
          git submodule update --init --depth 1 src/MaaMacGui

      - name: Download Arm64 MAA from Github
        uses: actions/download-artifact@v5
        with:
          name: MAACore-macos-arm64
          path: install-arm64

      - name: Download x64 MAA from Github
        uses: actions/download-artifact@v5
        with:
          name: MAACore-macos-x86_64
          path: install-x86_64

      - name: Install Developer ID Certificate
        if: startsWith(github.ref, 'refs/tags/v')
        uses: apple-actions/import-codesign-certs@v5
        with:
          p12-file-base64: ${{ secrets.HGUANDL_SIGN_CERT_P12 }}
          p12-password: ${{ secrets.HGUANDL_SIGN_CERT_PASSWD }}

      - name: Download Provisioning Profiles
        if: startsWith(github.ref, 'refs/tags/v')
        uses: apple-actions/download-provisioning-profiles@v4
        with:
          bundle-id: "com.hguandl.MeoAsstMac"
          issuer-id: ${{ secrets.HGUANDL_APPSTORE_ISSUER }}
          api-key-id: ${{ secrets.HGUANDL_APPSTORE_KEYID }}
          api-private-key: ${{ secrets.HGUANDL_APPSTORE_KEY }}

      - name: Setup Xcode Toolchain
        if: false
        run: |
          sudo xcode-select -s /Applications/Xcode_16.1.app/Contents/Developer

      - name: Build Universal Binaries
        run: |
          mkdir build
          for LIB_NAME in $(ls install-arm64); do
            lipo -create install-arm64/$LIB_NAME install-x86_64/$LIB_NAME -output build/$LIB_NAME
          done

      - name: Archive Runtime Files
        run: |
          mkdir runtime && cd runtime
          name='MAA-${{ needs.meta.outputs.tag }}-macos-runtime-universal'
          mkdir "$name" && cd "$name"
          cp -v ../../build/*.dylib .
          ln -vs libonnxruntime*.dylib libonnxruntime.dylib
          ln -vs libopencv_world4*.dylib libopencv_world4.dylib
          cp -vr ../../resource .
          cd .. || exit 1
          zip -yrX9 "$name.zip" "$name"

      - name: Upload MAA runtime to Github
        uses: actions/upload-artifact@v4
        with:
          name: MAA-macos-runtime-universal
          path: runtime/MAA-${{ needs.meta.outputs.tag }}-macos-runtime-universal.zip

      - name: Build XCFramework
        run: |
          xcodebuild -create-xcframework -library libMaaCore.dylib -headers ../include -output MaaCore.xcframework
          xcodebuild -create-xcframework -library libfastdeploy_ppocr.dylib -output fastdeploy_ppocr.xcframework
          xcodebuild -create-xcframework -library libonnxruntime.*.dylib -output ONNXRuntime.xcframework
          xcodebuild -create-xcframework -library libopencv*.dylib -output OpenCV.xcframework
        working-directory: build

      - name: Setup GUI Version
        run: |
          RELEASE_COUNT=$(git ls-remote --tags origin | grep refs/tags/v | awk 'END{print NR}')
          echo 'MARKETING_VERSION = ${{ needs.meta.outputs.tag }}' | tee src/MaaMacGui/Version.xcconfig
          echo 'CURRENT_PROJECT_VERSION = '"${RELEASE_COUNT}" | tee -a src/MaaMacGui/Version.xcconfig

      - name: Build MAA
        run: |
          if ${{ startsWith(github.ref, 'refs/tags/v') }}; then
            xcodebuild -scheme MAA archive -archivePath MAA.xcarchive
          else
            xcodebuild CODE_SIGNING_ALLOWED=NO -scheme MAA archive -archivePath MAA.xcarchive
          fi
        working-directory: src/MaaMacGui

      - name: Export MAA
        if: startsWith(github.ref, 'refs/tags/v')
        run: |
          xcodebuild -exportArchive -archivePath MAA.xcarchive -exportOptionsPlist ExportOptions.plist -exportPath Export
        working-directory: src/MaaMacGui

      - name: Create Disk Image
        if: startsWith(github.ref, 'refs/tags/v')
        run: |
          create-dmg Export/MAA.app
          mv MAA*.dmg MAA.dmg
        working-directory: src/MaaMacGui

      - name: Archive Debug Symbols
        if: startsWith(github.ref, 'refs/tags/v')
        run: |
          ditto -c -k --keepParent MAA.app.dSYM MAA.app.dSYM.zip
        working-directory: src/MaaMacGui/MAA.xcarchive/dSYMs

      - name: Place Packages
        if: startsWith(github.ref, 'refs/tags/v')
        run: |
          GIT_TAG=${{ needs.meta.outputs.tag }}
          APP_DMG=MAA-${GIT_TAG}-macos-universal.dmg
          APP_SYM=MAAComponent-DebugSymbol-${GIT_TAG}-macos-universal.zip
          mkdir -p release
          mv src/MaaMacGui/MAA.dmg release/${APP_DMG}
          mv src/MaaMacGui/MAA.xcarchive/dSYMs/MAA.app.dSYM.zip release/${APP_SYM}

      - name: Notarize Image
        if: startsWith(github.ref, 'refs/tags/v')
        uses: nick-fields/retry@v3
        with:
          max_attempts: 3
          timeout_minutes: 15
          command: |
            cd release
            echo "$APPSTORE_KEY" > "AuthKey_${APPSTORE_KEYID}.p8"
            dmg="MAA-${{ needs.meta.outputs.tag }}-macos-universal.dmg"
            xcrun notarytool submit -k "AuthKey_${APPSTORE_KEYID}.p8" -d "$APPSTORE_KEYID" -i "$ISSUER_ID" --wait ${dmg}
        env:
          APPSTORE_KEYID: ${{ secrets.HGUANDL_APPSTORE_KEYID }}
          APPSTORE_KEY: ${{ secrets.HGUANDL_APPSTORE_KEY }}
          ISSUER_ID: ${{ secrets.HGUANDL_APPSTORE_ISSUER }}

      - name: Attach Notarization Tickets
        if: startsWith(github.ref, 'refs/tags/v')
        run: |
          dmg="MAA-${{ needs.meta.outputs.tag }}-macos-universal.dmg"
          xcrun stapler staple ${dmg}
        working-directory: release

      - name: Upload MAA to Github
        uses: actions/upload-artifact@v4
        with:
          name: MAA-macos-universal
          path: ${{ startsWith(github.ref, 'refs/tags/v') && 'release/MAA*' || 'src/MaaMacGui/MAA.xcarchive/**' }}

  release:
    # Prevent duplicate runs on organization branches with PRs
    if: (github.event_name != 'pull_request' ||
      github.event.pull_request.head.repo.full_name !=
      github.event.pull_request.base.repo.full_name) && startsWith(github.ref, 'refs/tags/v')

    needs: [meta, windows, ubuntu, macOS-Core, macOS-GUI]
    runs-on: ubuntu-latest
    steps:
      - name: Download MAA from Github
        uses: actions/download-artifact@v5
        with:
          path: assets

      - name: Cleanup files
        run: |
          mv -vf assets/changelog/* .
          rm -rf assets/MAACore-macos-*
          cd assets
          # find . -type f | xargs mv -fvt .
          find . -type f | while read f; do mv -fvt . $f; done

      - name: Release to Github
        uses: softprops/action-gh-release@v2.3.4
        with:
          body_path: CHANGELOG.md
          files: |
            assets/*
          prerelease: ${{ needs.meta.outputs.prerelease != 'false' }}

      - name: Trigger MirrorChyan
        run: |
          gh workflow run --repo $GITHUB_REPOSITORY mirrorchyan
          gh workflow run --repo $GITHUB_REPOSITORY mirrorchyan_release_note
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Trigger secondary workflows # ref: https://docs.github.com/en/actions/using-workflows/triggering-a-workflow#triggering-a-workflow-from-a-workflow
        run: |
          gh workflow run --repo $GITHUB_REPOSITORY release-ota
        env:
          GH_TOKEN: ${{ secrets.MISTEOWORKFLOW }}

      - name: Create issue if failed
        if: failure()
        uses: actions-cool/issues-helper@v3
        with:
          actions: "create-issue"
          title: "Failed Release"
          body: |
            ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}