Quando desenvolvedores fazem commit de novo código ou atualizações em um repositório do GitHub, as alterações correspondentes frequentemente precisam ser refletidas na sua base de conhecimento. Criar ou atualizar manualmente artigos do Document360 para cada commit consome tempo e é propenso a erros. Ao conectar GitHub e Document360 através do Zapier, você pode automatizar isso: sempre que um evento especificado ocorre em um repositório do GitHub, o Zapier cria automaticamente um artigo correspondente na sua base de conhecimento Document360.
Quando usar essa integração
- Sua equipe de engenharia segue uma abordagem docs-as-code e quer que cada commit do GitHub em um repositório específico para gerar automaticamente um rascunho de artigo no Document360 para revisão.
- Você mantém um changelog ou uma base de conhecimento de notas de lançamento no Document360 e quer que novos commits ou releases no GitHub acionem automaticamente a criação de artigos.
- Seu fluxo de trabalho de desenvolvimento inclui atualizações de documentação junto com alterações no código, e você quer garantir que os artigos da base de conhecimento sejam criados em sincronia, sem uma etapa manual.
Antes de começar
- Você deve estar logado na sua conta Zapier.
- Você deve ter uma conta no GitHub com acesso ao repositório que deseja monitorar.
- Você deve ter seu token da API do Document360 pronto. Para gerar uma, navegue até Conexões > Extensões, localize o bloco Zapier e clique em Conectar para copiar o token.
Como configurar o Zap
Passo 1 — Crie um novo Zap
- Faça login na sua conta Zapier.
- No menu de navegação à esquerda, clique em Criar e depois selecione Zaps.
- Um novo Zap é criado com um fluxo de Gatilho e Ação .
Passo 2 — Conecte o GitHub como gatilho
- No campo Trigger , escolha GitHub.
- No campo de evento Trigger , selecione o evento que deve acionar o Zap.
NOTA
Para mudar o aplicativo de gatilho depois, clique em Alterar no campo Gatilho.
- Clique no campo Conta — um painel de login aparece.
- Insira suas credenciais do GitHub e clique em Autorizar Zapier.
- Escolha o repositório desejado e clique em Continuar. Zapier executa um teste para confirmar que o gatilho está corretamente configurado.
Passo 3 — Conectar o Document360 como a ação
- No campo Ação , escolha Document360.
- No painel Configuração, selecione o evento desejado no campo Evento .
- Clique no campo Conta — um painel de login aparece.
- Insira suas credenciais de login e clique em Permitir.
Para gerar o token API a partir do Document360:
- Navegue até Conexões > Extensões na barra de navegação à esquerda do portal da Base de Conhecimento.
- No bloco de extensão do Zapier , clique em Conectar.
- Clique no ícone Copiar para copiar o token.
- Volte ao painel Zapier e cole o token da API no campo.
- Clique em Sim, continuar para Document360.
- Você pode encontrar o projeto Document360 conectado na página da conta Connect Document360 . Para usar uma conta diferente depois, clique em Alterar.
- Clique em continuar.
Passo 4 — Mapear os campos
- Mapeie os campos do GitHub para o Document360:
| Campo | Descrição |
|---|---|
| Título | Por padrão, Novo Commit no GitHub está selecionado. Outras opções estão disponíveis conforme suas necessidades. |
| Conteúdo | Por padrão, Mensagem de Commit é selecionada. Outras opções estão disponíveis conforme suas necessidades. |
| Versão | Escolha o espaço de trabalho no seu projeto Document360 onde o artigo deve ser criado. |
| Idioma | Escolha o idioma dentro do espaço de trabalho selecionado. |
| Categoria | Selecione a categoria onde o artigo será criado. |
| Publicar | Coloque em Verdadeiro para publicar o artigo imediatamente. Defina para False para salvar como rascunho. |
NOTA
O botão Continuar só é ativado depois que todos os campos necessários já foram mapeados.
- Clique em continuar.
Passo 5 — Teste e publique o Zap
- Na seção de teste, clique em Enviar Teste.
- Se for bem-sucedido, você receberá a mensagem enviada pelo Artigo de Teste! Verifique sua conta no Document360 para visualizá-lo.
- No seu portal Document360, você encontrará um novo artigo intitulado "Novo commit no GitHub" na categoria que você selecionou.
- Volte ao painel de configuração do Zapier e clique em Próximo, depois em Publicar.
- Você verá uma mensagem de sucesso: seu Zap está ligado. Clique em Gerenciar seu Zap para ir à página de visão geral do Zap.
Visão geral do Zap
Uma vez ativado, você pode visualizar e gerenciar o Zap a partir do painel Zapier. A página de visão geral mostra o histórico de disparo, ação e execução do Zap.
Como deletar um Zap
- Navegue até o painel do Zapier. Uma lista de todos os Zaps existentes é exibida na página de visão geral.
- Clique no ícone de ações do Zap () à direita do Zap que você quer remover e clique em Deletar. O Zap é deletado permanentemente.
Melhores práticas
- Defina o campo Publicar como Falso ao mapear campos para que artigos acionados pelo GitHub caiam no Document360 como rascunhos. Isso dá à sua equipe de documentação a chance de revisar, formatar e enriquecer o conteúdo antes de ele ser lançado — já que as mensagens de commit brutas raramente estão prontas para serem publicadas como estão.
- Use uma categoria dedicada no Document360 para artigos acionados pelo GitHub, como uma categoria de "Changelog" ou "Atualizações de desenvolvimento". Isso mantém o conteúdo gerado automaticamente separado dos artigos feitos à mão e facilita a revisão e a promoção.
- Escolha um evento de gatilho específico que combine com seu fluxo de trabalho — por exemplo, um push para um branch de release em vez de cada commit — para evitar gerar artigos para toda mudança rotineira de código que não justifique uma entrada no banco de conhecimento.