Konfiguration · Resursöversättare

Överskriv vägen med configPath-ingången om du behöver en icke-standardplats.

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

Fältreferens

provider

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

Typ: string

Den faller tillbaka till sourceLocale ingång om den inte är inställd. Vidarebefordrade också till Translator som from=<locale> så att korta strängar inte automatiskt upptäcks.

toLocales

Typ: string[]

Antingen en array eller en kommaseparerad sträng.

include / exclude

Typ: string[]

Globmönster utvärderade mot absoluta och arbetsområdesrelativa vägar.

glossary

Typ: map<string,string>

Termöverskridande efter översättning. Ordgränsmedveten (hanterar C++, .NET).

categoryId

Typ: string

Azure Custom Translator kategori — din bransch-/domänknopp (juridisk, medicinsk, marknadsföringston, etc.). Skickad som ?category=....

textType

Typ: "plain" | "html"

Standardinställningen är plain. Använd html endast om dina resursvärden innehåller riktiga HTML-fragment.

profanityAction

Typ: "NoAction" | "Marked" | "Deleted"

Hur man behandlar grova termer i översatt utfall.

profanityMarker

Typ: "Asterisk" | "Tag"

Endast meningsfullt när profanityAction är "Marked".

allowFallback

Typ: boolean

Ställ in på false att misslyckas med översättningen när din categoryId inte har någon distribution för en mållokal istället för att falla tillbaka på den allmänna modellen.

apiVersion

Typ: string

Translator REST API-version. Standardinställningen är 3.0.

awsFormality

Typ: "FORMAL" | "INFORMAL"

AWS Translate formality setting for supported target languages.

awsBrevity

Typ: boolean

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

awsTerminologyNames / awsParallelDataNames

Typ: string[]

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

googleModel

Typ: string

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

googleApiEndpoint

Typ: string

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Typ: boolean

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

maxRetries

Typ: integer

Maximala försök på tillfälliga HTTP-svar (408, 425, 429, 500, 502, 503, 504). Ställer sig till 5. Totalt antal HTTP-anrop per förfrågan är 1 + maxRetries.

retryBackoffMs

Typ: integer

Gräns (MS) på vilken enkel backoff-sömn som helst. Standardinställningen är 30000. Azures Retry-After rubrik är precis när den är närvarande; annars används jitterad exponentiell backoff, med ett tak på detta värde.

protectPlaceholders

Typ: boolean

Standardinställningen är true. När de är aktiverade ersätts tokens som {{name}}, ${var}, {0}, {0:N2}, %s, %1$s och HTML-entiteter med sentinel-tokens före översättning och återställs efteråt. Inaktivera endast när källan medvetet innehåller platshållarformade literals.

customPlaceholderPatterns

Typ: string[]

Extra regex-mönster (utan avgränsare) lades till standardplatshållaren, t.ex. <<.+?>> för anpassad tokensyntax. Ogiltiga regex-registreringar ignoreras.

noTranslatePatterns

Typ: string[]

Glob-mönster matchade mot parser-nivånycklar (JSON prickad path, RESX name, PO msgid, XLIFF unit id, INI/restext-nyckel). Matchande nycklar tas bort från förfrågan och skickas vidare med sitt källvärde bevarat.

changeDetection

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

Typ: string

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

Lastordning

Åtgärden läser explicita indata från arbetsflödet.
Den laddar YAML-konfigurationen från configPath.
För varje delat fält vinner indatan; annars används YAML-värdet.
De sammanslagna värdena valideras. Ogiltiga enums (t.ex. profanityAction: Mask) gör att åtgärden misslyckas snabbt med ett tydligt meddelande.

Ton och industri, i klara termer

Azure AI Translator v3 API har inte en enda tonratt. Två inställningar kombineras för att ge dig nästan samma kontroll:

Bransch / område: använd categoryId för att peka på en Azure Custom Translator-kategori som tränas på ditt eget korpus — juridisk, teknisk, medicinsk, marknadsförande eller något annat. Detta är den starkaste hävstången för ton, varumärkesröst och ordförråd.
Yttext: Använd Ordlista för att låsa varumärken och produkttermer ordagrant, och använd profanityAction för att rensa bort grova termer när du riktar lokalisering till yngre målgrupper.

Välj ditt språk

Repository-konfiguration

Schema

Fältreferens

Lastordning

Ton och industri, i klara termer