validate-translation-files.yml

# Validate the po files to ensure translation files are compilable.

name: Validate translation PO files

on:
  - pull_request

jobs:
  validate-po-files:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write
    steps:
      # Define .po filepaths, so we can skip this action unless a .po
      # file has been modified in this diff
      - uses: dorny/paths-filter@v2
        id: filter
        with:
          filters: |
            pofiles:
              - '**.po'

      # Clones the openedx-translations repo
      - name: clone openedx/openedx-translations
        if: steps.filter.outputs.pofiles == 'true'
        uses: actions/checkout@v3

      - name: Install gettext
        if: steps.filter.outputs.pofiles == 'true'
        run: |
          sudo apt install -y gettext

      - name: setup python
        if: steps.filter.outputs.pofiles == 'true'
        uses: actions/setup-python@v4
        id: setup_python
        with:
          python-version: '3.11'
          cache: pip
          cache-dependency-path: |
            requirements/translations.txt

      - name: Install requirements
        if: steps.filter.outputs.pofiles == 'true'
        run: |
          python --version
          make translations_scripts_requirements

      - name: Validate translation files
        id: validate_translation_files
        if: steps.filter.outputs.pofiles == 'true'
        run: |
          has_validation_errors=0
          python scripts/validate_translation_files.py 2>validation_errors.txt || has_validation_errors=1
          cat validation_errors.txt

          {
            echo 'VALIDATION_ERRORS<<EOF'
            fold -w 100 -s validation_errors.txt
            echo EOF
          } >> "$GITHUB_OUTPUT"

          exit $has_validation_errors

      - name: Post translation validation results as a comment
        # Due to GitHub Actions security reasons posting a comment isn't possible on fork pull requests.
        # This shouldn't be an issue, because bots writes directly to this repository.
        if: ${{ always() && !github.event.pull_request.head.repo.fork }}
        uses: mshick/add-pr-comment@b8f338c590a895d50bcbfa6c5859251edc8952fc
        with:
          message: |
            :white_check_mark: All translation files are valid.

            This comment has been posted by the `validate-translation-files.yml` GitHub Actions workflow.

          message-failure: |
            :warning: There are errors in the translation files:

            ```
            ${{ steps.validate_translation_files.outputs.VALIDATION_ERRORS || 'No errors were reported.' }}
            ```

            This comment has been posted by the `validate-translation-files.yml` GitHub Actions workflow.