pr-checks.yml

name: PR Checks

on:
  pull_request:
    branches:
      - main
      - v*.*.x

permissions:
  actions: write
  pull-requests: write

jobs:
  check_translations:
    runs-on: ubuntu-latest

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

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: 3.13

      - name: Install Poetry
        uses: snok/install-poetry@v1
        with:
          version: 1.8.5

      - name: Install dependencies
        run: poetry install

      - name: Run translation check script
        run: poetry run python .scripts/missing_translation_check.py

      - name: Check for Hard-coded strings
        run: poetry run python .scripts/hardcode_string_check.py

      - name: Run missing locale keys script
        run: poetry run python .scripts/check_for_missing_locale_keys.py

  run_tests:
    runs-on: ubuntu-latest

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

      - uses: leafo/gh-actions-lua@v10
        with:
          luaVersion: 5.3.5

      - uses: leafo/gh-actions-luarocks@v4
        with:
          luarocksVersion: 3.11.1

      - name: Install luarock dependencies
        run: luarocks make --local rpglootfeed-1-1.rockspec

      - name: Run Tests
        run: make test-ci

      - uses: actions/upload-artifact@v4
        with:
          name: luacov-html
          path: luacov-html/

  test_package:
    runs-on: ubuntu-latest
    env:
      IS_FORK: ${{ github.event.pull_request.head.repo.fork }}

    steps:
      - name: Checkout code
        if: env.IS_FORK == 'false'
        uses: actions/checkout@v4
        with:
          ref: ${{ github.event.pull_request.head.ref }}
          fetch-depth: 0

      - name: Checkout code (fork)
        if: env.IS_FORK == 'true'
        uses: actions/checkout@v4

      - uses: awalsh128/cache-apt-pkgs-action@latest
        with:
          packages: subversion
          version: test_package_apt_cache

      - name: Package
        if: env.IS_FORK == 'false'
        uses: BigWigsMods/packager@v2
        with:
          args: -d
          pandoc: "false"

      - name: Package (fork)
        if: env.IS_FORK == 'true'
        uses: BigWigsMods/packager@v2
        with:
          args: -d -n {package-name}-pr${{github.event.number}}-{nolib}{classic}
          pandoc: "false"

      - name: Capture Filenames
        id: capture-filenames
        run: |
          FILE1=$(ls .release/RPGLootFeed-*-nolib.zip)
          FILE2=$(ls .release/RPGLootFeed-*.zip | grep -v 'nolib')
          echo "FILE1=$FILE1" >> $GITHUB_ENV
          echo "FILE2=$FILE2" >> $GITHUB_ENV

      - name: Upload RPGLootFeed ZIP
        uses: actions/upload-artifact@v4
        id: upload-zips-standard
        with:
          name: pr-pkg
          path: ${{ env.FILE2 }}

      - name: Upload RPGLootFeed Nolib ZIP
        uses: actions/upload-artifact@v4
        id: upload-zips-nolib
        with:
          name: pr-pkg-nolib
          path: ${{ env.FILE1 }}

      - name: Post PR comment
        if: env.IS_FORK == 'false'
        uses: actions/github-script@v7
        with:
          script: |
            const commentIdentifier = "### Packaged ZIP files"; // Unique phrase to identify the comment
            const linkStandard = `[RPGLootFeed ZIP (with libs)](${{ steps['upload-zips-standard'].outputs.artifact-url }})`;
            const linkNolib = `[RPGLootFeed ZIP (nolib)](${{ steps['upload-zips-nolib'].outputs.artifact-url }})`;
            const lastUpdated = new Date().toLocaleString('en-US', { timeZone: 'UTC', hour12: true });
            const commentBody = `${linkStandard}\n${linkNolib}\n\nLast Updated: ${lastUpdated} (UTC)`;

            const { data: comments } = await github.rest.issues.listComments({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
            });

            const existingComment = comments.find(comment => comment.body.includes(commentIdentifier));

            if (existingComment) {
              // Update the existing comment
              await github.rest.issues.updateComment({
                comment_id: existingComment.id,
                owner: context.repo.owner,
                repo: context.repo.repo,
                body: `${commentIdentifier}\n${commentBody}`
              });
            } else {
              // Create a new comment
              await github.rest.issues.createComment({
                issue_number: context.issue.number,
                owner: context.repo.owner,
                repo: context.repo.repo,
                body: `${commentIdentifier}\n${commentBody}`
              });
            }

  all_pr_checks:
    name: Passing PR Checks
    runs-on: ubuntu-latest
    needs: [check_translations, run_tests, test_package]
    steps:
      - name: Export needs results as JSON
        id: export-needs
        run: echo '${{ toJSON(needs) }}' > needs.json

      - name: Check if all jobs passed or were skipped
        run: |
          needs=$(cat needs.json)
          for job in $(echo "$needs" | jq -r 'keys[]'); do
            result=$(echo "$needs" | jq -r ".\"$job\".result")
            if [[ "$result" != "success" && "$result" != "skipped" ]]; then
              echo "Job $job failed."
              exit 1
            fi
          done
          echo "All jobs passed or were skipped."
        shell: bash