GitHub (Strings)

O conteúdo de toda a Central de Ajuda é traduzido automaticamente de inglês pelo Phrase Language AI.

Dica

Para informações sobre a integração do GitHub no Phrase TMS, consulte GitHub (TMS).

O Phrase Strings integra-se com repositórios do GitHub para sincronizar arquivos de localização entre o Phrase e o GitHub.

Por padrão, os repositórios são conectados usando um GitHub OAuth App. Tokens de acesso pessoal também são suportados e são destinados principalmente a instâncias autohospedadas ou ambientes onde a instalação do OAuth App não é possível.

Pré-requisitos

O arquivo .phrase.yml de 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.
GitHub OAuth App:
- 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.
- São necessárias permissões para instalar ou autorizar GitHub Apps na organização ou conta de destino.
- Suporta a conexão de uma conta Strings a várias organizações do GitHub. Selecione qual organização do GitHub será sincronizada na configuração da integração. Não há um limite rígido para o número de organizações que podem ser conectadas.
Token de acesso do GitHub:
- Tokens clássicos
  
  Requer o escopo do repositório (public_repo se sincronizando com o repositório público)
- Tokens granulares
  
  Requer as seguintes permissões:
  - Conteúdo: Leitura e edição
  - Pull requests: Leitura e edição
- 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.

Conectar repositórios

Assim que o arquivo de configuração estiver no lugar, para conectar um repositório, siga estas etapas:

Na navegação principal, clique em Automations, depois em Repo Syncs.

Alternativamente, na página Integrations, role para baixo até Repo Sync e clique em Configure.

A página Sincronizações de repositório será aberta. A lista Repo Syncs exibe apenas projetos aos quais o usuário que está visualizando tem acesso.
Clique em Adicionar sincronização/GitHub.

A janela de configurações de sincronização do GitHub é aberta.
Selecione um projeto na lista suspensa.
Selecione o método de autenticação:
- Aplicativo GitHub (recomendado)
  
  Se o GitHub App ainda não estiver instalado, clique em Authenticate. A autenticação é realizada uma vez e pode ser reutilizada para várias sincronizações de repositório.
  
  Se o GitHub App já estiver instalado, clique em Manage installation para concluir a instalação do aplicativo para a organização ou conta de destino. O acesso ao repositório é gerenciado no nível da organização ou da conta e não está vinculado a um usuário individual do GitHub.
- Token de acesso pessoal
  
  Forneça um token de acesso ao repositório 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.
- Instância de host próprio
  
  Forneça o API endpoint do GitHub auto-hospedado e um Repo access token pessoal com escopo de API.
Se o repositório de destino exigir commits verificados (assinados), o método de autenticação GitHub App deve ser usado. Commits enviados usando um token de acesso pessoal não são assinados, portanto, a sincronização falha com o seguinte erro: "O repositório exige commits verificados (assinados)."
Se o GitHub App for usado, selecione Connected GitHub organization na lista suspensa. A lista de repositórios é carregada com base nessa seleção.
Selecione um GitHub repository na lista suspensa.
Selecione um ramo do repositório na lista suspensa para importar (push) e exportar (pull). Este é geralmente o branch master.
Opcionalmente, forneça um nome de branch para a pull request. Se deixado vazio, um branch será criado com o valor padrão phrase-translations.
Opcionalmente, forneça um Commit title personalizado para a pull request, com até 72 caracteres.

Deixar o campo vazio mantém a mensagem padrão, Updated translations from Phrase. Uma vez definido, o título personalizado substitui a mensagem de commit padrão e o título da pull request em cada exportaçã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, selecione uma opção de Comportamento de importação 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.

O aplicativo GitHub do Phrase não oferece suporte atualmente à lista de permissões de IP. Se uma organização do GitHub tiver uma lista de permissões de IP ativada com a configuração "Enable IP allow list configuration for installed GitHub Apps" ligada, o GitHub bloqueia o aplicativo GitHub do Phrase, o que resulta em um menu suspenso de repositório vazio e falhas nas exportações. Como solução alternativa, adicione os endereços IP de saída do Phrase à lista de permissões da organização. Consulte o artigo Endereços IP dos servidores do Phrase para obter a lista atual de endereços a serem incluídos na lista de permissões.

Importar arquivos

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 Sincronizações de repositório, selecione um projeto e clique em Importar .

Os arquivos de idioma (definidos como entradas de origem de push no arquivo de configuração) são importados para o projeto.

Um idioma padrão deve estar presente.

Nota

Em caso de problemas ao importar, use 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.

Exportar arquivos

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 Sincronizações de repositório, selecione um projeto e clique em Exportar .

A janela Exportar é exibida.
Forneça o branch de destino no campo PR branch.

Os arquivos mais recentes no repositório serão exportados como uma nova pull request para o branch 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.

Histórico

As sincronizações de repositório mantêm um histórico das últimas importações e exportações para cada projeto do Phrase Strings.

Para visualizar o histórico:

Na página Sincronizações de repositório, selecione um projeto e clique em Histórico .

O histórico de importação e exportação do projeto é apresentado. As entradas de exportação no histórico incluem um link para o pedido de mesclagem correspondente.