build.yml

name: Build Pulsar Binaries

on:
  push:
    branches:
      - 'master'
    tags:
      - '**'
  pull_request:
  workflow_dispatch:

env:
  # Variables needed for build information
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  PYTHON_VERSION: '3.12'
  NODE_VERSION: 16
  ROLLING_UPLOAD_TOKEN: ${{ secrets.ROLLING_RELEASE_UPLOAD_TOKEN }}
  # Below variables allow us to quickly control visual tests for each platform
  RUN_WINDOWS_VT: false
  RUN_LINUX_VT: true
  RUN_MACOS_VT: true

jobs:
  build:
    strategy:
      matrix:
        os: [ ubuntu-latest, macos-12, windows-latest ]
        include:
          - os: ubuntu-latest
            image: "debian:10"
      fail-fast: false
    runs-on: ${{ matrix.os }}
    container: ${{ matrix.image }}
    outputs:
      timestamp: ${{ steps.linux-binary-version.outputs.timestamp }}

    steps:
    - name: Install build dependencies - Linux
      if: ${{ runner.os == 'Linux' }}
      run: apt-get update && apt-get install -y git python3 python3-pip make gcc g++ libx11-dev libxkbfile-dev pkg-config libsecret-1-dev rpm xvfb ffmpeg zstd

    - name: Checkout the latest code
      uses: actions/checkout@v4

    - name: Setup Node
      uses: actions/setup-node@v4
      with:
        node-version: ${{ env.NODE_VERSION }}

    - name: Setup Python
      # actions/setup-python's copy of Python is compiled for too new glibc,
      # which won't work in a Debian 10 Docker image.
      # Get Python from apt repos instead on Linux.
      if: ${{ runner.os != 'Linux' }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ env.PYTHON_VERSION }}

    - name: Install Python setuptools
      # This is needed for Python 3.12+, since many versions of node-gyp
      # are incompatible with Python 3.12+, which no-longer ships 'distutils'
      # out of the box. 'setuptools' package provides 'distutils'.
      run: python3 -m pip install setuptools

    - name: Install Yarn - Linux
      if: ${{ runner.os == 'Linux' }}
      run: npm install -g yarn

    - name: Setup Git Submodule
      if: ${{ runner.os != 'Linux' }}
      run: |
        git submodule init
        git submodule update

    - name: Setup Git Submodule - Linux
      if: ${{ runner.os == 'Linux' }}
      run: |
        git config --global --add safe.directory /__w/pulsar/pulsar
        git submodule init
        git submodule update

    - name: Set Timestamp for Binary Version - Linux
      id: linux-binary-version
      if: ${{ runner.os == 'Linux' }}
      # This output is currently only set for the sake of the Rolling binary upload script.
      # See the "test-and-upload-Linux" job below.
      run: echo "timestamp=`date -u +%Y%m%d%H`" >> "$GITHUB_OUTPUT"

    - name: Check Pulsar Version
      if: ${{ runner.os != 'Windows' }}
      run: sed -i -e "s/[0-9]*-dev/`date -u +%Y%m%d%H`/g" package.json

    - name: Check Pulsar Version - Windows
      if: ${{ runner.os == 'Windows' }}
      run: (Get-Content package.json) -replace '[0-9]*-dev', (date -u +%Y%m%d%H) | Set-Content -Path package.json

    - name: Reinstall Current Node-GYP NodeJS Headers
      # Overwrite bad headers that get downloaded.
      # NodeJS versions above 16 should come with `node-gyp@9.4.0` that has a fix
      # for this issue. At that point this additional step can be removed.
      run: npx node-gyp install ${{ env.NODE_VERSION }}

    - name: Install Pulsar Dependencies
      uses: nick-fields/retry@7152eba30c6575329ac0576536151aca5a72780e
      with:
        timeout_minutes: 30
        max_attempts: 3
        retry_on: error
        command: yarn install --ignore-engines
        on_retry_command: rm -R node_modules

    - name: Build Pulsar
      uses: nick-fields/retry@7152eba30c6575329ac0576536151aca5a72780e
      with:
        timeout_minutes: 30
        max_attempts: 3
        retry_on: error
        command: |
          yarn build
          yarn run build:apm

    - name: Cache Pulsar dependencies - Linux
      if: ${{ runner.os == 'Linux' }}
      uses: actions/cache/save@v4
      with:
        path: |
          node_modules
          packages
        key: Linux-dependencies-${{ github.sha }}-${{ github.workflow }}

    # macOS Signing Stuff
    - name: Build Pulsar Binaries (macOS) (Signed)
      if: ${{ runner.os == 'macOS' && github.event_name == 'push' }}
      # Note: PRs generated from forks cannot access GitHub Secrets.
      # So if the PR is from a fork, we can still build, but cannot sign.
      # Note: We aren't attempting to sign for *any* PRs anymore, though.
      env:
        CSC_LINK: ${{ secrets.CSC_LINK }}
        CSC_KEY_PASSWORD: ${{ secrets.CSC_KEY_PASSWORD }}
        APPLEID: ${{ secrets.APPLEID }}
        APPLEID_PASSWORD: ${{ secrets.APPLEID_PASSWORD }}
        TEAM_ID: ${{ secrets.TEAM_ID }}
      uses: nick-fields/retry@7152eba30c6575329ac0576536151aca5a72780e
      with:
        timeout_minutes: 45
        max_attempts: 3
        retry_on: error
        command: yarn dist

    - name: Build Pulsar Binaries (macOS) (Unsigned)
      if: ${{ runner.os == 'macOS' && github.event_name != 'push' }}
      uses: nick-fields/retry@7152eba30c6575329ac0576536151aca5a72780e
      with:
        timeout_minutes: 45
        max_attempts: 3
        retry_on: error
        command: yarn dist

    - name: Build Pulsar Binaries
      if: ${{ runner.os != 'macOS' }}
      uses: nick-fields/retry@7152eba30c6575329ac0576536151aca5a72780e
      with:
        timeout_minutes: 30
        max_attempts: 3
        retry_on: error
        command: yarn dist

    - name: Rename Pulsar Binaries for Regular release (Linux)
      if: ${{ runner.os == 'Linux' }}
      run: node ./script/rename.js "Linux"

    - name: Rename Pulsar Binaries for Regular release (macOS)
      if: ${{ runner.os == 'macOS' }}
      run: node ./script/rename.js "Intel.Mac"

    - name: Rename Pulsar Binaries for Regular release (Windows)
      if: ${{ runner.os == 'Windows' }}
      run: node ./script/rename.js "Windows"

    - name: Cache Pulsar Binaries - Linux
      if: ${{ runner.os == 'Linux' }}
      uses: actions/cache/save@v4
      with:
        path: ./binaries
        key: pulsar-Linux-Binaries-${{ github.sha }}-${{ github.workflow }}

    - name: Upload Binary Artifacts
      uses: actions/upload-artifact@v4
      with:
        name: ${{ matrix.os }} Binaries
        path: ./binaries/*

    - name: Test Binary - Windows
      if: runner.os == 'Windows' && env.RUN_WINDOWS_VT == true
      # TODO: Convert script to PowerShell
      run: |
        mkdir extracted; tar -xf binaries/*zip -C ./extracted/
        export BINARY_NAME=./extracted/Pulsar.exe
        PLAYWRIGHT_JUNIT_OUTPUT_NAME=report.xml npx playwright test --reporter=junit,list || echo "Yeah, tests failed, Windows is like this"

    - name: Test Binary - macOS
      if: runner.os == 'macOS' && env.RUN_MACOS_VT == true
      run: |
        export PATH="/usr/local/opt/node@16/bin:/usr/local/bin:$PATH"
        rm -R node_modules/electron; yarn install --check-files
        hdiutil mount binaries/*Pulsar*dmg
        export BINARY_NAME=`ls /Volumes/Pulsar*/Pulsar.app/Contents/MacOS/Pulsar`
        PLAYWRIGHT_JUNIT_OUTPUT_NAME=report.xml arch -x86_64 npx playwright test --reporter=junit,list

    - name: Add binaries to Rolling Release Repo
      if: ${{ github.event_name == 'push' && runner.os != 'Linux' }}
      # We only want to upload rolling binaries if they are a commit to master
      # Otherwise we want to not upload if it's a PR or manually triggered build
      run: |
        cd ./script/rolling-release-scripts
        npm install
        node ./rolling-release-binary-upload.js

    - name: Upload Video Artifacts
      # Run whether this job passed or failed, unless explicitly cancelled.
      if: ${{ !cancelled() && runner.os != 'Linux' }}
      uses: actions/upload-artifact@v4
      with:
        name: ${{ matrix.os }} Videos
        path: ./tests/videos/**


  test-and-upload-Linux:
    # I couldn't figure out how to get these visual tests to actually run in the
    # Debian Docker environment. If anyone can make it work, feel free to
    # re-combine visual testing on Linux back into the main build job above!
    # - DeeDeeG
    runs-on: ubuntu-latest
    needs: build

    steps:
    - name: Checkout the latest code
      uses: actions/checkout@v4

    - name: Setup Node
      uses: actions/setup-node@v4
      with:
        node-version: ${{ env.NODE_VERSION }}

    - name: Restore Cached Pulsar Binaries - Linux
      if: ${{ runner.os == 'Linux' }}
      uses: actions/cache/restore@v4
      with:
        path: ./binaries
        key: pulsar-Linux-Binaries-${{ github.sha }}-${{ github.workflow }}

    - name: Restore Cached Pulsar dependencies - Linux
      if: ${{ runner.os == 'Linux' }}
      uses: actions/cache/restore@v4
      with:
        path: |
          node_modules
          packages
        key: Linux-dependencies-${{ github.sha }}-${{ github.workflow }}

    - name: Test Binary - Linux
      if: ${{ (runner.os == 'Linux') && env.RUN_LINUX_VT }}
      run: |
        rm -R node_modules/electron; yarn install --check-files
        ./binaries/*AppImage --appimage-extract
        export BINARY_NAME='squashfs-root/pulsar'
        mkdir -p ./tests/videos
        Xvfb -screen 0 1024x768x24+32 :99 & nohup ffmpeg -video_size 1024x768 -f x11grab -i :99.0 ./tests/videos/out.mpg & DISPLAY=:99 PLAYWRIGHT_JUNIT_OUTPUT_NAME=report.xml npx playwright test --reporter=junit,list

    - name: Check Pulsar Version
      if: ${{ runner.os != 'Windows' }}
      run: sed -i -e "s/[0-9]*-dev/${TIMESTAMP}/g" package.json
      env:
        TIMESTAMP: ${{needs.build.outputs.timestamp}}

    - name: Add binaries to Rolling Release Repo - Linux
      if: ${{ github.event_name == 'push' && runner.os == 'Linux' }}
      # We only want to upload rolling binaries if they are a commit to master
      # Otherwise we want to not upload if it's a PR or manually triggered build
      run: |
        cd ./script/rolling-release-scripts
        npm install
        node ./rolling-release-binary-upload.js

    - name: Upload Video Artifacts - Linux
      # Run whether this job passed or failed, unless explicitly cancelled.
      if: ${{ !cancelled() && runner.os == 'Linux' }}
      uses: actions/upload-artifact@v4
      with:
        name: ${{ matrix.os }} Videos
        path: ./tests/videos/**