name: Emu build (Linux)

on:
  push:
    branches: [ 
      "ci-build-emu-linux*",
      "ci-build-all"
    ]
    tags:        
      - release*
    
  pull_request:
    branches: [ "dev" ]
    paths-ignore:
      - '**/*.md'
      - 'dev.notes/**'
      - 'post_build/**'
      - 'z_original_repo_files/**'
      - 'sdk/*.txt'
      - 'LICENSE'
      # tools
      - 'tools/generate_emu_config/**'
      - 'tools/migrate_gse/**'
      - 'tools/steamclient_loader/linux/**' # these are just shell scripts, not compiled
    
  workflow_dispatch:
    # allows manual trigger

permissions:
  contents: write

env:
  DEPS_CACHE_KEY: emu-deps-linux
  DEPS_CACHE_DIR: build/deps/linux

  PACKAGE_BASE_DIR: "build/package/linux"
  THIRD_PARTY_BASE_DIR: 'third-party'
  
jobs:
  # this helps in manual runs, if build fails, then deps are saved
  dependencies:
    runs-on: ubuntu-22.04
    # cache but not for tags or PRs
    # !tag && !pull_request
    # also you could use this: github.event_name != 'pull_request'
    if: |
      !startsWith(github.ref, 'refs/tags/') &&
      !startsWith(github.ref, 'refs/pull/')

    steps:
    # we need branch because it has build scripts
    - name: Checkout branch
      uses: actions/checkout@v4

### fix folder permissions! not sure why this fails
    # nested subdirs "build/linux/release" cause permission problems
    - name: Give all permissions for repo folder
      shell: bash
      working-directory: ${{ github.workspace }}
      run:  sudo chmod -R 777 "${{ github.workspace }}"

    - name: Lookup cache for deps
      id: emu-deps-cache-step
      uses: actions/cache@v4
      with:
        key: ${{ env.DEPS_CACHE_KEY }}
        path: ${{ env.DEPS_CACHE_DIR }}
        lookup-only: true # don't restore cache if found

    - name: Clone third-party deps (deps/linux)
      if: steps.emu-deps-cache-step.outputs.cache-hit != 'true'
      uses: actions/checkout@v4
      with:
        ref: 'third-party/deps/linux'
        path: "${{env.THIRD_PARTY_BASE_DIR}}/deps/linux"

    - name: Clone third-party deps (deps/common)
      if: steps.emu-deps-cache-step.outputs.cache-hit != 'true'
      uses: actions/checkout@v4
      with:
        ref: 'third-party/deps/common'
        path: "${{env.THIRD_PARTY_BASE_DIR}}/deps/common"

    - name: Build deps
      if: steps.emu-deps-cache-step.outputs.cache-hit != 'true'
      shell: bash
      run: sudo chmod 777 build_linux_deps.sh && sudo ./build_linux_deps.sh -verbose


  build:
    runs-on: ubuntu-22.04
    needs: [ dependencies ]
    if: ${{ !cancelled() }}

    steps:
    - name: Checkout branch
      uses: actions/checkout@v4

### deps
    - name: Lookup cache for deps
      id: emu-deps-cache-step
      # !tag && !pull_request
      # also you could use this: github.event_name != 'pull_request'
      if: |
        !startsWith(github.ref, 'refs/tags/') &&
        !startsWith(github.ref, 'refs/pull/')
      uses: actions/cache@v4
      with:
        key: ${{ env.DEPS_CACHE_KEY }}
        path: ${{ env.DEPS_CACHE_DIR }}

    # attempt to download again because in tags/PRs no cache is created
    - name: Clone third-party deps (deps/linux)
      if: steps.emu-deps-cache-step.outputs.cache-hit != 'true'
      uses: actions/checkout@v4
      with:
        ref: 'third-party/deps/linux'
        path: "${{env.THIRD_PARTY_BASE_DIR}}/deps/linux"

    - name: Clone third-party deps (deps/common)
      if: steps.emu-deps-cache-step.outputs.cache-hit != 'true'
      uses: actions/checkout@v4
      with:
        ref: 'third-party/deps/common'
        path: "${{env.THIRD_PARTY_BASE_DIR}}/deps/common"

### fix folder permissions! not sure why this fails
    # nested subdirs "build/linux/release" cause permission problems
    - name: Give all permissions for repo folder
      shell: bash
      working-directory: ${{ github.workspace }}
      run:  sudo chmod -R 777 "${{ github.workspace }}"

    - name: Build deps
      if: steps.emu-deps-cache-step.outputs.cache-hit != 'true'
      shell: bash
      run: sudo chmod 777 build_linux_deps.sh && sudo ./build_linux_deps.sh -verbose

## mandatory Linux packages, installed via sudo apt install ...
    - name: Install required packages
      shell: bash
      run: sudo chmod 777 build_linux_deps.sh && sudo ./build_linux_deps.sh -verbose -packages_only

## extra helpers/tools, these are not built inside the deps build dir
    - name: Clone third-party build helpers (build/linux)
      uses: actions/checkout@v4
      with:
        ref: 'third-party/build/linux'
        path: "${{env.THIRD_PARTY_BASE_DIR}}/build/linux"

### fix folder permissions! not sure why this fails
    # nested subdirs "build/linux/release" cause permission problems
    - name: Give all permissions for repo folder
      shell: bash
      working-directory: ${{ github.workspace }}
      run:  sudo chmod -R 777 "${{ github.workspace }}"

### build (release mode)
    - name: Build release mode
      shell: bash
      working-directory: ${{ github.workspace }}
      run: "sudo chmod 777 build_linux.sh && ./build_linux.sh -verbose release +build_str ${{ github.sha }}"

### package (release mode)
    - name: Package build (release)
      shell: bash
      working-directory: ${{ github.workspace }}
      run: sudo chmod 77 package_linux.sh && sudo ./package_linux.sh release

### upload artifact/package to github Actions (release mode)
    - name: Upload build package (release)
      uses: actions/upload-artifact@v4
      with:
        name: "build-linux-release-${{ github.sha }}"
        path: "${{ env.PACKAGE_BASE_DIR }}/release/"
        if-no-files-found: 'error'
        compression-level: 9
        retention-days: 1
    
### build (debug mode)
    - name: Build debug mode
      shell: bash
      working-directory: ${{ github.workspace }}
      run: "sudo chmod 777 build_linux.sh && ./build_linux.sh -verbose debug +build_str ${{ github.sha }}"

### package (debug mode)
    - name: Package build (debug)
      shell: bash
      working-directory: ${{ github.workspace }}
      run: sudo chmod 77 package_linux.sh && sudo ./package_linux.sh debug

### upload artifact/package to github Actions (debug mode)
    - name: Upload build package (debug)
      uses: actions/upload-artifact@v4
      with:
        name: "build-linux-debug-${{ github.sha }}"
        path: "${{ env.PACKAGE_BASE_DIR }}/debug/"
        if-no-files-found: 'error'
        compression-level: 9
        retention-days: 1
    
### release (debug + release modes) if this is a tag push
    - name: Release
      if: startsWith(github.ref, 'refs/tags/')
      uses: softprops/action-gh-release@v1
      with:
        files: "${{ env.PACKAGE_BASE_DIR }}/**/*"