Usamos uma combinação de tokens de acesso e Webhooks para autenticar e sincronizar mudanças entre o GitLab e a Mintlify.

  • Usamos tokens de acesso para extrair informações do GitLab.
  • Usamos Webhooks para que o GitLab possa notificar a Mintlify quando mudanças são feitas.
    • Isso permite que a Mintlify crie implantações de visualização quando um MR é criado.

​
Configure a conexão

1

Encontre seu ID de projeto

Dentro do seu projeto GitLab, navegue atéSettings>Generale encontre oProject ID.

2

Gere um token de acesso

a. Navegue atéSettings>Access Tokens.

b. SelecioneAdd new token.

  1. Nomeie o token “Mintlify”.
  2. Se você tem um repositório privado, você deve definir a função comoMaintainer.
  3. Escolhaapieread_apipara os escopos.

c. Finalmente, clique emCreate project access tokene copie o token.

3

Configure a conexão

Dentro dopainel da Mintlify, adicione o ID do projeto e o token de acesso das etapas anteriores junto com as outras configurações. Clique em “Salvar Alterações” quando terminar.

​
Crie o webhook

Webhooks nos permitem receber eventos quando mudanças são feitas para que possamos automaticamente acionar implantações.

1

Navegue até Configurações > Webhooks e clique em 'Adicionar novo Webhook'

2

Configure a URL e o webhook

No campo “URL”, insira o endpointhttps://leaves.mintlify.com/gitlab-webhooke nomeie o webhook “Mintlify”.

3

Cole o token

Cole o token do Webhook gerado após configurar a conexão.

4

Selecione eventos

Selecione os eventos que você deseja que acionem o webhook:

  • Eventos de push (Todos os branches)
  • Eventos de solicitações de mesclagem

Quando terminar, deve ficar assim:

5

Teste o Webhook

Após criar o Webhook, clique no menu suspenso “Testar” e selecione “Eventos de push” para enviar uma carga útil de amostra para garantir que esteja configurado corretamente. Ele dirá “Hook executado com sucesso: HTTP 200” se configurado corretamente.

Isso ajudará você a verificar se tudo está funcionando corretamente e se sua documentação será sincronizada adequadamente com seu repositório GitLab.

Entre em contato com a equipe da Mintlify se precisar de ajuda. Contate-nos

aqui.