pofiles.yml

name: Update English PO files for translation

on:
  push:
    branches:
      - release_3.34
    paths:
      - 'docs/**'

  workflow_dispatch:

permissions:  # added using https://github.com/step-security/secure-repo
  contents: read

jobs:
  prepare_translation:

    permissions:
      contents: write  # for stefanzweifel/git-auto-commit-action to push code in repo
    if: github.repository_owner == 'qgis'
    runs-on: ubuntu-latest

    steps:
    - name: Harden Runner
      uses: step-security/harden-runner@a4aa98b93cab29d9b1101a6143fb8bce00e2eac4 # v2.7.1
      with:
        egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs

    - name: checkout
      uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
      with:
        ref: release_3.34

    - name: Set up Python 3.11
      uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5.1.0
      with:
        python-version: '3.11'

    - name: Install dependencies
      run: |
          python -m pip install --upgrade pip
          pip install sphinx sphinx-intl sphinxext.rediraffe pyYAML sphinx_togglebutton sphinx_copybutton

    - name: Generate English PO files
      id: "generate-po-files"
      run: |
          make gettext
          sphinx-intl update -p build/gettext -l en
          # Remove obsolete strings from the generated *.po files
          find locale/en/LC_MESSAGES/docs/ -type f -name '*.po' -exec sed -i '/^#~ /,/^$/d' {} \;

    - name: Commit the changes in the PO files      
      id: "auto-commit-action"
      uses: stefanzweifel/git-auto-commit-action@8621497c8c39c72f3e2a999a26b4ca1b5058a842 # v5.0.1
      with:
        commit_message: Update English PO files

    - name: "Inform that changes have been made"
      if: steps.auto-commit-action.outputs.changes_detected == 'true'
      run: echo "Changes committed!"

    - name: "Inform that no changes were performed"
      if: steps.auto-commit-action.outputs.changes_detected == 'false'
      run: echo "No Changes detected!"