builds.yml

name: 🖥️ Builds

on:
  push:
    branches: ["master"]
  pull_request:
  merge_group:
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}|${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

permissions: {}

jobs:
  static-checks-builds:
    name: 📊 Code style, file formatting, and docs
    runs-on: ubuntu-latest
    if: github.run_attempt > 1 || github.event_name == 'workflow_dispatch' || !vars.DISABLE_BUILDS
    outputs:
      changed-files: '"${{ steps.changed-files.outputs.clangd_all_changed_files }}"' # Wrap with quotes to bookend internal quote separators.
      sources-changed: ${{ steps.changed-files.outputs.sources_any_changed }}
      godot-executable-url: ${{ steps.godot-env.outputs.godot-linux-url }}
      godot-templates-url: ${{ steps.godot-env.outputs.godot-template-url }}
      godot-version: ${{ steps.godot-env.outputs.godot-version }}
    steps:
      - name: Checkout project
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          submodules: recursive
          fetch-depth: 0 # Treeless clone. Slightly less performant than a shallow clone, but makes finding diffs instantaneous.
          filter: tree:0 # See: https://github.blog/open-source/git/get-up-to-speed-with-partial-clone-and-shallow-clone/
          persist-credentials: false

      - name: Setup Godot variables
        id: godot-env
        uses: ./.github/actions/godot-env

      - name: Install APT dependencies
        uses: awalsh128/cache-apt-pkgs-action@553a35bb8ebd9fcabcb1c9451aa4c98e1b4ca8a9 # v1.6.3
        with:
          packages: libxml2-utils

      - name: Get changed files
        id: changed-files
        uses: tj-actions/changed-files@9426d40962ed5378910ee2e21d5f8c6fcbf2dd96 # v47.0.6
        with:
          safe_output: false # Output passed to environment variable to avoid command injection.
          separator: '" "' # To account for paths with spaces, ensure our items are split by quotes internally.
          skip_initial_fetch: true
          files_yaml_from_source_file: .github/changed-files.yml

      - name: Style checks via prek
        if: steps.changed-files.outputs.pre-commit-config_any_changed != 'true'
        uses: j178/prek-action@44924fe9ef4a6f88253c4b6b1bf11c689d3ce53d # v3.1.0
        env:
          CHANGED_FILES: '"${{ steps.changed-files.outputs.pre-commit_all_changed_files }}"' # Wrap with quotes to bookend internal quote separators
        with:
          extra-args: --files ${{ env.CHANGED_FILES }}

      - name: Style checks via prek for all files
        if: steps.changed-files.outputs.pre-commit-config_any_changed == 'true'
        uses: j178/prek-action@44924fe9ef4a6f88253c4b6b1bf11c689d3ce53d # v3.1.0

      - name: Class reference schema checks
        run: xmllint --noout --schema extension/doc_tools/class.xsd extension/doc_classes/*.xml

  build-master:
    name: 🛠️ Build
    needs: static-checks-builds
    if: needs.static-checks-builds.outputs.sources-changed == 'true' || github.event_name != 'pull_request'
    permissions:
      contents: read
    uses: ./.github/workflows/build-matrix.yml

  godot-debug-checks:
    runs-on: ubuntu-latest
    needs: [static-checks-builds, build-master]
    name: 🔍 Perform Godot Debug Checks
    steps:
      - name: Checkout project
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          submodules: recursive
          fetch-depth: 0 # Treeless clone. Slightly less performant than a shallow clone, but makes finding diffs instantaneous.
          filter: tree:0 # See: https://github.blog/open-source/git/get-up-to-speed-with-partial-clone-and-shallow-clone/
          persist-credentials: false

      - name: Export game
        id: export_game
        uses: ./.github/actions/openvic-export
        with:
          godot-executable-url: ${{ needs.static-checks-builds.outputs.godot-executable-url }}
          godot-templates-url: ${{ needs.static-checks-builds.outputs.godot-templates-url }}
          export-as-pack: true
          export-debug: true
          relative-export-path: ./game/export

      - name: Check for class reference updates
        env:
          EXPORT_GAME_OUTPUTS_EXECUTABLE_PATH: ${{ steps.export_game.outputs.executable-path }}
        run: |
          echo "Running --doctool to see if this changes the public API without updating the documentation."
          echo -e "If a diff is shown, it means that your code/doc changes are incomplete and you should update the class reference with --doctool.\n\n"
          cd game
          $EXPORT_GAME_OUTPUTS_EXECUTABLE_PATH --doctool --headless ../extension --gdextension-docs 2>&1 > /dev/null || true
          cd ..
          git diff --color --exit-code -- '*.xml' && ! git ls-files --others --exclude-standard | sed -e 's/^/New doc file missing in PR: /' | grep 'xml$'

  godot-unit-tests:
    runs-on: ubuntu-latest
    needs: [static-checks-builds, build-master]
    name: 🧪 Run gdUnit4 unit tests
    steps:
      - name: Checkout project
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          submodules: recursive
          fetch-depth: 0 # Treeless clone. Slightly less performant than a shallow clone, but makes finding diffs instantaneous.
          filter: tree:0 # See: https://github.blog/open-source/git/get-up-to-speed-with-partial-clone-and-shallow-clone/
          persist-credentials: false

      - name: Download artifact
        uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
        with:
          path: game/bin/openvic
          pattern: ${{ github.event.repository.name }}-*-extension
          merge-multiple: true

      - name: Run unit tests
        uses: godot-gdunit-labs/gdUnit4-action@e2d9e577efaa91e47930c0833c0953ad375050f8 # v1.4.1
        with:
          version: installed
          godot-version: ${{ needs.static-checks-builds.outputs.godot-version }}
          paths: 'res://tests'
          project_dir: './game/'
          arguments: ${{ runner.debug && '--verbose' || '' }}

  export-master:
    runs-on: ubuntu-latest
    needs:  [static-checks-builds, build-master]
    name: 📦 Export
    steps:
      - name: Shallow clone
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          submodules: recursive
          fetch-depth: 1 # See: https://github.blog/open-source/git/get-up-to-speed-with-partial-clone-and-shallow-clone/
          persist-credentials: false

      - name: Export game
        id: export_game
        uses: ./.github/actions/openvic-export
        with:
          godot-executable-url: ${{ needs.static-checks-builds.outputs.godot-executable-url }}
          godot-templates-url: ${{ needs.static-checks-builds.outputs.godot-templates-url }}
          archive-output: true

      - name: Upload artifact
        uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
        with:
          name: ${{ github.event.repository.name }}
          retention-days: 30
          compression-level: 9
          if-no-files-found: error
          path: |
            ${{ steps.export_game.outputs.archive-directory }}

  merge-library-files:
    name: 📚 Merge Library Files
    runs-on: ubuntu-latest
    needs: [godot-debug-checks, export-master]
    steps:
      - name: Merge Artifacts
        uses: actions/upload-artifact/merge@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
        with:
          delete-merged: true
          name: ${{ github.event.repository.name }}-extension
          pattern: ${{ github.event.repository.name }}-*-extension

  validate-master:
    name: ✅ Validate Success
    if: always()
    needs: [static-checks-builds, build-master, godot-debug-checks, godot-unit-tests, export-master, merge-library-files]
    runs-on: Ubuntu-latest
    steps:
      - name: Check
        uses: re-actors/alls-green@b5b5b37504aa4183270bd3d855c52a67f212be35
        with:
          allowed-skips: static-checks-builds, build-master, godot-debug-checks, godot-unit-tests, export-master, merge-library-files
          jobs: ${{ toJson(needs) }}