Conector GitHub

Visão geral

Esta página ilustra como o GitHub Connector é capaz de monitorar e criar projetos com base em alterações que acontecem em um conjunto de repositórios do GitHub.

Propósito Geral

O GitHub Connector monitora arquivos específicos nos repositórios do GitHub, dado um certo intervalo de tempo. Geralmente em projetos de localização, os arquivos comuns são JSON, YML, XLIFF, XML, STRINGS ou qualquer outro formato estruturado e previsível. Comparando o hash do arquivo com um repositório de traduções executadas anteriormente para esse mesmo arquivo, se uma alteração for detectada, um novo projeto será criado e os projetos de tradução começarão.

Estratégias de monitoramento

Podemos monitorar repositórios do GitHub usando sua API REST. Para isso, nossos clientes precisam autorizar uma conta para criar um token no Bureau Works para acessar a API. Essas credenciais são criptografadas com AES 256 e armazenadas no perfil do Cliente.

Existem duas estratégias de monitoramento: filiais e solicitações depuxar.

Ramos

O Conector monitorará constantemente um ou mais ramos em um ou mais repositórios, e uma vez que os arquivos que estão sendo observados são modificados, ele criará um projeto em Bureau Works e notificará nossa equipe. Em projetos de localização contínua, quaisquer strings traduzidas anteriormente são totalmente levadas em conta.

Uma vez que um projeto é entregue, o GitHub Connector criará um Pedido de tração para uma filial de patches contendo o (s) arquivos após o término da tradução. Podemos personalizar o caminho de saída e nomear estratégias para os arquivos de saída. Isso cria um mecanismo de entrega não intrusivo e muito elegante quando uma equipe tende a usar um ou apenas alguns ramos para o desenvolvimento.

Pedidos de atração

Assim como a estratégia do Ramo, também podemos monitorar pedidos de atração, para equipes que usam Gitflow ou fluxos de trabalho semelhantes. O Conector pode monitorar todas as solicitações de tração, para todas as agências, para os mesmos arquivos configurados. Mais uma vez que uma diferença é encontrada com base no hash do arquivo, um projeto será criado.

A grande diferença com essa estratégia é o mecanismo de entrega. Como as solicitações de tração referem-se a uma filial, uma vez que um projeto é entregue, o Conector criará um compromisso no mesmo ramo que a solicitação de tração. Uma vez que a solicitação de tração seja aceita e mesclada, ela levará ao longo do arquivo traduzido para o ramo alvo, ou seja, mestre, desenvolvimento, etc.

Autorizar obras do Bureau

Para configurar o GitHub Connector, a primeira coisa que você precisa fazer é autorizar o Bureau Works a acessar seus repositórios. Como uma camada extra de segurança, recomendamos que você crie um usuário que terá acesso exclusivo aos repositórios de interesse dentro de sua organização.

Se você não puder ver o fluxo de trabalho de autorização do GitHub, você pode não ter as funções apropriadas aplicadas à sua conta. Entre em contato com sua organização, ou se essa pessoa for você, envie-nos um e-mail para help@bureauworks.com.

1. Abra minha conta no canto superior direito da sua exibição do Bureau Works.

2. Na barra superior, selecione Conectar GitHub

3. Faça login no GitHub usando a conta que você deseja conectar ao Bureau Works.

4. O GitHub o enviará de volta ao Bureau Works e mostrará uma mensagem se a autenticação for bem sucedida.

Fornecendo caminhos de monitoramento e entrega

Uma vez autorizado o Bureau Works, você precisa nos fornecer caminhos de arquivos e repositórios que precisam de monitoramento. Por exemplo, em projetos iOS, é comum ter um arquivo chamado Localizable.strings implantado em cada pasta de idioma, por exemplo:

en.lproj/Localizable.strings # Fonte
pt-BR.lproj/Localizable.strings # Target A
de.lproj/Localizable.strings # Alvo B
...

Precisamos determinar qual são os arquivos de origem e quais são os caminhos desejados para entregar as traduções. Cada entrega realizada pelo conector GitHub, dependendo da estratégia selecionada, colocará os arquivos na estrutura correta da pasta no repositório do GitHub.

Esta etapa é realizada pela nossa equipe, e é gerenciada através do nosso suporte em help@bureauworks.com.

Segurança e Privacidade

Cada instância do GitHub Connector é exclusiva do Cliente, é executada em um contêiner separado e só pode acessar o token GitHub vinculado ao perfil do Cliente no Bureau Works. Uma vez criado um token, ele concederá acce/zooss do Bureau Works para repositórios públicos e privados dentro dessa organização, a fim de criar adequadamente pedidos de atração e compromissos.

Nossa equipe não tem acesso ao token criptografado e, portanto, não podemos acessar os repositórios via API. Fornecemos uma trilha de auditoria detalhada para uso, se necessário, e o sistema GitHub também mantém o controle do uso do token.