Entradas e saídas · Tradutor de Recursos

Veja Configuração para o esquema YAML e a ordem de carregamento.

Entradas necessárias

sourceLocale

Local de origem (por exemplo, en) usado para encontrar arquivos de recursos como **/*.en.resx. Também encaminhado para o provedor como from=<locale>.

Seleção de provedores e credenciais

Escolha um provedor por sessão com provider. Forneça apenas as credenciais do provedor selecionado — veja o guia Entradas e saídas para a configuração completa.

provider

Padrão: azure

Provedor de tradução: azure (padrão), aws ou google. Apenas um provedor é usado por chamada de ação.

subscriptionKey

Padrão: nenhum

Chave de assinatura Azure AI Translator. Necessário para azure. Passe pela secrets.

endpoint

Padrão: nenhum

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

awsAccessKeyId

Padrão: nenhum

ID da chave de acesso AWS. Opcional — omitir (com awsSecretAccessKey) usar a cadeia de credenciais padrão da AWS / OIDC. Passe pela secrets.

awsSecretAccessKey

Padrão: nenhum

Chave de acesso secreto da AWS. Deve ser fornecida junto com awsAccessKeyId. Passe pela secrets.

awsSessionToken

Padrão: nenhum

Token opcional de sessão AWS para credenciais temporárias. Passe pela secrets.

awsRegion

Padrão: nenhum

Região AWS para o serviço Translate (por exemplo, us-east-1). Exigido para aws, a menos que AWS_REGION seja ambientado no ambiente.

awsFormality

Padrão: nenhum

AWS Translate formality setting: FORMAL or INFORMAL.

awsBrevity

Padrão: nenhum

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

awsTerminologyNames

Padrão: nenhum

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

awsParallelDataNames

Padrão: nenhum

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

googleApiKey

Padrão: nenhum

Chave API do Google Cloud. Forneça este googleCredentials de sala de cirurgia para google. Passe por secrets.

googleCredentials

Padrão: nenhum

Chave de conta do serviço Google Cloud como uma string JSON. Forneça este googleApiKey de sala de cirurgia para google. Passe por secrets.

googleProjectId

Padrão: nenhum

ID de projeto opcional do Google Cloud. Geralmente inferido a partir da credencial da conta de serviço.

googleModel

Padrão: nenhum

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

googleApiEndpoint

Padrão: nenhum

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Padrão: nenhum

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

Entradas opcionais comuns

region

Padrão: nenhum

Região de recursos tradutores (omitir recursos globais).

toLocales

Padrão: todos suportados

Locais para traduzir. Aceita um array JSON (["fr","de"]) ou valores separados por vírgula.

include

Padrão: nenhum

Padrões de glóbulos separados por linhas novas; apenas arquivos correspondentes são traduzidos.

exclude

Padrão: nenhum

Padrões de glóbulos separados por linhas novas; Os arquivos correspondentes são pulados (aplicados após o include).

configPath

Padrão: .github/resource-translator.yml

Caminho para o arquivo de configuração YAML (relativo à raiz do workspace).

changeDetection

Padrão: 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

Padrão: .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

Padrão: 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

Padrão: false

Quando true, execute traduções e emita resumos, mas não escreva arquivos.

failOnError

Padrão: true

Quando true, erros inesperados falham na ação; Quando false, erros são avisos.

Entradas de solicitação do Azure Translator

Esses parâmetros de consulta do Azure AI Translator v3 são direcionados diretamente para o provedor Azure. textType e profanityAction também são mapeados para AWS/Google onde existe um equivalente (veja o guia de provedores); o restante é apenas Azure. Cada um é opcional; os padrões do tradutor se aplicam quando não estão definidos.

categoryId

Padrão: general

Azure Custom Translator category — o botão industry/domain/ton. Encaminhado como ?category=....

textType

Padrão: plain

plain ou html. Use html apenas quando seus valores de recursos forem fragmentos reais de HTML.

profanityAction

Padrão: NoAction

NoAction, Marked ou Deleted. Controle como termos profanos são emitidos nas traduções.

profanityMarker

Padrão: Asterisk

Asterisk ou Tag. Só significa quando profanityAction é Marked.

allowFallback

Padrão: true (padrão do tradutor)

Quando false, o tradutor retorna um erro em vez de recorrer ao sistema geral se sua categoryId não tiver deployment para um local de destino.

apiVersion

Padrão: 3.0

Versão da API REST do tradutor.

Resiliência e proteção provisória

Essas entradas controlam como a ação se comporta quando o Tradutor limita sua solicitação e como ele protege tokens provisórios como {{name}} ou {0} de serem manipulados durante a tradução.

maxRetries

Padrão: 5

Máximo de tentativas em respostas HTTP transitórias (408, 425, 429, 500, 502, 503, 504). O número total de chamadas HTTP por requisição é 1 + maxRetries.

retryBackoffMs

Padrão: 30000

Limite (em milissegundos) qualquer sono de recuo. A ação honra o cabeçalho de resposta Retry-After do Azure exatamente quando presente; caso contrário, usa um backoff exponencial com tremor limitado a esse valor.

protectPlaceholders

Padrão: true

Quando true (padrão), marcadores como {{name}}, ${var}, {0}, {0:N2}, %s, %1$s e HTML são substituídos por tokens sentinela antes da tradução e restaurados posteriormente. Desative somente quando sua fonte intencionalmente contiver texto literal em forma de marcador que deva ser traduzido.

customPlaceholderPatterns

Padrão: nenhum

Regexes separados por novas linhas (sem delimitadores) adicionados ao conjunto padrão de marcadores de posição, por exemplo, <<.+?>> para sintaxe personalizada de tokens.

noTranslatePatterns

Padrão: nenhum

Padrões globos separados por novas linhas correspondiam às chaves de nível de parser (JSON ponted path, RESX name, PO msgid, unidade XLIFF id, chave INI/restext). Chaves correspondentes são eliminadas da solicitação do tradutor e passam com seu valor de origem preservado.

Saídas

summary-title

Resumo curto e amigável para títulos de PR, por exemplo, Machine-translated 320 files, a total of 5,418 translations.

summary-details

Resumo de desconto adequado para um órgão de PR ou resumo de cargo.

has-new-translations

'true' quando uma ou mais novas traduções eram geradas.