Ihuaqhaininnga · Atuqtakhanik Numiktiriji

Qaangirlugu apqutikhaq configPath iliuraidjutaa ihariagigungni atuqtaungittumik najugakhamik.

Schema

# .github/resource-translator.yml
sourceLocale: en

# Provider config can be nested. Keep secrets in workflow inputs; use repo
# config for non-secret defaults like region, model, formality, or category.
provider:
  azure:
    categoryId: my-custom-translator-category
    apiVersion: "3.0"
    allowFallback: true

toLocales:
  - fr
  - de
  - es
include:
  - "src/**/*.en.json"
  - "apps/**/*.en.resx"
exclude:
  - "**/__tests__/**"
glossary:
  Acme: Contoso
  Octocat: Octocat   # keep brand names verbatim

# Translator request shape — most users can ignore these.
textType: plain                  # plain | html
profanityAction: NoAction        # NoAction | Marked | Deleted
profanityMarker: Asterisk        # Asterisk | Tag (only when profanityAction == Marked)

# Resilience — Translator returns 429 under load. Defaults are usually
# fine; tune only if your runs are large enough to hit them.
maxRetries: 5
retryBackoffMs: 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: true
customPlaceholderPatterns:
  - "<<.+?>>"                     # 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.*"

Maniqami naunaitkutit

provider

Qanurittuq: "azure" | "aws" | "google" | provider block

Either a provider string or a nested provider block (provider.azure, provider.aws, or provider.google). Prefer nested blocks for provider-specific settings; keep secrets in workflow inputs rather than committed config.

sourceLocale

Qanurittuq: string

Utiffaaqtuq sourceLocale iliuraqtaungitpat. Hivumuuqtitauyuqlu Numiktiriyimun from=<locale> naittut naqitautit ilituriyaulimaitut.

toLocales

Qanurittuq: string[]

Kituliqaa array uvaluniit virguunmik avikhimayumik string-mik.

include / exclude

Qanurittuq: string[]

Glob qanurinigit naunaiyaqtauyut tamainit havakviuyunilu pijutiqaqtunik apqutinik.

glossary

Qanurittuq: map<string,string>

Kinguani-numiktitirutit tainiit ihuatqiyauyut. Taijuhiq-kikligiyait qauyimaniq (C++, .NET).

categoryId

Qanurittuq: string

Azure Custom Translator category — havagvingni/domain knob (maligatigut, munaqhiliqinikkut, niuvaanikkut tone, taimaalu.). Tuyuqtauyuq ?category=....

textType

Qanurittuq: "plain" | "html"

Atuqtauluangituq plain. Aturlugu html atuqtakhatit piqaqqata HTML fragments-nik.

profanityAction

Qanurittuq: "NoAction" | "Marked" | "Deleted"

Qanuq pidjutigilugit ihuangitumik taidjutit numiktiqhimayuni.

profanityMarker

Qanurittuq: "Asterisk" | "Tag"

Kangiqhinnaktuq profanityAction "Marked".

allowFallback

Qanurittuq: boolean

Ihuaqhaqlugu false nakuunggittuq numiktitirniq categoryId pidjutinggitpat tikiutiyaami talvainnakmi talvainnakmi.

apiVersion

Qanurittuq: string

Numiktiriyi REST API version. Atuqtauluangituq 3.0.

awsFormality

Qanurittuq: "FORMAL" | "INFORMAL"

AWS Translate formality setting for supported target languages.

awsBrevity

Qanurittuq: boolean

Set to true to enable AWS Translate brevity mode for supported language pairs.

awsTerminologyNames / awsParallelDataNames

Qanurittuq: string[]

AWS Translate custom terminology and parallel data resource names. Either an array or comma-separated string.

googleModel

Qanurittuq: string

Google Cloud Translation model, e.g. nmt or base.

googleApiEndpoint

Qanurittuq: string

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Qanurittuq: boolean

Optional Google Cloud Translation automatic retry toggle. Leave unset to use the Google client default.

