Kanda kuri configPath ukoresheje uburyo bwo kugenzura niba ukeneye ahantu hadakwiye.
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
| Field | Ubwoko | Notes |
|---|---|---|
sourceLocale | string | Reka dusubire ku murongo sourceLocale niba utarashyizweho. Ikindi ni uko n'abasemuzi b'ikinyamakuru Izuba Rirashe from=<locale> ku buryo nta n'umwe ugira icyo abivugaho. |
toLocales | string[] | Cyangwa umurongo cyangwa umugozi utandukanywa na koma. |
include / exclude | string[] | Ibipimo bya Glob byasuzumiwe ugereranyije n'inzira zuzuye n'iz'akazi. |
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" | Kudakora plain. Use html only if your resource values contain real HTML fragments. |
profanityAction | "NoAction" | "Marked" | "Deleted" | How to treat profane terms in translated output. |
profanityMarker | "Asterisk" | "Tag" | Only meaningful when profanityAction is "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. Kudakora 3.0. |
maxRetries | integer | Maximum retry attempts on transient HTTP responses (408, 425, 429, 500, 502, 503, 504). Kudakora 5. Total HTTP calls per request is 1 + maxRetries. |
retryBackoffMs | integer | Bye Bye Birdie (On Any Backoff Sleep) Kudakora 30000. Umutwe wa Retry-After wa Azure wubashywe neza igihe uhari; otherwise jittered exponential backoff is used, capped at this value. |
protectPlaceholders | boolean | Kudakora true. Iyo umaze guhindurwa, ibimenyetso nka {{name}}, ${var}, {0}, {0:N2}, %s, %1$s na HTML bisimbuzwa ibimenyetso bya sentinel mbere yo guhindurwa hanyuma bigasubizwa nyuma. Disable only when source intentionally contains placeholder-shaped literals. |
customPlaceholderPatterns | string[] | Ibishushanyo byinyongera bya regex (bidafite delimiters) byongerewe kuri seti ya placeholder ya mbere, urugero <<.+?>> kuri syntax ya token isanzwe. Invalid regexes are ignored. |
noTranslatePatterns | string[] | Ibishushanyo bya Glob bihujwe n'urufunguzo rwo ku rwego rwa parser (JSON dotted path, RESX name, PO msgid, XLIFF unit id, INI / restext key). Matching keys are dropped from the request and pass through with their source value preserved. |
Loading order
- The action reads explicit inputs from the workflow.
- It loads the YAML config from
configPath. - Kuri buri murima uhuriweho, umusaruro utsinda; otherwise the YAML value is used.
- Ibiciro by'ibicuruzwa byashyizweho byemewe. 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 ntabwo ifite tone imwe. Ibice bibiri bihuriye hamwe biguha igice kinini cy'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. Iyi ni lever ikomeye cyane y'amajwi, ijwi ry'ikirango, n'amagambo. - Surface text: Use the Glossary to lock brand names and product terms verbatim, and use
profanityActionto scrub profane terms when targeting localization for young audiences.