Entradas e saídas · Tradutor de recursos

Vexa Configuración para o esquema YAML e a orde de carga.

Entradas necesarias

sourceLocale

Localización de orixe (por exemplo, en) usada para atopar ficheiros de recursos como **/*.en.resx. Tamén se remite ao provedor como from=<locale>.

Selección de provedores e credenciais

Escolla un provedor por cada carreira con provider. Proporciona só as credenciais do provedor seleccionado — consulta a guía Entradas e saídas para a configuración completa.

provider

Predeterminado: azure

Provedor de tradución: azure (por defecto), aws ou google. Só se usa un provedor por chamada de acción.

subscriptionKey

Predeterminado: Ningunha

Clave de subscrición Azure AI Translator. Necesario para azure. Pasa por secrets.

endpoint

Predeterminado: Ningunha

URL de endpoint de Azure Translator, por exemplo, https://api.cognitive.microsofttranslator.com/. Necesario para azure.

awsAccessKeyId

Predeterminado: Ningunha

ID da clave de acceso AWS. Opcional — omitir (con awsSecretAccessKey) usar a cadea predeterminada de credenciais de AWS / OIDC. Pasa por secrets.

awsSecretAccessKey

Predeterminado: Ningunha

Clave de acceso secreto de AWS. Debe ser subministrado xunto con awsAccessKeyId. Pasa por secrets.

awsSessionToken

Predeterminado: Ningunha

Token opcional de sesión AWS para credenciais temporais. Pasa por secrets.

awsRegion

Predeterminado: Ningunha

AWS para o servizo Translate (por exemplo, us-east-1). É necesario para aws a menos que AWS_REGION estea ambientado no ambiente.

awsFormality

Predeterminado: Ningunha

AWS Translate formality setting: FORMAL or INFORMAL.

awsBrevity

Predeterminado: Ningunha

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

awsTerminologyNames

Predeterminado: Ningunha

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

awsParallelDataNames

Predeterminado: Ningunha

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

googleApiKey

Predeterminado: Ningunha

Clave API de Google Cloud. Proporciona esta googleCredentials de quirófano para google. Pasa por secrets.

googleCredentials

Predeterminado: Ningunha

Clave de conta do servizo Google Cloud como cadea JSON. Proporciona esta googleApiKey de quirófano para google. Pasa por secrets.

googleProjectId

Predeterminado: Ningunha

ID de proxecto opcional en Google Cloud. Xeralmente inferido a partir da credencial da conta de servizo.

googleModel

Predeterminado: Ningunha

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

googleApiEndpoint

Predeterminado: Ningunha

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Predeterminado: Ningunha

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

Entradas opcionais comúns

region

Predeterminado: Ningunha

Rexión de recursos tradutores (omitindo recursos globais).

toLocales

Predeterminado: todos soportados

Lugares aos que traducir. Acepta un array JSON (["fr","de"]) ou valores separados por comas.

include

Predeterminado: Ningunha

Patróns de globos separados por liñas novas; Só se traducen os ficheiros coincidentes.

exclude

Predeterminado: Ningunha

Patróns de globos separados por liñas novas; Os ficheiros coincidentes sáltanse (aplícanse despois de incluir).

configPath

Predeterminado: .github/resource-translator.yml

Ruta cara ao ficheiro de configuración YAML (en relación coa raíz do espazo de traballo).

changeDetection

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

Predeterminado: .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

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

Predeterminado: false

Cando true, executa traducións e emite resumos pero non escribas ficheiros.

failOnError

Predeterminado: true

Cando true, erros inesperados fallan a acción; Cando false, os erros son advertencias.

Entradas de solicitude de Azure Translator

Estes mapean directamente aos parámetros de consulta de Azure AI Translator v3 e aplícanse ao provedor de Azure. textType e profanityAction tamén se mapean a AWS/Google onde existe un equivalente (ver a guía de provedores); o resto son só Azure. Todos son opcionais; os valores predeterminados do tradutor aplícanse cando non está activado.

categoryId

Predeterminado: general

Azure Custom Translator category — o botón industry/domain/tone. Reenviado como ?category=....

textType

Predeterminado: plain

plain ou html. Usa html só cando os valores dos teus recursos sexan fragmentos HTML reais.

profanityAction

Predeterminado: NoAction

NoAction, Marked ou Deleted. Controla como se emiten termos profanes nas traducións.

profanityMarker

Predeterminado: Asterisk

Asterisk ou Tag. Só ten sentido cando profanityAction é Marked.

allowFallback

Predeterminado: true (Tradutor por defecto)

Cando false, o tradutor devolve un erro en vez de volver ao sistema xeral se o teu categoryId non ten despregamento para unha localización obxectivo.

apiVersion

Predeterminado: 3.0

Versión da API REST do tradutor.

Resiliencia e protección temporal

Estas entradas controlan como se comporta a acción cando Tradutor limita a túa solicitude e como protexe tokens provisionais como {{name}} ou {0} de ser danados durante a tradución.

maxRetries

Predeterminado: 5

Máximo de intentos de reintento en respostas HTTP transitorias (408, 425, 429, 500, 502, 503, 504). O número total de chamadas HTTP por solicitude é 1 + maxRetries.

retryBackoffMs

Predeterminado: 30000

Limita (en milisegundos) calquera sono de retroceso individual. A acción honra o encabezado de resposta Retry-After de Azure exactamente cando está presente; se non, usa un retroceso exponencial con titter limitado a este valor.

protectPlaceholders

Predeterminado: true

Cando true (por defecto), os marcadores de posición como {{name}}, ${var}, {0}, {0:N2}, %s, %1$s e entidades HTML substitúense por tokens centinela antes da tradución e restauranse despois. Desactiva só cando a túa fonte conteña intencionadamente texto literal en forma de marcador de posición que debería traducirse.

customPlaceholderPatterns

Predeterminado: Ningunha

Regex separados por liñas novas (sen delimitadores) engadidos ao conxunto predeterminado de marcadores de posición, por exemplo, <<.+?>> para sintaxe personalizada de tokens.

noTranslatePatterns

Predeterminado: Ningunha

Os patróns de globos separados por liñas novas coincidían con claves a nivel de analizador (camiño punteado JSON, name RESX, msgid PO, unidade XLIFF id, clave INI/restext). As claves coincidentes son eliminadas da solicitude do tradutor e pasan mantendo o seu valor fonte.

Saídas

summary-title

Resumo curto e amigable co título de PR, por exemplo, Machine-translated 320 files, a total of 5,418 translations.

summary-details

Resumo de desconto adecuado para un corpo de RRPP ou resumo de traballo.

has-new-translations

'true' cando se xeraron unha ou máis novas traducións.