Tuvatuva · iVurevure ni Vakadewa

Override the path with the configPath input if you need a non-default location.

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.*"

iDusidusi ni vanua

provider

Mataqali: "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

Mataqali: 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

Mataqali: string[]

E dua na array se dua na string tawasei koma.

include / exclude

Mataqali: string[]

Glob patterns dikevi vata kei na sala taucoko kei na vanua ni cakacaka.

glossary

Mataqali: map<string,string>

Na vosa ni oti na vakadewa. Word-boundary aware (handles C++, .NET).

categoryId

Mataqali: string

Iwasewase ni Azure Custom Translator — nomu knob ni cakacaka/vanua (vakalawa, vakavuniwai, rorogo ni volivolitaki, kei na so tale). Vakau me ?category=....

textType

Mataqali: "plain" | "html"

Defaults ki na plain. Vakayagataka ga na html kevaka e tiko ena nomu ivurevure na tiki ni HTML dina.

profanityAction

Mataqali: "NoAction" | "Marked" | "Deleted"

How to treat profane words in translated output.

profanityMarker

Mataqali: "Asterisk" | "Tag"

E vakaibalebale ga ni profanityAction "Marked".

allowFallback

Mataqali: 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

Mataqali: string

Translator REST API version. Defaults ki na 3.0.

awsFormality

Mataqali: "FORMAL" | "INFORMAL"

AWS Translate formality setting for supported target languages.

awsBrevity

Mataqali: boolean

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

awsTerminologyNames / awsParallelDataNames

Mataqali: string[]

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

googleModel

Mataqali: string

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

googleApiEndpoint

Mataqali: string

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Mataqali: boolean

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

maxRetries

Mataqali: 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

Mataqali: 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

Mataqali: 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

Mataqali: 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

Mataqali: 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.

changeDetection

Mataqali: "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

Mataqali: string

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

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 categoryId mo 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 profanityAction me vakasavasavataki kina na vosa vakasisila ni takete na localization me baleti ira na gone.

Digitaka na nomu vosa

Ituvatuva ni repository

Schema

iDusidusi ni vanua

Ota ni vakavodoki

Rorogo kei na cakacaka, ena vosa matata