feat: Add translation tag checker for issue #1102 #1997

immortal71 · 2026-01-02T05:08:03Z

Description

This PR implements a comprehensive translation tag checker to address issue #1102. The solution automatically validates that translation files contain all the same T0xxx tags as the English version, and detects common translation issues.

Changes Made

1. Translation Checker Script (`scripts/check_translations.py`)

Parses English card YAML files and extracts all T0xxx tags
Compares each translation file against the English reference
Detects three types of issues:
- Missing tags: Tags present in English but absent in translation
- Untranslated tags: Tags with identical text to English (not translated)
- Empty tags: Tags with no text content
Generates a comprehensive Markdown report grouped by language and file

2. Automated Tests (`tests/scripts/test_translation_tags.py`)

Integration tests to validate translation completeness
Tests for duplicate tags in English files
Tag format validation (T0xxxx pattern)
Ensures all translation files are checked systematically

3. GitHub Actions Integration

Pull Request Workflow (`run-tests-generate-output.yaml`)

Runs translation checker on every PR
Uploads report as artifact
Downloads and reads the report
Posts full translation report directly in PR comments
Makes it easy to spot translation issues during review

Pre-Release Workflow (`pre-release.yml`)

Runs translation checker before each release
Includes translation report in the release body via body_path
Provides visibility into translation status for releases

How It Works

For Pull Requests: When source files change, the workflow:
- Runs the translation checker
- Generates a Markdown report
- Downloads the report artifact
- Posts the report content as a comment on the PR
For Pre-Releases: On master branch pushes:
- Runs the translation checker
- Includes the report in the release description
- Helps track translation progress across releases

Example Output

# Translation Check Report

# Spanish
**File:** `webapp-cards-2.2-es.yaml`

~Missing Tags
T00145, T00162

~ Untranslated Tags
T00005

~Empty Tags
(none)

Testing

All tests pass locally:

pytest tests/scripts/test_translation_tags.py -v
# 6 passed in 4.84s

The script correctly identifies translation issues and generates readable reports.

Copilot Review Feedback Addressed

[x] Fixed language code mappings (no-nb, pt-br, pt-pt instead of underscores)
[x] Removed unused imports (os, Set, Tuple)
[x] All Copilot feedback for translation checker files addressed

Benefits

[x] Automatically catches missing translations before release
[x] Identifies untranslated content (identical to English)
[x] Detects empty tag values
[x] Works seamlessly with existing CI/CD pipelines
[x] Provides clear, actionable reports for translators
[x] Zero manual intervention required

Related Issue

Closes #1102

--> Add check_translations.py script to detect missing, untranslated, and empty T0xxx tags --> Added comprehensive pytest tests for translation validation --> Updatd run-tests-generate-output.yaml to run checker and include report in PR comments --> Updated pre-release.yml to include translation report in release body --> Resolved missing tag detection as requested in OWASP#1102

…e unused imports

Copilot

Pull request overview

This PR adds a translation tag checker to validate that translation files contain all the same T0xxx tags as English versions, addressing issue #1102. The implementation includes a Python script for tag validation, integration tests, and GitHub Actions workflow integration for automated checking on PRs and pre-releases.

Key Changes:

New translation checker script that validates tag completeness across all language files
Automated test suite with 6 tests covering tag validation, format checking, and duplicate detection
GitHub Actions integration to post translation reports as PR comments and include them in pre-release notes

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 8 comments.

File	Description
`scripts/check_translations.py`	Core translation checker that extracts T0xxx tags from YAML files and compares translations against English reference
`tests/scripts/test_translation_tags.py`	Integration tests validating translation completeness, tag format (T0xxxx pattern), and duplicate detection
`.github/workflows/run-tests-generate-output.yaml`	Runs translation checker on PRs, uploads report as artifact, and posts results as PR comment
`.github/workflows/pre-release.yml`	Integrates translation check into pre-release workflow and includes report in release body

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

scripts/check_translations.py

tests/scripts/test_translation_tags.py

.github/workflows/pre-release.yml

tests/scripts/test_translation_tags.py

.github/workflows/run-tests-generate-output.yaml

scripts/check_translations.py

tests/scripts/test_translation_tags.py

immortal71 · 2026-01-02T05:34:04Z

@sydseter I addressed the feedback and updated the PR. If anything still looks off, please point it out and I’ll fix it promptly.

scripts/check_translations.py

tests/scripts/test_translation_tags.py

scripts/check_translations_itest.py

