Pesquise arquivos do GitHub a partir do ClickUp, sincronize atividades do GitHub com tarefas do ClickUp, crie pull requests, branches e issues do GitHub a partir do ClickUp, e muito mais.

Ao configurar a integração, você vinculará Espaços diretamente a repositórios do GitHub para que você saiba sempre qual trabalho está relacionado.

Proprietários e administradores do Espaço de trabalho podem conectar Espaços aos seus repositórios, permitindo que os membros adicionem seu trabalho do GitHub às tarefas.

As tarefas em Espaços com um repositório conectado podem ser vinculadas a commits, branches e pull requests.

O que você vai precisar

• A integração com o GitHub está disponível em todos os planos do ClickUp.
• Somente administradores de repositório podem adicionar repositórios do GitHub ao ClickUp. Após adicionados, os administradores do Espaço de trabalho podem adicionar esses repositórios aos Espaços do ClickUp!
• Somente proprietários e administradores do Espaço de trabalho podem atualizar as Configurações do Espaço de trabalho no App Center.
• Somente proprietários e administradores do Espaço de trabalho podem adicionar e vincular repositórios a Espaços.
• Somente proprietários e administradores do Espaço de trabalho podem criar conexões do Espaço de trabalho. Múltiplas conexões do Espaço de trabalho são permitidas.
• Membros e acima podem criar conexões pessoais.
• Convidados e membros com acesso limitado não podem usar a integração com o GitHub.

Tipos de conexão

Os recursos e comandos disponíveis dependem do tipo de conexão que você usa.

Configurar uma conexão pessoal

Para configurar uma conexão pessoal com o GitHub:

1. No canto superior esquerdo, clique no avatar do seu Espaço de trabalho e selecione Aplicativos.
2. Procure e selecione o GitHub.
3. Clique em Conectar.
4. Siga as instruções para autorizar o ClickUp e clique em Concluído.

Configurar uma conexão do Espaço de trabalho

Há três etapas para configurar uma conexão do Espaço de trabalho para o GitHub no ClickUp:

1. Conectar o GitHub.
2. Associar repositórios do GitHub ao seu Espaço de trabalho. Os repositórios são necessários para que o ClickUp possa vincular automaticamente os pull requests às suas respectivas tarefas no ClickUp.
3. Vincular repositórios do GitHub aos Espaços do ClickUp.

Etapa 1: conectar o GitHub

Para configurar uma conexão do Espaço de trabalho para o GitHub:

1. No canto superior esquerdo, clique no avatar do seu Espaço de trabalho e selecione Aplicativos.
2. Localize e selecione GitHub.
3. Na parte superior, clique na aba Espaço de trabalho.
   • Opcional: desative a Pesquisa conectada do Espaço de trabalho clicando no botão de alternância ao lado dela.
4. Clique em Conectar.
5. Siga as instruções para autorizar o ClickUp.
6. Escolha quais repositórios você quer que fiquem pesquisáveis pela Pesquisa conectada do Espaço de trabalho clicando no menu suspenso Selecionar repositórios.
7. Depois de adicionar os repositórios, clique em Salvar.

   

8. Clique em Próximo e selecione Concluído.

Etapa 2: adicionar repositórios do GitHub ao seu Espaço de trabalho

Somente o proprietário da conexão pode adicionar repositórios.

Associar um repositório não concede aos usuários do ClickUp acesso à base de código do seu repositório.

Para adicionar um repositório ao seu Espaço de trabalho:

1. Na página do GitHub no App Center, clique em Configurações no canto superior direito.
2. Clique em Adicionar repositório.
3. Selecione um repositório.
4. Para adicionar mais repositórios, repita as etapas 2 e 3.

Se os repositórios corretos não aparecerem, verifique se você está conectado à conta certa. Um proprietário ou administrador do Espaço de trabalho deve selecionar cada repositório a ser conectado. Os repositórios vinculados podem ser visualizados no App Center.

Etapa 3: vincular repositórios do GitHub aos Espaços do ClickUp

Após adicionar repositórios ao seu Espaço de trabalho, os administradores podem conectar cada repositório a um ou mais Espaços. É possível adicionar vários repositórios a um mesmo Espaço.

Para vincular um repositório a um Espaço:

1. Na página do GitHub no App Center, clique em Configurações no canto superior direito.
2. Clique no nome do repositório que você quer vincular.
3. Clique em + Adicionar Espaço.

   

4. Pesquise e selecione um Espaço.
5. Para vincular Espaços adicionais, repita as etapas 2 a 4.

Alterar o formato do nome do branch

Se a sua organização usa um formato específico para nomes de branch, você pode defini-lo na página do GitHub no App Center. Quando as pessoas criarem branches a partir de tarefas do ClickUp, esse formato será utilizado.

O formato padrão é: :taskId:_:taskName:_:username:

