Override the path with the configPath input if you need a non-default location.
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.*"iDusidusi ni vanua
| Vanua | Mataqali | iDusidusi |
|---|---|---|
sourceLocale | string | Lesu tale ki na sourceLocale input kevaka e sega ni tuvatuva. Also forwarded to Translator as from=<locale> so short strings aren't autodetected. |
toLocales | string[] | E dua na array se dua na string tawasei koma. |
include / exclude | string[] | Glob patterns dikevi vata kei na sala taucoko kei na vanua ni cakacaka. |
glossary | map<string,string> | Na vosa ni oti na vakadewa. Word-boundary aware (handles C++, .NET). |
categoryId | string | Iwasewase ni Azure Custom Translator — nomu knob ni cakacaka/vanua (vakalawa, vakavuniwai, rorogo ni volivolitaki, kei na so tale). Vakau me ?category=.... |
textType | "plain" | "html" | Defaults ki na plain. Vakayagataka ga na html kevaka e tiko ena nomu ivurevure na tiki ni HTML dina. |
profanityAction | "NoAction" | "Marked" | "Deleted" | How to treat profane words in translated output. |
profanityMarker | "Asterisk" | "Tag" | E vakaibalebale ga ni profanityAction "Marked". |
allowFallback | boolean | Tuvanaka me false me sega ni vakadewataki ni sega ni dua na deployment ni nomu categoryId me baleta e dua na vanua takete ka sega ni lesu tale ki na ivakaraitaki raraba. |
apiVersion | string | Translator REST API version. Defaults ki na 3.0. |
maxRetries | integer | Maximum retry attempts on transient HTTP responses (408, 425, 429, 500, 502, 503, 504). Defaults ki na 5. Na iwiliwili taucoko ni kaci ni HTTP ena dua na kerekere e 1 + maxRetries. |
retryBackoffMs | integer | Cap (ms) ena dua ga na moce vakamuri. Defaults ki na 30000. Na ulutaga ni Retry-After ni Azure e rokovi sara ga ena gauna e tiko kina; kevaka e sega e vakayagataki na jittered exponential backoff, capped ena yavunilewa oqo. |
protectPlaceholders | boolean | Defaults ki na true. Ni sa yaco, na ivakatakilakila me vaka na {{name}}, ${var}, {0}, {0:N2}, %s, %1$s kei na HTML entity era sa vakaisosomitaki vata kei na ivakatakilakila ni sentinel ni bera na vakadewataki ka vakalesui mai ni sa oti. Disable only when source intentionally contains placeholder-shaped literals. |
customPlaceholderPatterns | string[] | Ikuri ni ivakarau ni regex (sega ni delimiters) vakuri ki na ituvatuva ni placeholder lalai, e.g. <<.+?>> me baleta na syntax ni ivakatakilakila tudei. E sega ni kauwaitaki na regexes sega ni dodonu. |
noTranslatePatterns | string[] | Glob patterns matched against parser-level keys (JSON dotted path, RESX name, PO msgid, XLIFF unit id, INI/restext key). Na idola veisotari era na vakasuka mai na kerekere ka curu yani vata kei na kena ivurevure maroroi. |
Ota ni vakavodoki
- Na cakacaka e wilika na vakasama matata mai na cakacaka.
- E vakavodoka na config ni YAML mai na
configPath. - Me baleta na veivanua kece e wasea, e qaqa na input; kevaka e sega sa vakayagataki na yavunilewa ni YAML.
- Sa vakadeitaki na yavunilewa sa cokovata tu. Na enum sega ni cala (e.g.
profanityAction: Mask) e vakavuna na cakacaka me leqa vakatotolo ena dua na itukutuku matata.
Rorogo kei na cakacaka, ena vosa matata
Na Azure AI Translator v3 API e sega ni dua na knob ni rorogo. E rua na ivakarau e cokovata me solia vei iko e levu na lewa vata ga:
- Cakacaka / vanua: vakayagataka na
categoryIdmo dusia kina e dua na iwasewase ni Azure Custom Translator ka tuberi ena nomu corpus — vakalawa, gacagaca, vakavuniwai, volivolitaki, se dua tale na ka. Oqo na lever kaukauwa duadua me baleta na rorogo, domo ni brand, kei na vosa. - Na itukutuku e dela: Vakayagataka na iVolatukutuku me lokataki kina na yaca ni brand kei na vosa ni ivoli ena vosa vosa, ka vakayagataka na
profanityActionme vakasavasavataki kina na vosa vakasisila ni takete na localization me baleti ira na gone.