sydseter · 2026-01-08T09:18:04Z

scripts/check_translations_itest.py

+    def setUp(self):
+        """Set up test fixtures."""
+        # Navigate up from tests/scripts to cornucopia root
+        self.base_path = Path(__file__).parent.parent.parent


Set it to read from this dir: https://github.com/OWASP/cornucopia/tree/master/tests/test_files
And create mock yaml files there that you can test against. There are some there already, but you should create a new translation file that verifies that the script can indeed find translation issues.

I will look into this

This still need to be done.

Is still not done for: check_translations_itest.py

.github/workflows/run-tests-generate-output.yaml

immortal71 · 2026-01-22T17:45:06Z

@sydseter sorry for not notifying you fast (2 week ago), I had already implemented everything you suggested can you check the pr and tell me if its good to go or I need to do some other changes !!

scripts/check_translations.py

tests/scripts/test_translation_tags.py

sydseter · 2026-01-29T15:02:55Z

@immortal71 look at my comments and please merge in the latest changes from master before continuing.

sydseter · 2026-01-29T15:12:56Z

Please update your branch against master before continuing

…eck-clean

…fy mock files work correctly

immortal71 · 2026-01-31T12:36:44Z

@sydseter
done, can you review it !!

sydseter · 2026-02-03T11:49:55Z

scripts/check_translations_itest.py

+    def setUp(self):
+        """Set up test fixtures."""
+        # Navigate up from tests/scripts to cornucopia root
+        self.base_path = Path(__file__).parent.parent.parent


This still need to be done.

sydseter · 2026-02-03T11:51:26Z

scripts/check_translations_itest.py

+    def setUp(self):
+        """Set up test fixtures."""
+        # Navigate up from tests/scripts to cornucopia root
+        self.base_path = Path(__file__).parent.parent.parent


Is still not done for: check_translations_itest.py

sydseter · 2026-02-03T11:56:23Z

convert_utest.py is failing

sydseter · 2026-02-03T11:56:44Z

Remember to run all tests before pushing the result

immortal71 added 2 commits January 1, 2026 21:05

fixed: Address Copilot review feedback - fix language codes and remov…

d6b3263

…e unused imports

Copilot AI review requested due to automatic review settings January 2, 2026 05:08

immortal71 requested review from cw-owasp, rewtd and sydseter as code owners January 2, 2026 05:08

Copilot started reviewing on behalf of immortal71 January 2, 2026 05:08 View session

Copilot AI reviewed Jan 2, 2026

View reviewed changes

sydseter requested changes Jan 8, 2026

View reviewed changes

sydseter requested changes Jan 29, 2026

View reviewed changes

immortal71 added 2 commits January 31, 2026 03:27

Merge remote-tracking branch 'origin/master' into feat/translation-ch…

0e1ca10

…eck-clean

fix: Addressed all review feedback - move inline imports to top, veri…

3603503

…fy mock files work correctly

immortal71 force-pushed the feat/translation-check-clean branch from 6cddfa8 to 3603503 Compare January 31, 2026 11:39

sydseter requested changes Feb 3, 2026

View reviewed changes

Uh oh!

feat: Add translation tag checker for issue #1102 #1997

Are you sure you want to change the base?

feat: Add translation tag checker for issue #1102 #1997

Conversation

immortal71 commented Jan 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes Made

1. Translation Checker Script (scripts/check_translations.py)

2. Automated Tests (tests/scripts/test_translation_tags.py)

3. GitHub Actions Integration

Pull Request Workflow (run-tests-generate-output.yaml)

Pre-Release Workflow (pre-release.yml)

How It Works

Example Output

Testing

Copilot Review Feedback Addressed

Benefits

Related Issue

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

immortal71 commented Jan 2, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sydseter Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

immortal71 Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

sydseter Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

sydseter Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

immortal71 commented Jan 22, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sydseter commented Jan 29, 2026

Uh oh!

sydseter commented Jan 29, 2026

Uh oh!

immortal71 commented Jan 31, 2026

Uh oh!

sydseter Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

sydseter Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

sydseter commented Feb 3, 2026

Uh oh!

sydseter commented Feb 3, 2026

Uh oh!

Reviewers

Assignees

immortal71 commented Jan 2, 2026 •

edited

Loading

1. Translation Checker Script (`scripts/check_translations.py`)

2. Automated Tests (`tests/scripts/test_translation_tags.py`)

Pull Request Workflow (`run-tests-generate-output.yaml`)

Pre-Release Workflow (`pre-release.yml`)