pofiles.yml

name: Update English PO files for translation

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

  schedule: #run at 02:00 UTC on Wednesday
    - cron:  '00 02 * * 03'

  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@03bee3930647ebbf994244c21ddbc0d4933aab4f # v2.3.0
      with:
        egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs

    - name: checkout
      uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2
      with:
        ref: release_3.28

    - name: Set up Python 3.9
      uses: actions/setup-python@d27e3f3d7c64b4bbf8e4abfb9b63b83e846e0435 # v4.5.0
      with:
        python-version: 3.9

    - 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@3ea6ae190baf489ba007f7c92608f33ce20ef04a # v4.16.0
      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!"