Improve Crowdin localization workflow with intelligent MD/XLIFF handling

.github/scripts/checkTranslation.py

@@ -0,0 +1,175 @@
+import sys
+import os
+import xml.etree.ElementTree as ET
+import polib
+import langid
+
+def normalize(s: str | None) -> str:
+	return " ".join((s or "").strip().lower().split())
+
+# -----------------------------
+# PO CHECK
+# -----------------------------
+
+def checkPo(path: str) -> float:
+	po = polib.pofile(path)
+	translated = 0
+	total = 0
+
+	for entry in po:
+		if not entry.msgid.strip():
+			continue
+
+		total += 1
+
+		if entry.msgstr and normalize(entry.msgstr) != normalize(entry.msgid):
+			translated += 1
+
+	return translated / total if total else 0.0
+
+# -----------------------------
+# XLIFF CHECK
+# -----------------------------
+
+def checkXliff(path: str) -> float:
+	tree = ET.parse(path)
+	root = tree.getroot()
+	translated = 0
+	total = 0
+	source = None
+
+	for elem in root.iter():
+		if elem.tag.endswith("source"):
+			source = normalize(elem.text)
+
+		elif elem.tag.endswith("target"):
+			target = normalize(elem.text)
+
+			if source:
+				total += 1
+				if target and target != source:
+					translated += 1
+
+	return translated / total if total else 0.0
+
+# -----------------------------
+# MD LANGUAGE SCORE (langid)
+# -----------------------------
+
+def scoreMd(path: str, expected_lang: str) -> float:
+	try:
+		with open(path, "r", encoding="utf-8") as f:
+			text = f.read()
+	except Exception:
+		return 0.0
+
+	if not text.strip():
+		return 0.0
+
+	lang, score = langid.classify(text)
+
+	# Normalize score into positive confidence
+	confidence = 1 / (1 + abs(score))
+
+	if lang == expected_lang:
+		return confidence
+	else:
+		return 0.0
+
+# -----------------------------
+# COMPARE MULTIPLE MD FILES
+# -----------------------------
+
+def compareMd(files: list[str], lang: str):
+	results = []
+
+	for f in files:
+		if not os.path.exists(f):
+			continue
+
+		score = scoreMd(f, lang)
+		results.append((f, score))
+
+	if not results:
+		print("winner=None")
+		sys.exit(1)
+
+	results.sort(key=lambda x: x[1], reverse=True)
+
+	winner = results[0]
+
+	print("comparison_results:")
+	for f, s in results:
+		print(f"{f}={s}")
+
+	print(f"winner={winner[0]}")
+	print(f"winner_score={winner[1]}")
+
+	sys.exit(0)
+
+# -----------------------------
+# MAIN
+# -----------------------------
+
+def main():
+	if len(sys.argv) < 2:
+		print("Usage:")
+		print("  checkTranslation.py <file>")
+		print("  checkTranslation.py <file> <lang>")
+		print("  checkTranslation.py <file1> <file2> [...] <lang>")
+		sys.exit(2)
+
+	args = sys.argv[1:]
+
+	# -------------------------
+	# MULTI FILE MODE
+	# -------------------------
+	if len(args) >= 3:
+		*files, lang = args
+		compareMd(files, lang)
+		return
+
+	path = args[0]
+
+	if not os.path.exists(path):
+		print(f"File not found: {path}")
+		sys.exit(2)
+
+	ext = os.path.splitext(path)[1].lower()
+
+	# -------------------------
+	# PO
+	# -------------------------
+	if ext == ".po":
+		ratio = checkPo(path)
+		print(f"translation_ratio={ratio}")
+		sys.exit(0 if ratio > 0.05 else 1)
+
+	# -------------------------
+	# XLIFF
+	# -------------------------
+	elif ext in [".xliff", ".xlf"]:
+		ratio = checkXliff(path)
+		print(f"translation_ratio={ratio}")
+		sys.exit(0 if ratio > 0.05 else 1)
+
+	# -------------------------
+	# MD (LANG SCORE)
+	# -------------------------
+	elif ext == ".md":
+		if len(args) < 2:
+			print("Missing language argument for MD scoring")
+			sys.exit(2)
+
+		lang = args[1]
+		score = scoreMd(path, lang)
+
+		print(f"md_score={score}")
+		sys.exit(0)
+
+	else:
+		print(f"Unsupported file type: {ext}")
+		sys.exit(2)
+
+if __name__ == "__main__":
+	main()

.github/scripts/setOutputs.py

@@ -0,0 +1,21 @@
+# Copyright (C) 2025 NV Access Limited, Noelia Ruiz Martínez
+# This file is covered by the GNU General Public License.
+# See the file COPYING for more details.
+
+import os
+import sys
+
+sys.path.insert(0, os.getcwd())
+import buildVars
+
+
+def main():
+	addonId = buildVars.addon_info["addon_name"]
+	name = "addonId"
+	value = addonId
+	with open(os.environ["GITHUB_OUTPUT"], "a") as f:
+		_ = f.write(f"{name}={value}\n")
+
+
+if __name__ == "__main__":
+	main()

.github/workflows/build_addon.yml

@@ -10,42 +10,48 @@ on:
     branches: [ main, master ]
 
   workflow_dispatch:
+  workflow_call:
 
 jobs:
   build:
+    # Building the add-on template as an add-on does not make sense (and fails).
+    # Do not modify this repo name with your own one! (should remain the template)
+    if: github.repository != 'nvaccess/addonTemplate'
 
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v5
-
-    - run: echo -e "pre-commit\nscons\nmarkdown">requirements.txt
-
-    - name: Set up Python
-      uses: actions/setup-python@v6
+    - name: Checkout repo
+      uses: actions/checkout@v6
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
       with:
-        python-version: 3.11
-        cache: 'pip'
-
+        enable-cache: true
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip wheel
-        pip install -r requirements.txt
         sudo apt-get update  -y
         sudo apt-get install -y gettext
+        uv sync
 
     - name: Code checks
-      run: export SKIP=no-commit-to-branch; pre-commit run --all
+      run: export SKIP=no-commit-to-branch; uv run pre-commit run --all-files
 
     - name: building addon
-      run: scons && scons pot
+      run: uv run scons && uv run scons pot
 
-    - uses: actions/upload-artifact@v5
+    - uses: actions/upload-artifact@v7
       with:
         name: packaged_addon
         path: |
           ./*.nvda-addon
+        archive: false
+
+    - uses: actions/upload-artifact@v7
+      with:
+        name: translation_template
+        path: |
           ./*.pot
+        archive: false
 
   upload_release:
     runs-on: ubuntu-latest
@@ -54,9 +60,12 @@ jobs:
     permissions:
       contents: write
     steps:
-    - uses: actions/checkout@v5
-    - name: download releases files
-      uses: actions/download-artifact@v6
+    - uses: actions/checkout@v6
+    - name: download all artifacts
+      uses: actions/download-artifact@v8
+      with:
+        path: .
+        merge-multiple: true
     - name: Display structure of downloaded files
       run: ls -R
     - name: Calculate sha256
@@ -65,7 +74,7 @@ jobs:
         sha256sum *.nvda-addon >> changelog.md
 
     - name: Release
-      uses: softprops/action-gh-release@v2
+      uses: softprops/action-gh-release@v3
       with:
         files: |
           *.nvda-addon