Use Babel errors for the PR body in the transifex workflow (#12562)

Currently, when Babel fails for a locale, the entire PR fails.
Instead, just skip compiling the catalogue for that locale, and report the failures in the body of the PR to be more visible.

Author: AA-Turner

.github/workflows/transifex.yml

@@ -31,7 +31,7 @@ jobs:
       run: python utils/babel_runner.py extract
     - name: Push translations to transifex.com
       run: |
-        cd sphinx/locale 
+        cd sphinx/locale
         /tmp/tx_cli/tx push --source --use-git-timestamps --workers 10
       env:
         TX_TOKEN: ${{ secrets.TX_TOKEN }}
@@ -60,7 +60,7 @@ jobs:
       run: python utils/babel_runner.py extract
     - name: Pull translations from transifex.com
       run: |
-        cd sphinx/locale 
+        cd sphinx/locale
         /tmp/tx_cli/tx pull --translations --all --force --use-git-timestamps --workers 10
       env:
         TX_TOKEN: ${{ secrets.TX_TOKEN }}
@@ -73,3 +73,4 @@ jobs:
         branch: bot/pull-translations
         title: "[bot]: Update message catalogues"
         labels: "internals:internationalisation"
+        body-path: babel_compile.txt

utils/babel_runner.py

@@ -31,6 +31,7 @@
 from babel.util import pathmatch
 from jinja2.ext import babel_extract as extract_jinja2
 
+IS_CI = 'CI' in os.environ
 ROOT = os.path.realpath(os.path.join(os.path.abspath(__file__), '..', '..'))
 TEX_DELIMITERS = {
     'variable_start_string': '<%=',
@@ -185,11 +186,10 @@ def run_compile() -> None:
             log.info('catalog %s is marked as fuzzy, skipping', po_file)
             continue
 
+        locale_errors = 0
         for message, errors in catalog.check():
-            if locale not in total_errors:
-                total_errors[locale] = 0
             for error in errors:
-                total_errors[locale] += 1
+                locale_errors += 1
                 log.error(
                     'error: %s:%d: %s\nerror:     in message string: %r',
                     po_file,
@@ -198,6 +198,11 @@ def run_compile() -> None:
                     message.string,
                 )
 
+        if locale_errors:
+            total_errors[locale] = locale_errors
+            log.info('%d errors encountered in %r locale, skipping', locale_errors, locale)
+            continue
+
         mo_file = os.path.join(directory, locale, 'LC_MESSAGES', 'sphinx.mo')
         log.info('compiling catalog %s to %s', po_file, mo_file)
         with open(mo_file, 'wb') as outfile:
@@ -229,17 +234,13 @@ def run_compile() -> None:
             # to ensure lines end with ``\n`` rather than ``\r\n``:
             outfile.write(f'Documentation.addTranslations({obj});'.encode())
 
-    if 'ta' in total_errors:
-        # Tamil is a known failure.
-        err_count = total_errors.pop('ta')
-        log.error('%d errors encountered in %r locale.', err_count, 'ta')
-
-    if len(total_errors) > 0:
+    if total_errors:
+        _write_pr_body_line('## Babel catalogue errors')
+        _write_pr_body_line('')
         for locale, err_count in total_errors.items():
-            log.error('%d errors encountered in %r locale.', err_count, locale)
-        log.error('%d errors encountered.', sum(total_errors.values()))
-        print('Compiling failed.', file=sys.stderr)
-        raise SystemExit(2)
+            log.error('error: %d errors encountered in %r locale.', err_count, locale)
+            s = 's' if err_count != 1 else ''
+            _write_pr_body_line(f'* {locale}: {err_count} error{s}')
 
 
 def _get_logger():
@@ -251,6 +252,13 @@ def _get_logger():
     return log
 
 
+def _write_pr_body_line(message: str) -> None:
+    if not IS_CI:
+        return
+    with open('babel_compile.txt', 'a', encoding='utf-8') as f:
+        f.write(f'{message}\n')
+
+
 if __name__ == '__main__':
     try:
         action = sys.argv[1].lower()