sync.yml

name: Sync

on:
  workflow_call:
    inputs:
      version:
        description: "Branch name corresponding to a Python version"
        required: true
        type: string
      tx_project:
        description: "Name of the Transifex translation project"
        required: true
        type: string
    secrets:
      TX_TOKEN:
        description: "Token required for interacting with Transifex API"
        required: false

env:
  PYDOC_LANGUAGE: pt_BR
  PYDOC_TX_PROJECT: ${{ inputs.tx_project }}
  PYDOC_VERSION: ${{ inputs.version }}
  TX_CLI_VERSION: '1.6.17'

jobs:
  sync:
    runs-on: ubuntu-latest
    steps:

      # 1- Set up environment

      - name: Check out this repository
        uses: actions/checkout@v4

      - name: Checkout CPython ${{ env.PYDOC_VERSION }}
        uses: actions/checkout@v4
        with:
          repository: 'python/cpython'
          ref: ${{ env.PYDOC_VERSION }}
          path: cpython
          
      - name: Set language dir variable
        run:
          echo "LANGUAGE_DIR=cpython/Doc/locales/${{ env.PYDOC_LANGUAGE }}/LC_MESSAGES" >> $GITHUB_ENV

      - name: Checkout this repository ${{ env.PYDOC_VERSION }}
        uses: actions/checkout@v4
        with:
          ref: ${{ env.PYDOC_VERSION }}
          path: ${{ env.LANGUAGE_DIR }}

      - uses: actions/setup-python@v5
        with:
          python-version: ${{ inputs.version }}
          allow-prereleases: true
          cache: 'pip'
          cache-dependency-path: |
            requirements.txt
            cpython/Doc/requirements.txt

      - name: Check for Transifex API Token availability
        id: secret-check
        # perform secret check & put boolean result as an output
        shell: bash
        run: |
          available=false
          [[ "${{ secrets.TX_TOKEN }}" != '' ]] && available=true
          echo "available=$available" >> $GITHUB_OUTPUT
          echo "available=$available"

      # 2- Install dependencies

      - name: Install Transifex CLI tool
        run: |
          cd /usr/local/bin
          curl -o- https://raw.githubusercontent.com/transifex/cli/master/install.sh | bash -s -- v$TX_CLI_VERSION

      - name: Install APT dependencies
        run: sudo apt update -y && sudo apt install gettext -y

      - name: Install Python dependencies
        run: |
          pip install -r requirements.txt
          make -C cpython/Doc venv

      # 3- Pull translations

      - name: Generate template files and Transifex config file
        run: ./scripts/generate_templates.sh

      - name: Pull translations from Transifex
        id: pull
        if: ${{ contains(fromJSON('["schedule", "workflow_dispatch"]'), github.event_name) }}
        run: |
          # Clean up obsolete files
          find ./${{ env.LANGUAGE_DIR }} -name '*.po' -exec rm {} \;
          ./scripts/pull_translations.sh
        env:
          TX_TOKEN: ${{ secrets.TX_TOKEN }}

      - name: Merge translations from newer branch
        if: inputs.tx_project != 'python-newest' # python-newest doesn't have a newer branch
        run: |
          newer_branch=${PYDOC_VERSION%%.*}.$((${PYDOC_VERSION##*.}+1))
          git clone --depth 1 --single-branch --branch $newer_branch https://github.com/python/python-docs-pt-br ${newer_branch}-dir
          pomerge --from ./${newer_branch}-dir/{**/,}*.po --to ./${{ env.LANGUAGE_DIR }}/{**/,}*.po
          rm -rf ./${newer_branch}-dir

      - name: powrap
        if: steps.pull.outcome == 'success'
        run: |
          cd ./${{ env.LANGUAGE_DIR }}
          powrap *.po **/*.po

      - name: Update statistics
        if: always() && steps.secret-check.outputs.available == 'true'
        run: |
          python ./scripts/tx_stats.py > ./${{ env.LANGUAGE_DIR }}/stats.json
          git -C ./${{ env.LANGUAGE_DIR }} diff stats.json
        env:
          TX_TOKEN: ${{ secrets.TX_TOKEN }}

      - name: Update potodo.md
        if: always()
        run: |
          ./scripts/potodo.sh
          git diff ./${{ env.LANGUAGE_DIR }}/potodo.md

      # 4- Commit and push translations

      - name: Commit
        run: ./scripts/commit.sh

      - name: Push
        if: ${{ contains(fromJSON('["schedule", "workflow_dispatch"]'), github.event_name) }}
        run: |
          cd ./${{ env.LANGUAGE_DIR }}
          git push