Inputs & outputs · Resource Translator

See Enteekateeka for the YAML schema and loading order.

Ebikozesebwa ebyetaagisa

sourceLocale

Source locale (e.g. en) used to find resource files such as **/*.en.resx. Era yasindikibwa eri omuwaabi nga from=<locale>.

Provider selection & credentials

Choose one provider per run with provider. Supply only the selected provider's credentials — see the Inputs & outputs guide for full setup.

provider

Default: azure

Okuvvuunula: azure (default), aws, oba google. Omuweereza omu yekka y'akozesebwa ku buli kuyita kw'ekikolwa.

subscriptionKey

Default: Tewali

Azure AI Translator subscription key. Obwetaavu bw'azure bye bye secrets

endpoint

Default: Tewali

Azure Translator endpoint URL, e.g. https://api.cognitive.microsofttranslator.com/. Bye bye azure

awsAccessKeyId

Default: Tewali

AWS access key ID. Optional — omit (with awsSecretAccessKey) to use the AWS default credential chain / OIDC. bye bye secrets

awsSecretAccessKey

Default: Tewali

Kyama Kyama Kyagulanyi Ssentamu Ateekwa okuba ng'ali wamu n'awsAccessKeyId. bye bye secrets

awsSessionToken

Default: Tewali

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

awsRegion

Default: Tewali

Akakiiko k'ebyokulonda kategeezezza nti akakiiko k'ebyokulonda kategeezezza nti akakiiko k'ebyokulonda kategeezezza us-east-1 nti akakiiko k'ebyokulonda kategeezezza nti Okuggyako ng'aws kikolebwa mu ngeri ey'enjawulo okuggyako ng'AWS_REGION mu mbeera y'obutonde bw'ensi.

awsFormality

Default: Tewali

AWS Translate formality setting: FORMAL or INFORMAL.

awsBrevity

Default: Tewali

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

awsTerminologyNames

Default: Tewali

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

awsParallelDataNames

Default: Tewali

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

googleApiKey

Default: Tewali

Google Cloud API key. Kitegeeza nga bwâ€TMonootera googleCredentials google â€TMolina. Pass through secrets.

googleCredentials

Default: Tewali

Google Cloud service-account key as a JSON string. Kitegeeza nga bwâ€TMonootera googleApiKey google â€TMolina. Pass through secrets.

googleProjectId

Default: Tewali

Optional Google Cloud project id. Usually inferred from the service-account credential.

googleModel

Default: Tewali

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

googleApiEndpoint

Default: Tewali

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Default: Tewali

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

Common optional inputs

region

Default: Tewali

Translator resource region (omit for global resources).

toLocales

Default: Bonna bawagira

Ebifo by'okuvvuunula Mu ngeri y'emu, kiwandikawo ennamba ya JSON (["fr","de"]) oba emiwendo egy'enjawulo egy'enjawulo.

include

Default: Tewali

Newline-separated glob patterns; Ebiwandiiko ebikwatagana byokka bye bivvuunulwa.

exclude

Default: Tewali

Newline-separated glob patterns; matching files are skipped (applied after include).

configPath

Default: .github/resource-translator.yml

Mu ngeri y'emu, ekifaananyi ky'

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

Bw'true okuvvuunula n'okuvvuunula ebiwandiiko naye towandiika biwandiiko.

failOnError

Default: true

When true, unexpected errors fail the action; Bwe false, ensobi ziba kulabula.

Azure Translator request inputs

These map directly on Azure AI Translator v3 query parameters and apply to the Azure provider. textType and profanityAction are also mapped to AWS/Google where an equivalent exist (see the providers guide); Ebisigadde bya Azure byokka. Buli kimu kiba kya kusalawo; the Translator defaults apply when unset.

categoryId

Default: general

Azure Custom Translator category — the industry/domain/tone knob. Mu ngeri y'emu n'atuuka ku ntikko ng'?category=....

textType

Default: plain

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

profanityAction

Default: NoAction

NoAction, Marked, oba Deleted. Mu ngeri y'emu, Bayibuli eraga engeri ebigambo ebivvuunulwa gye bikozesebwa mu kuvvuunula.

profanityMarker

Default: Asterisk

Asterisk oba Tag. Kitegeeza nga profanityAction Marked.

allowFallback

Default: true (Translator default)

When false, Translator returns an error instead of falling back to the general system if your categoryId has no deployment for a target locale.

apiVersion

Default: 3.0

Translator REST API version.

Obugumiikiriza n'obukuumi bw'ebifo

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). Omuwendo gw'essimu za HTTP buli kusaba guli 1 + maxRetries.

retryBackoffMs

Default: 30000

Cap (in milliseconds) on any single backoff sleep. Ekikolwa kino kiwa ekitiibwa omutwe gwa Azure's Retry-After response kyennyini nga kiriwo; 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: Tewali

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

noTranslatePatterns

Default: Tewali

Newline-divided glob patterns matched against parser-level keys (JSON dotted path, RESX name, PO msgid, XLIFF unit id, INI/restext key). Matching keys are dropped from the Translator request and pass through with their source value preserved.

Ebivaamu

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' lwe baafulumizibwa enkyusa emu oba okusingawo empya.