Configuration · Resource Translator

Dzvanya bhatani rekumisikidza configPath kana iwe uchida nzvimbo isiri yekutadza.

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

Field reference

provider

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

Type: string

Dzokera kunzvimbo sourceLocale kana isina kumisikidzwa. Also forwarded to Translator as from=<locale> so short strings are not autodetected.

toLocales

Type: string[]

Kana kuti yakaparadzaniswa kana yakaparadzaniswa nekomma.

include / exclude

Type: string[]

Glob mapatani akaongororwa achipesana neyakakwana uye nzvimbo yekushandira-hukama nzira.

glossary

Type: map<string,string>

Post-shanduro yemazwi anodarika. Shoko-muganho kuziva (kubata C++, .NET).

categoryId

Type: string

Azure Custom Translator chikamu — yako indasitiri / domain knob (zviri pamutemo, zvekurapa, kushambadzira toni, nezvimwewo). Yakatumirwa ?category=....

textType

Type: "plain" | "html"

Kukundikana plain. Shandisa html chete kana zviwanikwa zvako zviine chaiyo HTML zvidimbu.

profanityAction

Type: "NoAction" | "Marked" | "Deleted"

Nzira yekugadzirisa sei mazwi akashata mushanduro?

profanityMarker

Type: "Asterisk" | "Tag"

Izvo zvinongobatsira chete kana profanityAction "Marked".

allowFallback

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

Type: string

Translator REST API version. Kukundikana 3.0.

awsFormality

Type: "FORMAL" | "INFORMAL"

AWS Translate formality setting for supported target languages.

awsBrevity

Type: boolean

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

awsTerminologyNames / awsParallelDataNames

Type: string[]

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

googleModel

Type: string

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

googleApiEndpoint

Type: string

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Type: boolean

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

maxRetries

Type: integer

● Yakanyanya kuedza kuedza pane yenguva pfupi HTTP mhinduro (408, 425, 429, 500, 502, 503, 504). Kukundikana 5. Yese HTTP kufona pachikumbiro 1 + maxRetries.

retryBackoffMs

Type: integer

Dzvanya pano kuti uone chero chinhu chisina kukodzera kurara. Kukundikana 30000. Azure's Retry-After header inokudzwa chaizvo kana iripo; zvikasadaro, jittered exponential backoff inoshandiswa, yakavharwa pakukosha uku.

protectPlaceholders

Type: boolean

Kukundikana true. Kana iripo, zviratidzo zvakaita se {{name}}, ${var}, {0}, {0:N2}, %s, %1$s uye HTML masangano anotsiviwa nezviratidzo zvesentinel zvisati zvashandurwa uye kudzoreredzwa mushure. Disable only when source intentionally contains placeholder-shaped literals.

customPlaceholderPatterns

Type: string[]

Mamwe regex mapatani (pasina delimiters) akawedzerwa kune default placeholder seti, semuenzaniso <<.+?>> yetsika chiratidzo syntax. Regexes dzisina kukodzera dzinofuratirwa.

noTranslatePatterns

Type: string[]

Glob mapatani anoenderana neparser-level makiyi (JSON dotted path, RESX name, PO msgid, XLIFF unit id, INI / restext kiyi). Makiyi anowirirana anodonhedzwa kubva pachikumbiro uye anopfuura nekukosha kwavo kunobva kwakachengetedzwa.

changeDetection

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

Type: string

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

Kurodha kurodha

Chiito chinoverenga zvakajeka zvinongedzo kubva kubasa.
Inotakura iyo YAML config kubva configPath.
Kune yega yega yakagovaniswa munda, iyo yekupinza inokunda; Zvikasadaro, kukosha kweYAML kunoshandiswa.
Zviyero zvakabatanidzwa zvinosimbiswa. Zvishandiso zvisina kukodzera (semuenzaniso profanityAction: Mask) zvinokonzeresa kuti chiito chikundikane nekukurumidza neshoko rakajeka.

Toni uye indasitiri mune yakajeka mazwi

Iyo Azure AI Muturikiri v3 API haina imwechete toni knob. Zvirongwa zviviri zvinobatana kuti zvikupe iwe yakawanda yekutonga kwakafanana:

Indasitiri / Domain: shandisa categoryId kunongedzera kuchikamu cheAzure Custom Translator chakadzidziswa pane yako corpus — zviri pamutemo, zvehunyanzvi, zvekurapa, kushambadzira, kana chero chimwe chinhu. Iyi ndiyo yakasimba lever yetoni, izwi rechiratidzo, uye mazwi.
Zvinyorwa zvepamusoro: Shandisa Glossary kukiya mazita emhando uye mazwi echigadzirwa verbatim, uye shandisa profanityAction kupukuta mazwi anosemesa kana uchitarisa nzvimbo kune vateereri vadiki.

Sarudza mutauro wako

Repository configuration

Schema

Field reference

Kurodha kurodha

Toni uye indasitiri mune yakajeka mazwi