Konfigurasjon · Ressursoversetter

Overstyr stien med configPath-inngangen hvis du trenger en ikke-standard plassering.

Skjema

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

Feltreferanse

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

Faller tilbake til sourceLocale inngang hvis den ikke er satt. Også videresendt til Oversetteren som from=<locale> slik at korte strenger ikke blir automatisk oppdaget.

toLocales

Type: string[]

Enten et array eller en komma-separert streng.

include / exclude

Type: string[]

Klumpmønstre evaluert mot absolutte og arbeidsplass-relative baner.

glossary

Type: map<string,string>

Overstyrer begreper etter oversettelse. Ordgrensebevisst (håndterer C++, .NET).

categoryId

Type: string

Azure Custom Translator kategori — din bransje-/domeneknop (juridisk, medisinsk, markedsføringstone, osv.). Sendt som ?category=....

textType

Type: "plain" | "html"

Som standard er plain. Bruk html kun hvis ressursverdiene dine inneholder ekte HTML-fragmenter.

profanityAction

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

Hvordan behandle grove uttrykk i oversatt output.

profanityMarker

Type: "Asterisk" | "Tag"

Bare meningsfull når profanityAction er "Marked".

allowFallback

Type: boolean

Sett til false å feile oversettelsen når categoryId ikke har distribusjon for et målområde, i stedet for å falle tilbake til den generelle modellen.

apiVersion

Type: string

Oversetter REST API-versjon. Som standard er 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

Maksimalt antall forsøk på midlertidig HTTP-respons (408, 425, 429, 500, 502, 503, 504). Går som standard til 5. Totalt antall HTTP-anrop per forespørsel er 1 + maxRetries.

retryBackoffMs

Type: integer

Begrens (MS) på enhver enkelt backoff-søvn. Som standard er 30000. Azures Retry-After header blir respektert nøyaktig når den er til stede; ellers brukes jitteret eksponentiell backoff, begrenset til denne verdien.

protectPlaceholders

Type: boolean

Som standard er true. Når de er på, erstattes tokens som {{name}}, ${var}, {0}, {0:N2}, %s, %1$s og HTML-enheter med sentinel-tokens før oversettelse og gjenopprettes etterpå. Deaktiver kun når kilden bevisst inneholder plassholderformede bokstaver.

customPlaceholderPatterns

Type: string[]

Ekstra regex-mønstre (uten avgrensere) lagt til standard plassholder-settet, for eksempel <<.+?>> for egendefinert token-syntaks. Ugyldige regexer ignoreres.

noTranslatePatterns

Type: string[]

Glob-mønstre matchet mot parser-nivå nøkler (JSON prikket sti, RESX name, PO msgid, XLIFF enhet id, INI/restext-tast). Matchende nøkler fjernes fra forespørselen og sendes videre med kildeverdien bevart.

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.

Lasterekkefølge

Handlingen leser eksplisitte input fra arbeidsflyten.
Den laster YAML-konfigurasjonen fra configPath.
For hvert delt felt vinner inputen; ellers brukes YAML-verdien.
De sammenslåtte verdiene valideres. Ugyldige enums (f.eks. profanityAction: Mask) fører til at handlingen feiler raskt med en klar melding.

Tone og industri, enkelt sagt

Azure AI Translator v3 API har ikke en enkelt toneknapp. To innstillinger kombineres for å gi deg det meste av samme kontroll:

Bransje / område: bruk categoryId til å peke på en Azure Custom Translator-kategori som er trent på ditt eget korpus — juridisk, teknisk, medisinsk, markedsføringsmessig eller noe annet. Dette er den sterkeste spaken for tone, merkevarestemme og vokabular.
Overflatetekst: Bruk Ordliste for å låse merkenavn og produktbegreper ordrett, og bruk profanityAction for å fjerne grove uttrykk når du retter lokalisering mot yngre målgrupper.

Velg ditt språk

Repository-konfigurasjon

Skjema

Feltreferanse

Lasterekkefølge

Tone og industri, enkelt sagt