feat(*): automated update workflow by ChronosSF · Pull Request #62 · IgniteUI/igniteui-angular-api-i18n

ChronosSF · 2026-03-27T15:42:20Z

No description provided.

Copilot

Pull request overview

This PR adds automation to refresh API documentation artifacts in this repo from a repository_dispatch event, and introduces scripts to extract/patch translatable strings from the exported TypeDoc JSON.

Changes:

Add scripts/i18n-extract.mjs to flatten TypeDoc comment content into an id→translation-unit map (optionally chunked).
Add scripts/i18n-patch.mjs to apply translated units back onto a target-language TypeDoc JSON.
Add a GitHub Actions workflow to checkout/build IgniteUI/igniteui-angular at a dispatched release tag, copy TypeDoc/SASS docs into this repo, and commit/push updates.

Reviewed changes

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

File	Description
`scripts/i18n-extract.mjs`	New CLI script to extract translatable comment content from TypeDoc JSON.
`scripts/i18n-patch.mjs`	New CLI script to patch translated strings back into TypeDoc JSON.
`.github/workflows/update-from-dispatch.yml`	New CI workflow to build/export upstream docs, copy artifacts in, run extraction, and push a versioned branch update.
`.gitignore`	Ignore the workflow’s local `igniteui-angular/` checkout directory.

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

.github/workflows/update-from-dispatch.yml

scripts/i18n-extract.mjs

scripts/i18n-patch.mjs

.github/workflows/update-from-dispatch.yml

Copilot · 2026-03-27T16:05:17Z

@ChronosSF I've opened a new pull request, #65, to work on those changes. Once the pull request is ready, I'll request review from you.

Agent-Logs-Url: https://github.com/IgniteUI/igniteui-angular-api-i18n/sessions/f562b6ce-37ba-4e7b-9358-c5d98239e277 Co-authored-by: ChronosSF <2188411+ChronosSF@users.noreply.github.com>

Copilot · 2026-03-27T16:07:34Z

@ChronosSF I've opened a new pull request, #66, to work on those changes. Once the pull request is ready, I'll request review from you.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Agent-Logs-Url: https://github.com/IgniteUI/igniteui-angular-api-i18n/sessions/81d83034-088f-47f1-aa75-324c96d3e483 Co-authored-by: ChronosSF <2188411+ChronosSF@users.noreply.github.com>

Pin Node.js to v22 in update-from-dispatch workflow

Add release_tag validation guard to update-from-dispatch workflow

Copilot

Pull request overview

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

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

Copilot · 2026-03-27T16:29:10Z

scripts/i18n-extract.mjs

+const EN_PATH    = args.input       ?? resolve(__dirname, './typedoc/en/igniteui-angular.json');
+const OUT_PATH   = args.output      ?? resolve(__dirname, './typedoc/en/i18n-translatable.json');
+const CHUNK_SIZE = parseInt(args['chunk-size'] ?? '0', 10); // 0 = no splitting
+const CHUNKS_DIR = args['chunks-dir'] ?? resolve(__dirname, 'i18n-chunks');


The default paths are resolved relative to scripts/ (resolve(__dirname, './typedoc/...')), but this repo’s typedoc/ folder lives at the repository root (sibling of scripts/). Running the script with no --input/--output will fail because scripts/typedoc/... doesn’t exist. Update the defaults to resolve to ../typedoc/... (or use process.cwd()-relative paths) so the documented node ... usage works out of the box.

Suggested change

const EN_PATH = args.input ?? resolve(__dirname, './typedoc/en/igniteui-angular.json');

const OUT_PATH = args.output ?? resolve(__dirname, './typedoc/en/i18n-translatable.json');

const CHUNK_SIZE = parseInt(args['chunk-size'] ?? '0', 10); // 0 = no splitting

const CHUNKS_DIR = args['chunks-dir'] ?? resolve(__dirname, 'i18n-chunks');

const EN_PATH = args.input ?? resolve(__dirname, '../typedoc/en/igniteui-angular.json');

const OUT_PATH = args.output ?? resolve(__dirname, '../typedoc/en/i18n-translatable.json');

const CHUNK_SIZE = parseInt(args['chunk-size'] ?? '0', 10); // 0 = no splitting

const CHUNKS_DIR = args['chunks-dir'] ?? resolve(dirname(OUT_PATH), 'i18n-chunks');

Copilot · 2026-03-27T16:29:10Z

scripts/i18n-extract.mjs

+ * Usage:
+ *   node i18n-extract.mjs
+ *   node i18n-extract.mjs --input=i18nRepo/typedoc/en/igniteui-angular.json
+ *   node i18n-extract.mjs --output=i18n-translatable.json
+ *   node i18n-extract.mjs --chunk-size=50   (items per chunk file, 0 = single file)


The usage header still references i18nRepo/typedoc/en/..., but this repo stores the TypeDoc JSON under typedoc/en/... at the repository root. Please update the usage examples to match the actual expected paths (and ideally show node scripts/i18n-extract.mjs ... from repo root).

Suggested change

* Usage:

* node i18n-extract.mjs

* node i18n-extract.mjs --input=i18nRepo/typedoc/en/igniteui-angular.json

* node i18n-extract.mjs --output=i18n-translatable.json

* node i18n-extract.mjs --chunk-size=50 (items per chunk file, 0 = single file)

* Usage (from repo root):

* node scripts/i18n-extract.mjs

* node scripts/i18n-extract.mjs --input=typedoc/en/igniteui-angular.json

