Dica
Para informações sobre a integração do GitHub no Phrase TMS, consulte GitHub (TMS).
O Phrase Strings integra-se com repositórios GitHub para sincronizar arquivos de localização entre o Phrase e o GitHub.
Por padrão, repositórios são conectados usando um GitHub OAuth App. Tokens de acessar pessoal também são suportados e são destinados principalmente para instâncias auto-hospedadas ou ambientes onde a instalação do OAuth App não é possível.
Pré-requisitos
-
O arquivo
.phrase.ymlde configuração deve estar presente na raiz do ramo a ser monitorado. O arquivo define quais arquivos importar (pull) ou exportar (push) do repositório. -
O acesso à leitura e edição é necessário no repositório.
-
Arquivos de configuração com definição incorreta podem causar erros. Certifique-se de que o arquivo contenha pelo menos um destino de push e pull, os formatos de arquivo corretos e a configuração correta do parâmetro
update_translations. -
-
O GitHub OAuth App deve estar instalado na organização ou conta do GitHub que possui o repositório.
-
O repositório deve estar incluído na instalação do OAuth App.
-
Permissões para instalar ou autorizar GitHub Apps são necessárias na organização ou conta de tradução.
-
-
-
Tokens clássicos
Requer o escopo do repositório (
public_repose sincronizando com o repositório público) -
Tokens granulares
Requer as seguintes permissões:
-
Conteúdo: Leitura e escrita
-
Solicitação pull: Leitura e escrita
-
-
Certifique-se de que as configurações do repositório não exigem confirmações assinadas.
-
-
Se o logon único estiver ativado no GitHub, ele também precisa estar ativado para o token de acesso.
-
O ramo phrase_translations não pode ser protegido.
Nota
Devido a melhorias constantes, a interface do usuário pode não ser exatamente a mesma que é apresentada no vídeo.
Assim que o arquivo de configuração estiver no lugar, para conectar um repositório, siga estas etapas:
-
Na página , role para baixo até e clique em Configure.
A página será aberta.
-
Clique em Adicionar sincronização/GitHub.
A janela de configurações de é aberta.
-
Selecionar um projeto da lista suspensa.
-
Selecionar o método de autenticação:
-
Se o GitHub App ainda não estiver instalado, clique em Autenticar. A autenticação é realizada uma vez e pode ser reutilizada para múltiplas sincronizações de repositório.
Se o GitHub App já estiver instalado, clique em Gerenciar instalação para Concluir a instalação do aplicativo para a organização ou conta de tradução. O acesso ao repositório é gerenciado no nível da organização ou conta e não está vinculado a um usuário do GitHub individual.
-
Forneça um pessoal com uma API.
Ao usar um token de acesso pessoal, o acesso ao repositório depende do usuário do GitHub que criou o token.
-
Forneça o auto-hospedado do GitHub e um <2> pessoal com um escopo de API.
-
-
Selecionar um na lista suspensa.
-
Selecione um na lista suspensa para importar (push) e exportar (pull). Este é geralmente o ramo principal.
-
Opcionalmente, forneça um nome de ramo para a solicitação de pull. Se deixado vazio, um ramo será criado com o valor padrão .
-
Clique em Validar configuração para garantir que as configurações de autenticação e o arquivo de configuração estão corretos.
-
Opcionalmente, Selecionar uma opção de para determinar quando arquivos novos ou atualizados são importados automaticamente no projeto.
-
Clique em Gravar.
O projeto agora está conectado ao repositório do GitHub selecionado e adicionado à lista.
-
(Opcional) Clique no ícone de lápis para renomear a integração.
Certifique-se de que os comandos de push estão corretamente configurados dentro do arquivo .phrase.yml de configuração. As opções de push são as mesmas que para o endpoint da API de uploads.
Para importar arquivos:
-
Na página , selecione um projeto e clique em Importar
.
Arquivos de idioma (definidos como entradas de texto original de push no arquivo de configuração) são importados para o projeto.
Um local padrão deve estar presente.
Nota
Em caso de problemas ao importar, use o cliente CLI para testar o arquivo de configuração
.phrase.ymllocalmente e verificar se há mensagens de erro.Se necessário, entre em contato com o suporte técnico da Phrase e anexe o arquivo de configuração
.phrase.ymlà solicitação de suporte.
Certifique-se de que os comandos de pull estão corretamente configurados dentro do arquivo .phrase.yml de configuração. As opções de pull (por exemplo, o parâmetro include_empty_translations) são as mesmas que para o endpoint da API de locales download.
Para exportar arquivos:
-
Na página , selecione um projeto e clique em Exportar
.
A janela é exibida.
-
Forneça o ramo de tradução no campo .
Os arquivos mais recentes no repositório serão exportados como uma nova solicitação de pull para o ramo desejado.
-
Uma vez que os arquivos são exportados, a solicitação de pull pode ser mesclada ou fechada no repositório e o ramo pode ser excluído.
Nota
Em caso de problemas ao exportar, usar o cliente CLI para testar o arquivo de configuração .phrase.yml localmente e verificar se há mensagens de erro.
Se necessário, entre em contato com o suporte técnico da Phrase e anexe o arquivo de configuração .phrase.yml à solicitação de suporte.
As sincronizações de repositório mantêm um histórico das últimas importações e exportações para cada projeto Phrase Strings.
Para visualizar o histórico: