ExportGodot.yaml

# Export desktop and web builds, publish them to itch.io, and deploy the web build.
name: "Export Godot"

on:
  workflow_dispatch:
  push:
    branches:
      - release
      - staging

permissions:
  contents: read

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

env:
  BUILD_GIT_COMMIT: ${{ github.sha }}
  BUILD_GIT_BRANCH: ${{ github.ref_name }}

jobs:
  # This setup job runs only once and first to prepare the environment to avoid
  # downloading Godot and the export templates multiple times.
  setup:
    name: Setup environment
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v7.0.1
        with:
          lfs: false

      - name: Restore build downloads
        uses: actions/cache@v6.1.0
        with:
          path: .cache/build-downloads
          key: export-build-downloads-${{ runner.os }}-${{ hashFiles('.env') }}

      - name: Prepare CI environment
        run: python3 build.py prepare ci

      - name: Upload prepared source
        uses: actions/upload-artifact@v7.0.1
        with:
          name: prepared-source
          path: |
            .
            !.git
            !.cache
          retention-days: 1
          include-hidden-files: true

  export:
    name: Export ${{ matrix.platform }}
    needs: setup
    runs-on: ubuntu-latest
    permissions:
      contents: read
    strategy:
      fail-fast: false
      matrix:
        platform: ${{ fromJSON(github.ref_name == 'release' && '["linux", "windows", "osx", "web"]' || '["web"]') }}

    steps:
      - name: Download prepared source
        uses: actions/download-artifact@v8.0.1
        with:
          name: prepared-source

      - name: Set up export tools
        run: |
          chmod +x godot_server.x86_64
          chmod +x butler
          echo "GODOT_TEMPLATES_DIR=$PWD/templates" >> $GITHUB_ENV

      - name: Export for ${{ matrix.platform }}
        run: python3 build.py export ${{ matrix.platform }}

      - name: Push to itch.io
        if: github.ref_name == 'release' || github.ref_name == 'staging'
        env:
          BUTLER_API_KEY: ${{ secrets.BUTLER_API_KEY }}
          ITCHIO_USERNAME: ${{ secrets.ITCHIO_USERNAME }}
          ITCHIO_GAME: ${{ secrets.ITCHIO_GAME }}
        run: python3 build.py push ${{ matrix.platform }}

      - name: Upload release artifact
        if: github.ref_name == 'release'
        uses: actions/upload-artifact@v7.0.1
        with:
          name: build-${{ matrix.platform }}
          path: build/${{ matrix.platform }}
          retention-days: 1

      - name: Upload staging artifact
        if: github.ref_name == 'staging'
        uses: actions/upload-artifact@v7.0.1
        with:
          name: build-${{ matrix.platform }}
          path: build/${{ matrix.platform }}/${{ github.ref_name }}
          retention-days: 1

  deploy-pages:
    name: Deploy web build to GitHub Pages
    if: github.ref_name == 'release' || github.ref_name == 'staging'
    needs: export
    runs-on: ubuntu-latest
    permissions:
      contents: write
    environment:
      name: github-pages
    steps:
      - name: Checkout
        uses: actions/checkout@v7.0.1
        with:
          lfs: false

      - name: Download web artifact
        uses: actions/download-artifact@v8.0.1
        with:
          name: build-web
          path: build/web

      - name: Deploy release web build
        if: github.ref_name == 'release'
        # 4.8.0 pinned commit
        uses: JamesIves/github-pages-deploy-action@d92aa235d04922e8f08b40ce78cc5442fcfbfa2f
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          branch: gh-pages
          folder: build/web
          target-folder: ''
          clean: false

      - name: Deploy staging web build
        if: github.ref_name == 'staging'
        uses: JamesIves/github-pages-deploy-action@d92aa235d04922e8f08b40ce78cc5442fcfbfa2f
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          branch: gh-pages
          folder: build/web
          target-folder: staging
          clean: false

  publish:
    name: Publish builds
    if: github.ref_name == 'release' || github.ref_name == 'staging'
    needs: export
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - name: Download builds
        uses: actions/download-artifact@v8.0.1
        with:
          pattern: build-*
          path: ${{ runner.temp }}/builds

      - name: Upload GitHub release assets
        if: github.ref_name == 'release'
        env:
          GH_TOKEN: ${{ github.token }}
          GH_REPO: ${{ github.repository }}
        # Updates a single latest release for each platform.
        run: |
          for platform in linux windows osx web; do
            gh release view "$platform" > /dev/null 2>&1 || \
              gh release create "$platform" --target "$GITHUB_SHA" --title "$platform" --notes ""
            gh release upload "$platform" "$RUNNER_TEMP/builds/build-$platform"/* --clobber
          done