Inputs & Outputs · Umusemuzi w'Ibikoresho

See Configuration for the YAML schema and loading order.

Ibikoresho bikenewe

sourceLocale

Source locale (e.g. en) used to find resource files such as **/*.en.resx. Urwo rubanza narwo rukaba rwarungitswe n'umushikiranganji w'intwaro yo hagati mu gihugu nk'uko from=<locale>.

Provider selection & credentials

Choose one provider per run with provider. Tanga gusa impapuro z'umutanga watowe - raba Inputs & Outputs guide for full setup.

provider

Default: azure

Traduction: azure (default), aws, or google. Umwe gusa ni we akoresha imbuga ngurukanabumenyi.

subscriptionKey

Default: Nta n'umwe

Azure AI Translator subscription key. Bisaba azure. Pass via secrets.

endpoint

Default: Nta n'umwe

Azure Translator endpoint URL, e.g. https://api.cognitive.microsofttranslator.com/. Bikenewe kugira ngo azure.

awsAccessKeyId

Default: Nta n'umwe

Ikebukuro Ikebukuro Key ID Optional — omit (with awsSecretAccessKey) to use the AWS default credential chain / OIDC. Pass via secrets.

awsSecretAccessKey

Default: Nta n'umwe

Ibanga ry'ibanga rya AWS Ategerezwa gutangwa hamwe n'awsAccessKeyId. Pass via secrets.

awsSessionToken

Default: Nta n'umwe

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

awsRegion

Default: Nta n'umwe

Akarere ka Rusizi mu Murenge wa Busasamana mu Karere ka Nyarugenge (us-east-1 Ifoto/Umurengezi R) Birakenewe aws kiretse AWS_REGION bitegekanijwe mu bidukikije.

awsFormality

Default: Nta n'umwe

AWS Translate formality setting: FORMAL or INFORMAL.

awsBrevity

Default: Nta n'umwe

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

awsTerminologyNames

Default: Nta n'umwe

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

awsParallelDataNames

Default: Nta n'umwe

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

googleApiKey

Default: Nta n'umwe

Google Cloud API key. Tanga iyi OR googleCredentials google. Pass via secrets.

googleCredentials

Default: Nta n'umwe

Google Cloud service-account key as a JSON string. Tanga iyi OR googleApiKey google. Pass via secrets.

googleProjectId

Default: Nta n'umwe

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

googleModel

Default: Nta n'umwe

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

googleApiEndpoint

Default: Nta n'umwe

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Default: Nta n'umwe

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

Common optional inputs

region

Default: Nta n'umwe

Translator resource region (omit for global resources).

toLocales

Default: Bose barashigikiye

Traduzione Yamagishi Yemera urupapuro rwa JSON (["fr","de"]) canke inyuguti zitandukanywa na koma.

include

Default: Nta n'umwe

Newline-separated glob patterns; Ibiharuro bihuza gusa ni vyo bihindurwa.

exclude

Default: Nta n'umwe

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

configPath

Default: .github/resource-translator.yml

Inzira ya YAML config file (ijanye n'umuzi w'akazi).

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

Mu gihe true, nuce uhindura ivyiyumviro vyawe n'ivyiyumviro vyawe, ariko ntugire ico wanditse.

failOnError

Default: true

Mu gihe true amakosa atari yitezwe; Mu gihe false, amakosa aba ari ingabisho.

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); Izindi zose ni Azure-only. Umwe wese ni we yihitiyemwo; the Translator defaults apply when unset.

categoryId

Default: general

Azure Custom Translator category — the industry/domain/tone knob. Yoherejwe nk'uko ?category=....

textType

Default: plain

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

profanityAction

Default: NoAction

NoAction, Marked canke Deleted. Raba ingene amajambo y'urukozasoni akoreshwa mu majambo y'ubuhinduzi.

profanityMarker

Default: Asterisk

Asterisk canke Tag. Ni ikintu gihambaye gusa igihe profanityAction Marked.

allowFallback

Default: true (Translator default)

Mu gihe false, umuhinduzi asubiza ikosa aho gusubira muri sisitemu rusangi mu gihe categoryId yawe idafise ikibanza c'ihangiro.

apiVersion

Default: 3.0

Translator REST API version.

Resilience & placeholder protection

Ivyo vyinjizwa bigenzura ingene igikorwa gikora igihe Umuhinduzi ahagarika ubusabe bwawe n'ingene akingira ibimenyetso vy'ikibanza nka {{name}} canke {0} kugira ngo ntibibe vyoroshe mu gihe c'ubuhinduzi.

maxRetries

Default: 5

Maximum retry attempts on transient HTTP responses (408, 425, 429, 500, 502, 503, 504). Igitigiri c'abahamagara HTTP kuri buri sabwa ni 1 + maxRetries.

retryBackoffMs

Default: 30000

Cap (in milliseconds) on any single backoff sleep. Ico gikorwa giha icubahiro umutwe w'inyishu ya Retry-After wa Azure mu gihe kiriho; otherwise it uses jittered exponential backoff capped at this value.

protectPlaceholders

Default: true

Mu gihe true (default), placeholders nka {{name}}, ${var}, {0}, {0:N2}, %s, %1$s na HTML zisubirizwa n'ibimenyetso vya sentinel imbere yo guhindurwa hanyuma bigasubizwa nyuma. Disable only when your source intentionally contains literal placeholder-shaped text that should be translated.

customPlaceholderPatterns

Default: Nta n'umwe

Newline-separated regexes (without delimiters) yongerewe kuri placeholder set, nk'akarorero <<.+?>> ya syntaxe y'ibimenyetso bisanzwe.

noTranslatePatterns

Default: Nta n'umwe

Newline-separated glob patterns matched against parser-level keys (JSON dotted path, RESX name, PO msgid, XLIFF unit id, INI / restext key). Imfunguzo zihuza zikurwa ku busabe bw'umusemuzi hanyuma zigaca hamwe n'agaciro kazo k'inkomoko zibikwa.

Ivyavuyemwo

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' igihe hasohotse imwe canke nyinshi muri Bibiliya nshasha?