* node scripts/i18n-extract.mjs --output=typedoc/en/i18n-translatable.json

* node scripts/i18n-extract.mjs --chunk-size=50 (items per chunk file, 0 = single file)

Copilot · 2026-03-27T16:29:11Z

scripts/i18n-patch.mjs

+
+/**
+ * Applies a translation unit onto a typedoc comment node.
+ * Overwrites summary and blockTags with the translated strings.


The function doc says it “Overwrites summary and blockTags”, but the implementation only overwrites summary and then partially updates blockTags (preserving unmatched existing tags and appending extra incoming ones). Either update the comment to describe the merge behavior, or change the implementation to fully replace node.comment.blockTags when unit.blockTags is present.

Suggested change

* Overwrites summary and blockTags with the translated strings.

* Overwrites the summary text and merges blockTags with the translated

* strings (updating matching tags, preserving unmatched existing ones, and

* appending any additional translated tags).

Copilot · 2026-03-27T16:29:11Z

scripts/i18n-patch.mjs

+ * Usage:
+ *   node i18n-patch.mjs
+ *   node i18n-patch.mjs --input=i18n-translatable.json --lang=ja
+ *   node i18n-patch.mjs --input=i18n-translatable.json --target=i18nRepo/typedoc/ja/igniteui-angular.json --output=out.json
+ *
+ * When patching from chunk files produced with --chunk-size:
+ *   node i18n-patch.mjs --chunks-dir=i18n-chunks --lang=ja


The usage examples mention --target=i18nRepo/typedoc/..., but this repository’s checked-in TypeDoc JSON appears under typedoc/<lang>/.... Update the usage examples to reflect the actual repo layout to avoid confusing users (and consider using node scripts/i18n-patch.mjs ... if run from repo root).

Suggested change

* Usage:

* node i18n-patch.mjs

* node i18n-patch.mjs --input=i18n-translatable.json --lang=ja

* node i18n-patch.mjs --input=i18n-translatable.json --target=i18nRepo/typedoc/ja/igniteui-angular.json --output=out.json

*

* When patching from chunk files produced with --chunk-size:

* node i18n-patch.mjs --chunks-dir=i18n-chunks --lang=ja

* Usage (from repo root):

* node scripts/i18n-patch.mjs

* node scripts/i18n-patch.mjs --input=typedoc/ja/i18n-translatable.json --lang=ja

* node scripts/i18n-patch.mjs --input=typedoc/ja/i18n-translatable.json --target=typedoc/ja/igniteui-angular.json --output=out.json

*

* When patching from chunk files produced with --chunk-size:

* node scripts/i18n-patch.mjs --chunks-dir=i18n-chunks --lang=ja

feat(*): automated update workflow

d598908

ChronosSF changed the base branch from 21.1.x to master March 27, 2026 15:46

ChronosSF requested a review from Copilot March 27, 2026 15:47

Copilot started reviewing on behalf of ChronosSF March 27, 2026 15:47 View session

Copilot AI reviewed Mar 27, 2026

View reviewed changes

Initial plan

f0a1651

Copilot AI mentioned this pull request Mar 27, 2026

Pin Node.js to v22 in update-from-dispatch workflow #65

Merged

Copilot AI and others added 2 commits March 27, 2026 16:06

feat: pin Node.js version to 22 in update workflow

7b8e935

Agent-Logs-Url: https://github.com/IgniteUI/igniteui-angular-api-i18n/sessions/f562b6ce-37ba-4e7b-9358-c5d98239e277 Co-authored-by: ChronosSF <2188411+ChronosSF@users.noreply.github.com>

Initial plan

a0ad658

Copilot AI mentioned this pull request Mar 27, 2026

Add release_tag validation guard to update-from-dispatch workflow #66

Merged

ChronosSF and others added 5 commits March 27, 2026 18:07

Apply suggestions from code review

5e98d2b

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

fix(workflow): add release_tag validation guard in update-from-dispatch

52cca93

Agent-Logs-Url: https://github.com/IgniteUI/igniteui-angular-api-i18n/sessions/81d83034-088f-47f1-aa75-324c96d3e483 Co-authored-by: ChronosSF <2188411+ChronosSF@users.noreply.github.com>

Merge pull request #65 from IgniteUI/copilot/sub-pr-62

5f2213f

Pin Node.js to v22 in update-from-dispatch workflow

Merge pull request #66 from IgniteUI/copilot/sub-pr-62-again

3329186

Add release_tag validation guard to update-from-dispatch workflow

chore(*): updating default paths

3edfd81

ChronosSF requested a review from Copilot March 27, 2026 16:24

Copilot started reviewing on behalf of ChronosSF March 27, 2026 16:24 View session

Copilot AI reviewed Mar 27, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(*): automated update workflow#62

feat(*): automated update workflow#62
ChronosSF wants to merge 9 commits intomasterfrom
sstoychev/add-automated-workflow

ChronosSF commented Mar 27, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Mar 27, 2026

Uh oh!

Copilot AI commented Mar 27, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 27, 2026

Uh oh!

Copilot AI Mar 27, 2026

Uh oh!

Copilot AI Mar 27, 2026

Uh oh!

Copilot AI Mar 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

- * Overwrites summary and blockTags with the translated strings.
+ * Overwrites the summary text and merges blockTags with the translated
+ * strings (updating matching tags, preserving unmatched existing ones, and
+ * appending any additional translated tags).

Conversation

ChronosSF commented Mar 27, 2026

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!

Copilot AI commented Mar 27, 2026

Uh oh!

Copilot AI commented Mar 27, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants