[GSOC 2025]: Github action for translation tracker #895

Divyansh013 · 2025-07-06T18:53:54Z

test-local file detects local changes
index.js does manual triggering for issue creation
action works on all "push" events
outdated banner addition on missing translation pages

…sting

- Updated translation-sync workflow for examples instead of reference - Added Week 3 test change to Shape Primitives description - Should trigger automated issue creation for outdated translations

- Added workflow_dispatch with scan_all and create_issues options - Can now manually trigger action from GitHub UI - Supports both normal and full-scan modes

- Modified description.mdx to test translation tracker - Should now detect 1 English example file change

- test-local.js: Only shows changed files from predefined test files - index.js: Production mode with minimal console output - Removed verbose logging and repository exploration - Clear distinction: test mode vs production mode with GitHub token

- SCAN_ALL=true environment variable to check all 61 example files - Simplified GitHub Actions workflow - Default: checks only changed files - Manual trigger: option to scan all files

ksen0 · 2025-07-15T07:44:18Z

Hi @Divyansh013 , this is looking great!

Based on checking the current issue created by this (Divyansh013#11) I have a couple of minor suggestions:

Move 🔍 Compare changes to the Quick Links section, because it's not file-specific.
Potentially: next to this one link to "Compare changes", could add a note like: ℹ️ You can see the changes in a specific file by going the the "Compare changes" link above, clicking on the "Files changed" tab, and navigating to the specific file.
Move "Change Type: English file was updated. Spanish (Español), Hindi (हिन्दी), Korean (한국어), Chinese Simplified (简体中文) translations may be outdated." into the Timeline - right now this is very far separated, but seems related?

lirenjie95 · 2025-07-17T02:05:23Z

.github/actions/translation-tracker/index.js

+      ? 'git diff --name-only HEAD~1 HEAD'
+      : 'git diff --name-only HEAD~1 HEAD';


Two options are actually the same. Maybe typo here?

indeed. What was originally intended here:

'git diff --name-only origin/main...HEAD' // Compare with base branch for PRs : 'git diff --name-only HEAD~1 HEAD'; // and with last commir for pushes

thoughts about this?

lirenjie95 · 2025-07-17T02:09:36Z

.github/actions/translation-tracker/index.js

+
+      return null;
+    } catch (error) {
+      // Fallback to main branch if current branch fails


I'm wondering what will happen if the main branch also fails?

in that case we can log out the error ? or is there something I am missing out?

lirenjie95 · 2025-07-17T02:10:34Z

.github/actions/translation-tracker/index.js

+  try {
+    return fs.statSync(filePath).mtime;
+  } catch (error) {
+    return null;


Add log here might be helpful for debugging.

lirenjie95 · 2025-07-17T02:14:06Z

.github/actions/translation-tracker/index.js

+   * Format the issue body with helpful information
+   */
+  formatIssueBody(englishFile, language, commitInfo) {
+    const translationPath = englishFile.replace('/en/', `/${language}/`);


If the directory structure changes or there are multiple occurrences of ·/en/· in the path (correct me if there are any situations that I didn't catch), this could lead to errors or unintended behavior.

Divyansh013 · 2025-08-18T05:11:24Z

@ksen0 requesting your review here

lirenjie95 · 2025-08-18T08:41:47Z

src/components/OutdatedTranslationBanner/index.astro

+  'zh-Hans': {
+    title: '此翻译可能已过期',
+    message: '与英文版本相比，此页面不是最新的。',
+    viewEnglish: '查看英文页面',
+    contribute: '参与翻译',
+  },


The Chinese translation here is pretty good. I will take a look of the remaining GitHub Actions related stuff when I have time.

.github/actions/translation-tracker/README.md

ksen0 · 2025-08-19T20:20:26Z

src/components/OutdatedTranslationBanner/index.astro

+    contribute: 'Contribuir a la traducción',
+  },
+  'ko': {
+    title: '이 번역은 오래되었을 수 있습니다',


Hi @hana-cho! When you have time, another set of Korean translations for your review. Thanks so much!

ksen0 · 2025-08-19T20:21:04Z

src/components/OutdatedTranslationBanner/index.astro

+    contribute: 'अनुवाद में योगदान दें',
+  },
+  'es': {
+    title: 'Esta traducción podría estar desactualizada',


Hi @marioguzzzman! If/when you have time, could you check these Spanish translations please? Thanks so much!

lirenjie95 · 2025-08-21T09:38:07Z

src/layouts/ExampleLayout.astro

+let englishUrl = Astro.url.pathname;
+if (currentLocale !== 'en') {
+  // Replace /{locale}/ with / to get English URL
+  englishUrl = englishUrl.replace(`/${currentLocale}/`, '/');


Question here: have you tried using zh-Hans? It is a different use case from es, hi and ko. I’m wondering if the replace operation will succeed.
PS: Please check all places with currentLocale and replace()

Yes have checked zh-Hans and it is working in expected way. I will check in all places

ksen0 · 2025-08-23T08:53:29Z

.github/actions/translation-tracker/README.md

+   - Links to files and comparisons
+   - Action checklist for translators
+   - Proper labels (`needs translation`, `lang-es`, etc.)
+4. **Generates** manifest file for website banner system


Thanks so much for the README updates! As one last thing, please include here or ~line 112 a short explanation/example of the translation-status format.

ksen0 · 2025-08-23T08:55:35Z

.github/actions/translation-tracker/index.js

+    const englishCommit = commitInfo.english;
+    const translationCommit = commitInfo.translation;
+
+    return `## 🌍 Translation Update Needed


As a future improvement, this could be pulled out as a template file separate form the .js script.

ksen0 · 2025-08-23T09:03:32Z

.github/workflows/translation-sync.yml

+
+on:
+  push:
+    branches: [main, week2]


This is looking great and nearly ready for further testing. If we're now in step 1 of the below iterative deployment process, then to get to step 2, I think this should listen for push on branch only for now

Finalize this PR tested on your fork, document any further improvements, etc.

create a new PR that contains only the action. This PR would target the main branch, but the action would listen for translation changes on the staging branch.

create a PR that targets the staging branch to add the UI. This will allow fine-tuning the tool.

Lastly, to make it go live, the process would be to marge the UI PR into main, and then change the action to listen on main rather than branch

ksen0 · 2025-08-23T09:14:52Z

.github/actions/translation-tracker/index.js

+/**
+ * Scan all English example files (for manual scanning)
+ */
+function getAllEnglishExampleFiles() {


The biggest next step to improve here would be to generalize this code so it could work with not only "examples/" but also tutorials/ and text-detail/ (still not including reference) - I've tried to add comments where applicable!

ksen0 · 2025-08-23T09:15:58Z

.github/actions/translation-tracker/index.js

+    filesToCheck = getChangedFiles();
+  } else {
+    console.log('📊 Scanning all English example files...');
+    filesToCheck = getAllEnglishExampleFiles();


Possible usage: getAllExampleFiles(currentDirectory) (where outside of the loop, currentDirectory is looping through, e .g., ["examples"]). To keep the issue volume down during testing, I still think should should only focus on one of the 3 directories (examples), but it should be easily extensible to include others, without refactor. Locally, would alos be great to test on the other 2 directories to see what edge-cases may come up.

ksen0 · 2025-08-23T09:21:10Z

.github/actions/translation-tracker/index.js

+      examples,
+    };
+    fs.writeFileSync(manifestPath, JSON.stringify(manifest, null, 2), 'utf8');
+    console.log(`\n🗂️  Wrote translation manifest: ${manifestPath}`);


Include current directory in output

ksen0 · 2025-08-23T09:21:34Z

.github/actions/translation-tracker/package.json

+{
+  "name": "p5js-translation-tracker",
+  "version": "0.2.0",
+  "description": "GitHub Action to track translation status for p5.js examples and documentation",


"GitHub Action to track translation status for p5.js examples and documentation" -> "GitHub Action to track translation status for p5.js documentation"

ksen0 · 2025-08-23T09:22:11Z

.github/actions/translation-tracker/README.md

+on:
+  push:
+    branches: [main, week2]
+    paths: ['src/content/examples/en/**']


This already looks generalized, which is great

ksen0 · 2025-08-23T09:22:49Z

.github/actions/translation-tracker/README.md

+
+## Features
+
+- Detects outdated/missing translations using Git commit comparison


Very minor: add a note here please that it currently focuses on Examples content

ksen0 · 2025-08-23T09:23:51Z

src/layouts/ExampleLayout.astro

+console.log('DEBUG: Current locale:', currentLocale);
+
+try {
+  const manifestPath = path.join(process.cwd(), "public", "translation-status", "examples.json");


I think at this stage, it makes sense to keep this here, but in the future (or now, optionally, if you prefer) also generalize it as a component usable in other layouts.

Divyansh013 added 17 commits June 10, 2025 01:03

Test: Add documentation line to circle.mdx for translation tracker te…

46edaf0

…sting

Add Week 1 translation tracker implementation

ba9b4ee

Test: Modify triangle.mdx for translation testing

cd94f24

Test: Modify accelerationX.mdx to test missing translation detection

ddebbf3

removed testing logs

1e13287

small fix

875a77c

post review changes

5170eb6

Week 2: Translation tracker with GitHub API and Hindi focus

56abeec

Test: Update English example for translation tracker testing

d9c98c6

Fix: Add automatic branch detection to translation tracker

1976d9d

week 2 complete

71e7049

Week 3: Test automated translation tracking

94159c8

- Updated translation-sync workflow for examples instead of reference - Added Week 3 test change to Shape Primitives description - Should trigger automated issue creation for outdated translations

Add manual trigger support to translation tracker workflow

f03b60d

- Added workflow_dispatch with scan_all and create_issues options - Can now manually trigger action from GitHub UI - Supports both normal and full-scan modes

Test: Manual trigger detection test

dea5e7c

- Modified description.mdx to test translation tracker - Should now detect 1 English example file change

Add scan all files option to index.js

63753de

- SCAN_ALL=true environment variable to check all 61 example files - Simplified GitHub Actions workflow - Default: checks only changed files - Manual trigger: option to scan all files

final fix

9f63c9d

lirenjie95 reviewed Jul 17, 2025

View reviewed changes

Divyansh013 added 2 commits August 11, 2025 21:35

temp commit

8de0a67

basic version complete

18bd739

Divyansh013 marked this pull request as ready for review August 18, 2025 05:10

Divyansh013 changed the title ~~Basic functionality of translation tracker~~ [GSOC 2025]: Github actions for translation tracker Aug 18, 2025

Divyansh013 changed the title ~~[GSOC 2025]: Github actions for translation tracker~~ [GSOC 2025]: Github action for translation tracker Aug 18, 2025

lirenjie95 reviewed Aug 18, 2025

View reviewed changes

ksen0 reviewed Aug 19, 2025

View reviewed changes

lirenjie95 reviewed Aug 21, 2025

View reviewed changes

readme updated and simplified scanning

7fb683c

Divyansh013 requested a review from ksen0 August 21, 2025 16:37

ksen0 reviewed Aug 23, 2025

View reviewed changes

		? 'git diff --name-only HEAD~1 HEAD'
		: 'git diff --name-only HEAD~1 HEAD';


		## Features

		- Detects outdated/missing translations using Git commit comparison

[GSOC 2025]: Github action for translation tracker #895

Are you sure you want to change the base?

[GSOC 2025]: Github action for translation tracker #895

Uh oh!

Conversation

Divyansh013 commented Jul 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ksen0 commented Jul 15, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Divyansh013 Jul 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Divyansh013 commented Aug 18, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Divyansh013 commented Jul 6, 2025 •

edited

Loading

Divyansh013 Jul 20, 2025 •

edited

Loading