Hindura inzira ukoresheje configPath input nimba ukeneye ikibanza kidasanzwe.
Schema
# .github/resource-translator.ymlsourceLocale: entoLocales: - fr - de - esinclude: - "src/**/*.en.json" - "apps/**/*.en.resx"exclude: - "**/__tests__/**"glossary: Acme: Contoso Octocat: Octocat # keep brand names verbatim
# Domain / industry — uses an Azure Custom Translator category trained on# your tone and vocabulary. Leave unset for the general model.categoryId: my-custom-translator-category
# Translator request shape — most users can ignore these.textType: plain # plain | htmlprofanityAction: NoAction # NoAction | Marked | DeletedprofanityMarker: Asterisk # Asterisk | Tag (only when profanityAction == Marked)allowFallback: true # false fails when the categoryId has no deployment
apiVersion: "3.0"
# Resilience — Translator returns 429 under load. Defaults are usually# fine; tune only if your runs are large enough to hit them.maxRetries: 5retryBackoffMs: 30000 # cap on any single backoff sleep (ms)
# Placeholder protection. ON by default — wraps tokens like {{name}},# {0}, %s, ${var} into sentinels before translation and restores them# on the way back. Set false only when source intentionally contains# placeholder-shaped literals.protectPlaceholders: truecustomPlaceholderPatterns: - "<<.+?>>" # any extra token syntax you use
# Per-key opt-out. Keys matching any glob are dropped from the request# and pass through with the source value preserved.noTranslatePatterns: - "errors.code.*" - "brands.*"Field reference
| Umurima | Ubwoko | Notes |
|---|---|---|
sourceLocale | string | Subira ku murongo sourceLocale mu gihe utabikoze. Also forwarded to Translator as from=<locale> so short strings are not autodetected. |
toLocales | string[] | Canke umurongo w'umurongo utandukanye na koma. |
include / exclude | string[] | Glob patterns tested against absolute and workspace-relative paths. |
glossary | map<string,string> | Post-translation term overrides. Word-boundary aware (handles C++, .NET). |
categoryId | string | Azure Custom Translator category — your industry/domain knob (legal, medical, marketing tone, etc.). Sent as ?category=.... |
textType | "plain" | "html" | Kudahana plain. Use html only if your resource values contain real HTML fragments. |
profanityAction | "NoAction" | "Marked" | "Deleted" | Ni gute wahindura imvugo y'ikirundi mu majambo y'ubuhinduzi? |
profanityMarker | "Asterisk" | "Tag" | Ni vyiza gusa igihe profanityAction ari "Marked". |
allowFallback | boolean | Set to false to fail the translation when your categoryId has no deployment for a target locale instead of falling back to the general model. |
apiVersion | string | Translator REST API version. Kudahana 3.0. |
maxRetries | integer | Maximum retry attempts on transient HTTP responses (408, 425, 429, 500, 502, 503, 504). Kudakora 5. Guhamagara HTTP kuri buri busabe ni 1 + maxRetries. |
retryBackoffMs | integer | Suzumiya Haruka Ayase Kudahana 30000. Umutwe wa Retry-After wa Azure uraterwa iteka igihe uriho; otherwise jittered exponential backoff is used, capped at this value. |
protectPlaceholders | boolean | Kudahana true. Mu gihe bimaze gukorwa, ibimenyetso nka {{name}}, ${var}, {0}, {0:N2}, %s, %1$s na HTML birasubirizwa n'ibimenyetso vya sentinel imbere yo guhindurwa hanyuma bigasubizwa inyuma y'aho. Disable only when source intentionally contains placeholder-shaped literals. |
customPlaceholderPatterns | string[] | Extra regex patterns (without delimiters) added to the default placeholder set, e.g. <<.+?>> for custom token syntax. Invalid regexes are ignored. |
noTranslatePatterns | string[] | Uburyo bwa Glob buhuye n'imfunguzo zo ku rwego rwa parser (JSON dotted path, RESX name, PO msgid, XLIFF unit id, INI / restext key). Imfunguzo zihuza zikurwa mu busabe hanyuma zigaca hamwe n'agaciro kazo k'inkomoko zibikwa. |
Loading order
- The action reads explicit inputs from the workflow.
- It loads the YAML config from
configPath. - Ku murima wose uhuriweko, inyifato iratsinda; otherwise the YAML value is used.
- Ibiciro vy'ibiharuro vy'ibiharuro vy' Invalid enums (e.g.
profanityAction: Mask) cause the action to fail fast with a clear message.
Tone and industry, in plain terms
Azure AI Translator v3 API nta tone imwe ifise. Ibice bibiri bihuriye hamwe kugira ngo biguha igice kinini c'ubugenzuzi bumwe:
- Industry / domain: Use
categoryIdto point at an Azure Custom Translator category trained on your own corpus — legal, technical, medical, marketing, or anything else. Ico nico kimenyetso gikomeye cane c'amajwi, ijwi ry'ikirango hamwe n'amajambo. - Igisomwa co hejuru: Use the Glossary to lock brand names and product terms verbatim, and use
profanityActionto scrub profane terms when targeting localization for young audiences.