Enteekateeka · Resource Translator

configPath Bwâ€TMoba weetaaga akawuka akaleeta siriimu, bwâ€TMoba weetaaga akawuka akaleeta siriimu.

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

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

Ekika: string

Okudda mu sourceLocale bw'eba nga teyateekebwawo. Also forwarded to Translator as from=<locale> so short strings are not autodetected.

toLocales

Ekika: string[]

Oba ng'ekitundu eky'enjawulo oba eky'omulembe eky'enjawulo eky'omuwendo gw'abazannyi ba Cranes.

include / exclude

Ekika: string[]

Glob patterns tested against absolute and workspace-relative paths.

glossary

Ekika: map<string,string>

Post-translation term overrides. Word-boundary aware (handles C++, .NET).

categoryId

Ekika: string

Azure Custom Translator category — your industry/domain knob (legal, medical, marketing tone, etc.). Sent as ?category=....

textType

Ekika: "plain" | "html"

Okulemererwa plain Use html only if your resource values contain real HTML fragments.

profanityAction

Ekika: "NoAction" | "Marked" | "Deleted"

Engeri gy'oyinza okuvvuunula ebigambo ebitali bimu mu kuvvuunula ebitabo by'Obusiraamu?

profanityMarker

Ekika: "Asterisk" | "Tag"

Only meaningful when profanityAction is "Marked".

allowFallback

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

Ekika: string

Translator REST API version. Okulemererwa 3.0

awsFormality

Ekika: "FORMAL" | "INFORMAL"

AWS Translate formality setting for supported target languages.

awsBrevity

Ekika: boolean

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

awsTerminologyNames / awsParallelDataNames

Ekika: string[]

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

googleModel

Ekika: string

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

googleApiEndpoint

Ekika: string

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Ekika: boolean

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

maxRetries

Ekika: integer

Maximum retry attempts on transient HTTP responses (408, 425, 429, 500, 502, 503, 504). Okulemererwa okutuukiriza 5. Total HTTP calls per request is 1 + maxRetries.

retryBackoffMs

Ekika: integer

Dil Ki Awaaz Okulemererwa 30000 Azure's Retry-After header is honored exactly when exist; otherwise jittered exponential backoff is used, capped at this value.

protectPlaceholders

Ekika: boolean

Okulemererwa true Obubonero nga {{name}}, ${var}, {0}, {0:N2}, %s, %1$s ne HTML bukyusibwa n'obubonero bwa sentinel nga tebunnaba kuvvuunulwa era ne buzzibwayo oluvannyuma. Disable only when source intentionally contains placeholder-shaped literals.

customPlaceholderPatterns

Ekika: string[]

Endagaano ez'enjawulo (nga tezirina delimiters) zongeddwako ku seti y'ekifo eky'enjawulo, e.g. <<.+?>> for custom token syntax. Invalid regexes are ignored.

noTranslatePatterns

Ekika: string[]

Obubonero bwa Glob bukwatagana n'ebisumuluzo eby'omutendera ogwa parser (JSON dotted path, RESX name, PO msgid, XLIFF unit id, INI/restext key). Matching keys are dropped from the request and pass through with their source value preserved.

changeDetection

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

Ekika: string

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

Loading order

The action reads explicit inputs from the workflow.
It loads the YAML config from configPath.
For every shared field, the input wins; Bw'oba tokozesezza omuwendo gwa YAML gukozesebwa.
The merged values are validated. Obubaka obutali butuufu (e.g. profanityAction: Mask) buleetera ekikolwa okulemererwa mangu n'obubaka obutegeerekeka.

Tone and industry, in plain terms

S3 Ssabasajja Kabaka Muteesa I Ssabasajja Kabaka Muteesa I S3 Tekirina Ssabasajja Kabaka Yekka - Watchdog Uganda Two settings together to give you most of the same control:

Industry / domain: Use categoryId to point at an Azure Custom Translator category trained on your own corpus — legal, technical, medical, marketing, or anything else. Eno y'enkola esinga amaanyi mu ddoboozi lya langi n'olulimi lw'eggwanga.
Surface text: Use the Glossary to lock brand names and product terms verbatim, and use profanityAction to scrub profane terms when targeting localization for young audiences.

Londa olulimi lw'okozesa

Enteekateeka y'okutereka

Schema

Field reference

Loading order

Tone and industry, in plain terms