transifex-push.yml

name: Push Translations to Transifex

on:
  push:
    branches:
      - "3.15"
    paths:
      - "**/*.po"

  workflow_dispatch:
    inputs:
      push_translations:
        description: "Push Punjabi translations to Transifex"
        required: true
        type: boolean
        default: true
      po_files:
        description: "Optional: space-separated .po paths to push (empty = every .po file)"
        required: false
        type: string
        default: ""
      push_sources:
        description: "Generate and push CPython source templates"
        required: true
        type: boolean
        default: false

permissions:
  contents: read

concurrency:
  group: transifex-push-${{ github.ref }}
  cancel-in-progress: false

env:
  TX_CLI_VERSION: "1.6.16"
  TX_PROJECT: python-newest
  TX_LANGUAGE: pa
  CPYTHON_VERSION: "3.15"

jobs:
  push-translations:
    name: Push Punjabi translations
    if: github.actor != 'github-actions[bot]' && (github.event_name == 'push' || inputs.push_translations)
    runs-on: ubuntu-24.04

    steps:
      - name: Checkout translation repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
          persist-credentials: false

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

      - name: Install configuration dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y gettext
          python -m pip install requests cogapp polib transifex-python sphinx-intl blurb six

      - name: Install Transifex CLI
        shell: bash
        run: |
          set -euo pipefail

          mkdir -p "$RUNNER_TEMP/txcli"

          curl -fsSL \
            "https://github.com/transifex/cli/releases/download/v${TX_CLI_VERSION}/tx-linux-amd64.tar.gz" \
            -o "$RUNNER_TEMP/txcli/tx.tar.gz"

          tar -xzf "$RUNNER_TEMP/txcli/tx.tar.gz" -C "$RUNNER_TEMP/txcli"

          TX_BINARY="$(find "$RUNNER_TEMP/txcli" -type f -name tx -print -quit)"

          if [ -z "$TX_BINARY" ]; then
            echo "ERROR: Transifex CLI binary was not found in the archive."
            find "$RUNNER_TEMP/txcli" -maxdepth 3 -type f -print
            exit 1
          fi

          sudo install -m 0755 "$TX_BINARY" /usr/local/bin/tx
          echo "/usr/local/bin" >> "$GITHUB_PATH"

          /usr/local/bin/tx --version

      - name: Generate Transifex configuration
        run: |
          curl -fsSLO https://raw.githubusercontent.com/python-docs-translations/transifex-automations/main/sample-workflows/transifex-util.py
          chmod +x transifex-util.py

          ./transifex-util.py recreate_tx_config \
            --language "$TX_LANGUAGE" \
            --project-slug "$TX_PROJECT" \
            --version "$CPYTHON_VERSION"

      - name: Select translation files to push
        env:
          EVENT_NAME: ${{ github.event_name }}
          BEFORE_SHA: ${{ github.event.before }}
          AFTER_SHA: ${{ github.sha }}
          PO_FILES_INPUT: ${{ inputs.po_files }}
        run: |
          set -euo pipefail

          out="$RUNNER_TEMP/changed_po.txt"
          : > "$out"

          if [ "$EVENT_NAME" = "workflow_dispatch" ]; then
            if [ -n "${PO_FILES_INPUT//[[:space:]]/}" ]; then
              read -ra requested <<< "$PO_FILES_INPUT"
              printf '%s\n' "${requested[@]}" > "$out"
            else
              git ls-files '*.po' > "$out"
            fi
          elif [ "$BEFORE_SHA" != "0000000000000000000000000000000000000000" ] \
               && git cat-file -e "${BEFORE_SHA}^{commit}" 2>/dev/null; then
            git diff --name-only --diff-filter=AMR "$BEFORE_SHA" "$AFTER_SHA" -- '*.po' > "$out"
          else
            echo "Previous commit unavailable; using only the triggering commit."
            git diff-tree --root --no-commit-id --name-only -r --diff-filter=AMR "$AFTER_SHA" -- '*.po' > "$out"
          fi

          echo "Selected $(wc -l < "$out") .po file(s):"
          cat "$out"

      - name: Stage selected translations for Transifex
        id: stage
        run: |
          python - <<'PY'
          import configparser
          import os
          import re
          import shutil
          import sys
          from pathlib import Path

          language = os.environ["TX_LANGUAGE"]
          runner_temp = Path(os.environ["RUNNER_TEMP"])
          stage_root = Path("_tx_stage")

          config_path = Path(".tx/config")
          config = configparser.ConfigParser(interpolation=None)

          if not config.read(config_path, encoding="utf-8"):
              sys.exit("ERROR: .tx/config was not generated")

          # The generated file_filter has no <lang> placeholder, so the CLI
          # cannot map it to a language and silently skips the upload.
          by_file = {}

          for section in config.sections():
              if ":r:" not in section:
                  continue

              file_filter = config.get(
                  section, "file_filter", fallback=""
              ).strip()

              if file_filter:
                  by_file[os.path.normpath(file_filter)] = section

          selected = [
              line.strip()
              for line in (runner_temp / "changed_po.txt")
              .read_text(encoding="utf-8")
              .splitlines()
              if line.strip()
          ]

          section_re = re.compile(r"^o:([^:]+):p:([^:]+):r:(.+)$")
          staged = {}
          skipped = []

          for name in selected:
              rel = os.path.normpath(name)

              if (
                  os.path.isabs(rel)
                  or rel.startswith("..")
                  or not rel.endswith(".po")
              ):
                  sys.exit(f"ERROR: refusing unexpected path: {name!r}")

              section = by_file.get(rel)
              source = Path(rel)

              if section is None or not source.is_file():
                  skipped.append(rel)
                  continue

              target = stage_root / language / rel
              target.parent.mkdir(parents=True, exist_ok=True)
              shutil.copy2(source, target)

              if target.read_bytes() != source.read_bytes():
                  sys.exit(f"ERROR: staged copy differs from {rel}")

              config.set(
                  section,
                  "file_filter",
                  f"{stage_root.as_posix()}/<lang>/{Path(rel).as_posix()}",
              )

              match = section_re.match(section)

              if not match:
                  sys.exit(f"ERROR: unexpected section name: {section}")

              staged[section] = f"{match.group(2)}.{match.group(3)}"

          # Keep only the resources being pushed, so `tx push` touches
          # nothing else.
          for section in list(config.sections()):
              if ":r:" in section and section not in staged:
                  config.remove_section(section)

          for rel in skipped:
              print(
                  f"::warning::No Transifex resource or file for {rel}; skipped"
              )

          if staged:
              with config_path.open("w", encoding="utf-8") as file:
                  config.write(file)

              (runner_temp / "staged_resources.txt").write_text(
                  "\n".join(sorted(staged.values())) + "\n",
                  encoding="utf-8",
              )

          print(f"Staged {len(staged)} resource(s):")

          for resource in sorted(staged.values()):
              print(f"  {resource}")

          with open(os.environ["GITHUB_OUTPUT"], "a", encoding="utf-8") as file:
              file.write(f"count={len(staged)}\n")
          PY

      - name: Push Punjabi translations
        if: steps.stage.outputs.count != '0'
        env:
          TX_TOKEN: ${{ secrets.TX_TOKEN }}
        run: |
          set -euo pipefail

          log="$RUNNER_TEMP/tx-push.log"

          /usr/local/bin/tx push \
            --translation \
            --languages "$TX_LANGUAGE" 2>&1 | tee "$log"

          missing=0

          while IFS= read -r resource; do
            [ -n "$resource" ] || continue

            if ! grep -F "$resource [$TX_LANGUAGE]" "$log" \
                 | grep -vi 'skipping' > /dev/null; then
              echo "::error::No upload confirmation for $resource [$TX_LANGUAGE]"
              missing=1
            fi
          done < "$RUNNER_TEMP/staged_resources.txt"

          exit "$missing"

      - name: Summarize Transifex push
        if: always()
        run: |
          {
            echo "### Transifex push"

            if [ -s "$RUNNER_TEMP/staged_resources.txt" ]; then
              echo "Pushed [$TX_LANGUAGE] translations for:"
              sed 's/^/- /' "$RUNNER_TEMP/staged_resources.txt"
            else
              echo "No translation files were pushed."
            fi

            echo
            echo "A green run does not prove remote content changed; check the"
            echo "resource in Transifex. Pushed strings are not reviewed, and the"
            echo "nightly reviewed-only pull ignores unreviewed strings."
          } >> "$GITHUB_STEP_SUMMARY"

  push-sources:
    name: Generate and push source templates
    needs: push-translations
    if: ${{ always() && github.event_name == 'workflow_dispatch' && inputs.push_sources && (needs.push-translations.result == 'success' || needs.push-translations.result == 'skipped') }}
    runs-on: ubuntu-24.04

    steps:
      - name: Checkout translation repository
        uses: actions/checkout@v4
        with:
          persist-credentials: false

      - name: Checkout CPython source
        uses: actions/checkout@v4
        with:
          repository: python/cpython
          ref: "3.15"
          path: cpython
          persist-credentials: false

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

      - name: Install documentation build dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y gettext
          python -m pip install -r cpython/Doc/requirements.txt
          python -m pip install requests cogapp polib transifex-python sphinx-intl blurb six

      - name: Install Transifex CLI
        shell: bash
        run: |
          set -euo pipefail

          mkdir -p "$RUNNER_TEMP/txcli"

          curl -fsSL \
            "https://github.com/transifex/cli/releases/download/v${TX_CLI_VERSION}/tx-linux-amd64.tar.gz" \
            -o "$RUNNER_TEMP/txcli/tx.tar.gz"

          tar -xzf "$RUNNER_TEMP/txcli/tx.tar.gz" -C "$RUNNER_TEMP/txcli"

          TX_BINARY="$(find "$RUNNER_TEMP/txcli" -type f -name tx -print -quit)"

          if [ -z "$TX_BINARY" ]; then
            echo "ERROR: Transifex CLI binary was not found in the archive."
            find "$RUNNER_TEMP/txcli" -maxdepth 3 -type f -print
            exit 1
          fi

          sudo install -m 0755 "$TX_BINARY" /usr/local/bin/tx
          echo "/usr/local/bin" >> "$GITHUB_PATH"

          /usr/local/bin/tx --version

      - name: Generate gettext source templates
        run: |
          make -C cpython/Doc gettext
          test -d cpython/Doc/build/gettext
          mkdir -p gettext
          cp -a cpython/Doc/build/gettext/. gettext/

      - name: Generate Transifex configuration
        run: |
          curl -fsSLO https://raw.githubusercontent.com/python-docs-translations/transifex-automations/main/sample-workflows/transifex-util.py
          chmod +x transifex-util.py

          ./transifex-util.py recreate_tx_config \
            --language "$TX_LANGUAGE" \
            --project-slug "$TX_PROJECT" \
            --version "$CPYTHON_VERSION"

      - name: Validate configured source templates
        run: |
          python - <<'PY'
          import configparser
          from pathlib import Path

          path = Path(".tx/config")
          config = configparser.ConfigParser(interpolation=None)

          if not path.is_file() or not config.read(path):
              raise SystemExit("ERROR: .tx/config was not generated")

          missing = []

          for section in config.sections():
              source = config.get(
                  section, "source_file", fallback=""
              ).strip()

              if source and not Path(source).is_file():
                  missing.append(f"{section}: {source}")

          if missing:
              print("Missing source templates:")
              print("\n".join(missing))
              raise SystemExit(1)

          print("All configured source templates exist.")
          PY

      - name: Push source templates
        env:
          TX_TOKEN: ${{ secrets.TX_TOKEN }}
        run: |
          /usr/local/bin/tx push --source --skip