maxRetries

Qanurittuq: integer

Anginiqhaq uuktuffaarniq tadjakaffuk HTTP kiudjutit (408, 425, 429, 500, 502, 503, 504). Atuqtauluangituq 5. Attautimun HTTP hivayaqtut attauhirmun 1 + maxRetries.

retryBackoffMs

Qanurittuq: integer

Matulugu (ms) kituni hiningnairumi. Atuqtauluangituq 30000. Azure's Retry-After header nan'ngariyauyuq talvaniitkaangat; taimaali jittered exponential backoff atuqtauyuq, kikliqaqtuq uvani aktilaanganun.

protectPlaceholders

Qanurittuq: boolean

Atuqtauluangituq true. Atuqtaugaangamik, tokens imaatun {{name}}, ${var}, {0}, {0:N2}, %s, %1$s unalu HTML entities himmiqtaublutik sentinel tokensnik nuutiqtautinagit uvalu utiqtitaublutik kinguani. Unguvaqtirlugu pivikhaq pihuqhaaqhimakpat piqaqqat placeholder-mik titirauhirnik.

customPlaceholderPatterns

Qanurittuq: string[]

Ilaliutihimayut regex atugahat (kikliqangitut) ilaliutihimayut atuqtauluaqtunun naunaitkutinun katitiqhimayut, imaa <<.+?>> haffumunga custom token syntax. Ihuangitut regexes hugiyaungitut.

noTranslatePatterns

Qanurittuq: string[]

Glob idjuhiit aadjikkiiktut parser-level keys-nut (JSON dotted path, RESX name, PO msgid, XLIFF unit id, INI/restext key). Aadjikkiiktut kiluuttat piiqtauvaktut tukhiunmit talvunggaulutik pivigiyait tammaqtailiplugit.

changeDetection

Qanurittuq: "smart" | "disabled"

Defaults to smart. Uses the committed state manifest to translate only changed or missing parser keys. Set to disabled or false to preserve the legacy always-translate behavior.

statePath

Qanurittuq: string

Path to the deterministic smart change-detection state manifest. Defaults to .github/resource-translator-state.json.

Uhiliqhinikkut pitquidjutit

Hulijakhaq taiguqtuq naunaitpiaqtunik uqautaujunik havaktaujukhanit.
Iliuraqtaa YAML config configPath.
Tamainnut aadlanut piyut havakvikmi, iliurainiq akimayuq; taimaali YAML aktilaanga atuqtauyuq.
Katitiqhimayut akiit tutqighaqtauyut. Ihuangitut enums (imaa profanityAction: Mask) pidjutauyut hulidjutinun ihuangitumik qilamik naunaitumik tuhaqtidjutmik.

Nipinga havakvingalu, naunaittumik tainiit

Una Azure AI Translator v3 API piqangittuq atauhiinnarmik nipaarutimik knob-mik. Malruuk ihuaqhaqhimajuk attautimukhimajut aadjikkiiktunik munaqhidjutikhanik:

Havagvik / havagvia: atuqlugu categoryId tikkuariami Azure Custom Translator ilagiyanganik ayuirhaqhimayuq nanminiriyarnik timiqutigiyarnik — maligatigut, ayurnaqtunik, munarhiliqinikkut, niuvvaaviliqinikkut, hunanikluuniit. Una hakugitqijaujuq pidjutikhaq nipaanun, qanurittunun nipinun, tainiinnunlu.
Qaangani titiraqhimayut: Atuqlugu Tukiliurutingit kiluuttariami piliuqhimayut atiit hunavaluillu tainiit tainiit, aturlugulu profanityAction piiyariami nakuungittumik tainiit pinahualirumi nunamut nukaqhiuyunut.

Pilugu uqauhiq

Tutquumavingit ihuarhainiq

Schema

Maniqami naunaitkutit

Uhiliqhinikkut pitquidjutit

Nipinga havakvingalu, naunaittumik tainiit