Integrações

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).

As Strings do Phrase integram-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 aplicativo OAuth do GitHub. Tokens de acesso pessoal também são suportados e são principalmente destinados a instâncias auto-hospedadas ou ambientes onde a instalação do aplicativo OAuth 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.

  • Aplicativo OAuth do GitHub:

    • O aplicativo OAuth do GitHub 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 aplicativo OAuth.

    • Permissões para instalar ou autorizar aplicativos do GitHub são necessárias na organização ou conta de destino.

  • 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 de granularidade fina

      Requer as seguintes permissões:

      • Conteúdo: Leitura e escrita

      • Solicitações de 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.

Conectar repositórios

Uma vez que o arquivo de configuração esteja no lugar, para conectar um repositório, siga estes passos:

  1. Na página Integrações, role para baixo até Sincronização de Repositório e clique em Configurar.

    A página Sincronizações de repositório será aberta.

  2. Clique em Adicionar sincronização/GitHub.

    A janela de configurações de sincronização do GitHub é aberta.

  3. Selecione um projeto na lista suspensa.

  4. Selecione o método de autenticação:

    • Aplicativo GitHub (recomendado)

      Se o aplicativo GitHub ainda não estiver instalado, clique em Autenticar. A autenticação é realizada uma vez e pode ser reutilizada para várias sincronizações de repositório.

      Se o aplicativo GitHub já estiver instalado, clique em Gerenciar instalação 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 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 um escopo de 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 endpoint da API auto-hospedado do GitHub e um token de acesso ao repositório pessoal com um escopo de API.

  5. Selecione um repositório do GitHub na lista suspensa.

  6. Selecione um ramo do repositório na lista suspensa para importar (push) e exportar (pull). Este é geralmente o ramo master.

  7. 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 phrase-translations.

  8. Clique em Validar configuração para garantir que as configurações de autenticação e o arquivo de configuração estão corretos.

  9. Opcionalmente, selecione uma opção de Comportamento de Importação para determinar quando novos arquivos ou arquivos atualizados são importados automaticamente no projeto.

  10. Clique em Salvar.

    O projeto agora está conectado ao repositório do GitHub selecionado e adicionado à lista.

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 Sync Import.

    Os arquivos de idioma (definidos como entradas de origem 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.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:

  1. Na página Sincronizações de repositório, selecione um projeto e clique em Exportar Sync Export.

    A janela Exportar é exibida.

  2. Forneça o ramo de destino no campo PR branch.

    Os arquivos mais recentes no repositório serão exportados como uma nova solicitação de pull para o ramo desejado.

  3. 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, 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.

Histórico

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

Para visualizar o histórico:

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

    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.

Esse artigo foi útil?

Sorry about that! In what way was it not helpful?

The article didn’t address my problem.
I couldn’t understand the article.
The feature doesn’t do what I need.
Other reason.

Note that feedback is provided anonymously so we aren't able to reply to questions.
If you'd like to ask a question, submit a request to our Support team.
Thank you for your feedback.