Por exemplo: CU-ae27de_Auto-generated-naming_John-smith

Os valores disponíveis são mostrados na tabela a seguir:

Para alterar o formato do nome do branch:

1. Na página do GitHub no App Center, clique em Configurações no canto superior direito.
2. Em Nome de branch gerado automaticamente, insira o formato de nome de branch preferido.
3. Clique em Salvar.

Pesquisar arquivos do GitHub usando a Connected Search

Use a Connected Search do Espaço de trabalho para permitir que todos os membros do Espaço de trabalho pesquisem qualquer arquivo público dos repositórios que você adicionar.

Editar repositórios pesquisáveis

Para editar quais repositórios podem ser pesquisados pela Connected Search do Espaço de trabalho:

1. Na página do GitHub no App Center, clique na aba Espaço de trabalho.
2. Adicione ou remova repositórios da Connected Search do Espaço de trabalho:
   • Adicionar novos repositórios: Clique no menu suspenso repositórios selecionados e selecione um repositório.
   • Remover um repositório existente: À direita do repositório, clique no ícone x.

Permitir que Super Agents pesquisem no GitHub

Para permitir que um Super Agent pesquise arquivos na sua conta do GitHub conectada, ative a Pesquisa externa para GitHub no perfil dele.

Vincular tarefas do GitHub

O ClickUp associa automaticamente novas atividades do GitHub a tarefas se você incluir um ID de tarefa válido do ClickUp em qualquer parte do título do pull request, da descrição do pull request, do nome do branch ou da mensagem de commit.

Quando um ID de tarefa do ClickUp é incluído em um pull request, um comentário com um link para a tarefa do ClickUp será publicado no pull request. O link não será exibido ao colar manualmente um pull request em uma tarefa do ClickUp.

O comentário será publicado usando a conta do GitHub da pessoa que configurou o mapeamento de repositório e Espaço.

O ID da tarefa deve ser formatado usando uma destas opções:

#{task_id}

CU-{task_id}

{custom_task_id}

#{custom_task_id}

Por exemplo:

#1abc2de

CU-1abc2de

eng-123

#eng-123

Vincular tarefas do ClickUp

Vincule manualmente tarefas do ClickUp a commits, branches e pull requests do GitHub a partir da tarefa. Certifique-se de que a tarefa está localizada em um Espaço vinculado a um repositório.

Para vincular uma tarefa:

1. Abra uma tarefa e clique no ícone do GitHub.

   

2. No canto inferior direito, clique em Adicionar link do GitHub.
3. Cole um link.
4. No canto inferior direito, clique em Adicionar.

Atividade de tarefa do ClickUp

A atividade do GitHub pode ser acessada no feed de Atividade da tarefa do ClickUp vinculada.

Os feeds de atividade de tarefas às vezes recolhem itens de atividade semelhantes para garantir que você veja os detalhes mais importantes.

Você pode realizar as seguintes ações para localizar a atividade do GitHub em uma tarefa:

• Clique em Mostrar mais para exibir a atividade que foi ocultada.

  

• Quando um branch é mesclado, os commits são exibidos como um único item de atividade no feed de atividade da tarefa.
  • Clique no link para todos os commits para abrir um modal.
  • Clique em um commit individual para abri-lo no GitHub.
• Filtre a atividade da tarefa por Itens do Git.

  

Atividade ausente

Se você não conseguir localizar determinada atividade, verifique se está referenciando corretamente o ID de tarefa do ClickUp para vincular a atividade no GitHub. Você pode usar qualquer uma destas três opções para referenciar suas tarefas do ClickUp em commits, nomes de branch e pull requests:

#{task_id}

CU-{task_id}

{custom_task_id}

Por exemplo:

#1abc2de

CU-1abc2de

prefix-1

Você também pode vincular manualmente tarefas do ClickUp com commits, branches e pull requests do GitHub a partir da tarefa do ClickUp.

Pré-visualizações de links do GitHub

Quando você cola um link do GitHub no meio de uma frase ou dentro de um texto existente, ele exibe uma pré-visualização de link inline que você pode passar o cursor para ver mais detalhes.

Quando você cola um link do GitHub em uma nova linha, pode escolher exibi-lo inline, como uma pré-visualização ao vivo ou como uma URL comum.

As pré-visualizações de links funcionam em descrições de tarefas, comentários, Documentos e mensagens de Chat. Para alterar manualmente o tipo de pré-visualização de um link, passe o cursor sobre ele e clique no ícone de reticências ….

Criar issues, branches e pull requests do GitHub a partir do ClickUp

Crie novas issues, branches e pull requests diretamente a partir de tarefas.

Certifique-se de que a tarefa está localizada em um Espaço vinculado a um repositório e de que você configurou uma conexão pessoal.

Para criar uma issue, branch ou pull request:

