Inputs & outputs · Resource Translator

See Sebopego for the YAML schema and loading order.

Ditsenyo tše di nyakegago

sourceLocale

Lefelo la lefelo (mohlala, en) leo le šomišwago go hwetša difaele tša methopo tša go swana le **/*.en.resx. E romelwa gape go moabi wa ditirelo bjalo ka ge from=<locale>.

Provider selection & credentials

Kgetha mofani ka provider. Fana fela ka mangwalo a boitsebišo a moabi yo a kgethilwego — bona tlhahli ya Inputs & outputs ya go hloma ka botlalo.

provider

Default: azure

Phetolelo: azure (default), aws, goba google. Ke moabi o tee fela yo a hwetšagalago go ya ka mogala wo mongwe le wo mongwe.

subscriptionKey

Default: Ga go na

Azure AI Translator subscription key. Se se nyakegago bakeng sa azure. Go Pass secrets.

endpoint

Default: Ga go na

Azure Translator endpoint URL, mohlala, https://api.cognitive.microsofttranslator.com/. Se se nyakegago bakeng sa azure.

awsAccessKeyId

Default: Ga go na

Lego Ninjago Key Id. Optional — omit (with awsSecretAccessKey) to use the AWS default credential chain / OIDC. Go Pass secrets.

awsSecretAccessKey

Default: Ga go na

Lego Nexo Knights Key E swanetše go romelwa gotee le awsAccessKeyId. Go Pass secrets.

awsSessionToken

Default: Ga go na

Optional AWS session token for temporary credentials. Go Pass secrets.

awsRegion

Default: Ga go na

Kgopelo ya phihlelelo ya Kgoro ya Merero ya Selegae (mohlala, us-east-1). E swanetše go dirwa aws ka ntle le ge AWS_REGION e beilwe ka gare ga tikologo.

awsFormality

Default: Ga go na

AWS Translate formality setting: FORMAL or INFORMAL.

awsBrevity

Default: Ga go na

When true, enables AWS Translate brevity mode for supported language pairs.

awsTerminologyNames

Default: Ga go na

AWS Translate custom terminology resource names. Accepts a JSON array or comma-separated values.

awsParallelDataNames

Default: Ga go na

AWS Translate parallel data resource names. Accepts a JSON array or comma-separated values.

googleApiKey

Default: Ga go na

Google Cloud API key. Fana ka se goba googleCredentials go google. Go Pass secrets.

googleCredentials

Default: Ga go na

Senotlelo sa akhaonte ya tirelo ya leru la Google bjalo ka thapo ya JSON. Fana ka se goba googleApiKey go google. Go Pass secrets.

googleProjectId

Default: Ga go na

Optional Google Cloud project id. Ka tlwaelo e hwetšwa go tšwa go setifikeiti sa akhaonte ya tirelo.

googleModel

Default: Ga go na

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

googleApiEndpoint

Default: Ga go na

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Default: Ga go na

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

Common optional inputs

region

Default: Ga go na

Translator resource region (omit for global resources).

toLocales

Default: Ka moka di thekgwa

Go Tradução Go E amogela dinomoro tša JSON array (["fr","de"]) goba dikholego tše di arogantšwego ke koma.

include

Default: Ga go na

Newline-separated glob patterns; Ke fela ditokomane tšeo di fetoletšwego go ya ka diphetolelo.

exclude

Default: Ga go na

Newline-separated glob patterns; Ditokumente tša go fapafapana di a tlošwa (di dirilwe ka morago ga go akaretšwa).

configPath

Default: .github/resource-translator.yml

Tsela ya go ya go YAML config file (mabapi le modu wa mošomo).

changeDetection

Default: smart

Smart change detection mode. smart translates only keys whose source value, target presence, state entry, or translation-affecting settings require it. Use disabled or false to send every eligible key on every run.

statePath

Default: .github/resource-translator-state.json

Path to the compact deterministic smart change-detection state manifest. Defaults to .github/resource-translator-state.json; commit it so future runs can audit and reuse unchanged translations.

snapshotOnly

Default: false

When true, create/update the smart change-detection manifest from existing source and target files without calling a translation provider or writing target resource files. Useful when bootstrapping statePath while a provider is unavailable.

dryRun

Default: false

Ge true, ngwala diphetolelo le go ngwala dingwalwa tše dintši eupša o se ke wa ngwala dingwalwa.

failOnError

Default: true

Ge true, diphošo tšeo di sa letelwago di palelwa ke kgato; Ge false, diphošo di a lemošwa.

Azure Translator request inputs

These map directly into Azure AI Translator v3 query parameters and apply to the azure provider. textType and profanityAction are also mapped to AWS/Google where an equivalent exists (see the providers guide); tše dingwe ka moka ke tša Azure. Ye nngwe le ye nngwe ke ya boikgethelo; Mofetoledi o palelwa ke go fetolela ge a sa šome.

categoryId

Default: general

Azure Custom Translator category — the industry/domain/tone knob. E tšweleditšwe bjalo ka ?category=....

textType

Default: plain

plain goba html. Use html only when your resource values are real HTML fragments.

profanityAction

Default: NoAction

NoAction, Marked goba Deleted. Lemoga ka moo diphetolelo di tšwelelago ka gona mo diphetolelong.

profanityMarker

Default: Asterisk

Asterisk goba Tag. E na le mohola fela ge profanityAction Marked.

allowFallback

Default: True (Translator default)

Ge false, mofetoledi o bušetša phošo sebakeng sa go wela morago go tshepedišo ya kakaretšo ge categoryId ya gago e se na kabo ya lefelo leo le lebeletšwego.

apiVersion

Default: 3.0

Translator REST API version.

Kgotlelelo le tšhireletšo ya placeholder

These inputs control how the action behaves when Translator throttles your request and how it shields placeholder tokens like {{name}} or {0} from being mangled during translation.

maxRetries

Default: 5

Maximum retry attempts on transient HTTP responses (408, 425, 429, 500, 502, 503, 504). Palomoka ya dikgopelo tša GEMS ka kgopelo ke 1 + maxRetries.

retryBackoffMs

Default: 30000

Cap (in milliseconds) on any single backoff sleep. Tiro e hlompha Azure's Retry-After response header exactly when present; otherwise it uses jittered exponential backoff capped at this value.

protectPlaceholders

Default: true

When true (default), placeholders such as {{name}}, ${var}, {0}, {0:N2}, %s, %1$s and HTML entities are replaced with sentinel tokens before translation and restored later. Disable only when your source intentionally contains literal placeholder-shaped text that should be translated.

customPlaceholderPatterns

Default: Ga go na

Newline-separated regexes (without delimiters) added to the default placeholder set, e.g. <<.+?>> for custom token syntax.

noTranslatePatterns

Default: Ga go na

Newline-separated glob patterns matched against parser-level keys (JSON dotted path, RESX name, PO msgid, XLIFF unit id, INI/restext key). Dinotlelo tša go sepelelana di tlošwa go tšwa go kgopelo ya Mofetoledi gomme di fetišetšwa ka boleng bja tšona bja mothopo bo bolokilwe.

Dipoelo

summary-title

Short PR-title-friendly summary, e.g. Machine-translated 320 files, a total of 5,418 translations.

summary-details

Markdown summary suitable for a PR body or job summary.

has-new-translations

'true' ge e le gore phetolelo e tee goba tše pedi tše mpsha di tšweleditšwe.