1. Abra uma tarefa e clique no ícone do GitHub. À direita, você verá sugestões de nomes de branch e mensagens de commit que pode copiar para a área de transferência. Você também pode copiar o ID da tarefa a partir daqui.
2. No canto inferior direito, clique em Adicionar link do GitHub.
3. Escolha uma das seguintes opções:
   • Nova Issue do GitHub
   • Nova Branch do GitHub
   • Novo Pull Request do GitHub
4. Nomeie a issue, branch ou pull request.
5. Selecione um repositório e preencha as informações. Adicione uma branch de origem e uma branch de destino, se aplicável.

   

6. Clique em Criar.

Painel do GitHub em tarefas

As tarefas em Espaços vinculados a repositórios têm um ícone do GitHub que você pode clicar para ver todos os links do GitHub publicados na tarefa.

A atividade de tarefa do GitHub usa o nome de usuário do ClickUp da pessoa ou o nome de usuário do GitHub, caso ela não tenha uma conta no ClickUp.

Atualizar status de tarefas pelo GitHub

Você pode atualizar o status de uma tarefa do ClickUp ao vincular um commit, enviar um commit ou criar um pull request. O ClickUp detecta automaticamente novas atividades do GitHub e as associa a tarefas se você incluir um ID de tarefa válido em qualquer parte do título do pull request, da descrição do pull request, do nome do branch ou da mensagem do commit.

O ID da tarefa deve ser formatado usando uma destas opções:

#{task_id}[status]

CU-{task_id}[status]

{custom_task_id}[status]

#{custom_task_id}[status]

Para atualizar o status de uma tarefa:

1. Adicione o ID da tarefa do ClickUp em qualquer parte da mensagem do commit ou do pull request.
2. Inclua o status atualizado da tarefa entre colchetes.

Por exemplo: #ud5b[ready]

Todos os formatos listados na seção Vincular tarefas pelo GitHub deste artigo podem ser usados. Para garantir a formatação correta, não adicione espaço entre o ID da tarefa e as informações de status.

Você também pode atualizar status de tarefas usando as Automações do GitHub!

Gerenciar issues, branches, pull requests e commits do GitHub a partir do ClickUp

Depois de vincular issues, branches, pull requests ou commits, eles são listados quando você clica no ícone do GitHub em uma tarefa. Use o menu de reticências ... para copiar o link ou excluir o item.

Ao vincular um item do GitHub, as seguintes informações são exibidas na sua tarefa do ClickUp:

Informações da issue

Após vincular uma issue, você pode ver os seguintes detalhes:

• A pessoa que abriu a issue, conhecida como autor
• Revisores atribuídos
• Link criado
• Repositório
• O status da issue
• URL

Informações do branch

Após vincular um branch, você pode ver os seguintes detalhes:

• A pessoa que criou o branch, conhecida como autor
• Criador do link
• Repositório
• URL

Informações do pull request

Após vincular um pull request, você pode ver os seguintes detalhes:

• A pessoa que abriu o pull request, conhecida como autor
• Revisores atribuídos
• Responsáveis
• Alterações de linhas
• Link criado
• Repositório
• Branch de origem
• Branch de destino
• O status do pull request
• URL

Informações do commit

Após vincular um commit, você pode ver os seguintes detalhes:

• A pessoa que criou o commit, conhecida como autor
• Arquivos alterados
• Alterações de linhas
• Link criado
• Repositório
• URL

Visualizar pull requests na visualização de Lista ou Tabela

Adicione a coluna de Pull Requests a qualquer visualização de Lista ou Tabela para ver rapidamente seus pull requests do GitHub em alto nível.

Problemas de conexão

Às vezes, a conta do GitHub errada está vinculada ou há um problema com a conexão. Nesse cenário, você pode tentar desconectar e reconectar seus repositórios ou a conta inteira.

Essas ações não afetam a capacidade de ninguém de acessar repositórios usando sua conta do GitHub pelo GitHub.

Para desconectar um repositório:

1. No App Center, selecione GitHub.
2. No canto superior direito, clique em Configurações.
3. À direita do repositório, clique no ícone de reticências ....
4. Clique em Excluir do ClickUp.

Desconectar o GitHub do ClickUp

Se você não precisar mais acessar arquivos do GitHub no ClickUp, pode desconectar a integração:

1. No App Center, selecione GitHub.
2. Selecione a aba Espaço de trabalho. Somente proprietários e administradores podem desconectar conexões do Espaço de trabalho.
3. Ao lado de Conectado, clique no menu de reticências ....
4. Selecione Desconectar.
5. Para confirmar, clique em Desconectar.

Escopos OAuth

Abaixo está uma tabela com todos os escopos OAuth da integração com o GitHub para que você possa tomar decisões informadas sobre segurança e conformidade antes de habilitá-la no seu Espaço de trabalho.