Vincule os Spaces diretamente aos repositórios do GitHub para que você sempre saiba 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 no Spaces 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 ClickUp.
• Somente administradores de repositório podem adicionar repositórios do GitHub ao ClickUp. Uma vez adicionados, os administradores do Espaço de trabalho podem incluir esses repositórios nos Espaços ClickUp!
• Somente proprietários e administradores do espaço de trabalho podem atualizar as Configurações do Espaço de Trabalho na Central de Aplicativos.
• Apenas os proprietários e administradores do espaço de trabalho podem adicionar e vincular repositórios aos Espaços.
• Somente os proprietários e administradores do espaço de trabalho podem criar conexões de espaço de trabalho. São permitidas múltiplas conexões de Espaços de Trabalho.
• Membros e superiores podem criar conexões pessoais.
• Os convidados não podem usar a integração com o GitHub.

• A Busca Conectada do Espaço de trabalho está disponível no plano Business e superiores.

• A Busca Conectada Pessoal não está disponível para a integração com o GitHub.

Tipos de conexão

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

Os comandos ClickUp estão disponíveis apenas para conexões pessoais. Os dados não estão vinculados ao Workspace Connections. Quando um usuário tem uma conexão pessoal ativada e executa um comando do GitHub, ele verá uma lista de opções, como listas de repositórios, que ele está autorizado a visualizar no GitHub.

Exemplo prático

A equipe de engenharia do seu aplicativo móvel e a equipe de desenvolvimento do site trabalham em repositórios e espaços separados, dentro da mesma organização no GitHub e Espaço de trabalho ClickUp.

Para começar com a integração:

1. O proprietário do espaço de trabalho ou administrador cria uma conexão do GitHub com o Espaço de Trabalho.
2. O gerente do aplicativo móvel conecta o repositório app-mobile do GitHub ao espaço de desenvolvimento de aplicativos móveis.
3. O gerente do site conecta o repositório do GitHub do site ao Espaço do site de marketing.
4. As tarefas nos espaços de desenvolvimento de aplicativos móveis e site de marketing agora exibem o ícone do GitHub, permitindo que ambas as equipes vinculem suas tarefas a commits, branches e solicitações de pull do GitHub.

Configure a integração

Há quatro etapas para configurar a integração do GitHub no ClickUp:

1. Conecte o GitHub.
2. Anexe repositórios do GitHub ao seu espaço de trabalho.
   

   Os repositórios são necessários para que o ClickUp possa vincular automaticamente as solicitações pull às suas respectivas tarefas do ClickUp.

3. Vincule repositórios do GitHub aos Espaços ClickUp.
4. Opcionalmente, você pode definir um formato de nome de branch personalizado.

Etapa 1: Conectar o GitHub

Você precisará ser um proprietário do espaço de trabalho ou administrador para configurar uma Conexão de Espaço de Trabalho para o GitHub.

Você pode configurar uma conexão com o GitHub a partir da Central de Aplicativos ou do centro de comando.

No centro de aplicativos:

1. Procure e selecione GitHub.
2. Clique na aba **Espaço de trabalho**.
   

   Você também pode configurar uma conexão pessoal para criar solicitações de pull e branches a partir do ClickUp. Conexões pessoais também podem ser utilizadas para vincular solicitações de pull, branches e commits existentes diretamente das tarefas ClickUp. 

3. Clique em Conectar.
4. Faça login na sua conta do GitHub para autorizar o acesso.

Do Centro de Comando:

1. Abaixo da barra de pesquisa, clique em Aplicativos.
2. Em GitHub, clique em Conectar.
3. Em Conexões do Espaço de Trabalho, clique em Conectar.
4. Faça login na sua conta do GitHub para autorizar o acesso.

Passo 2: Anexe repositórios do GitHub ao seu Espaço de Trabalho

Os proprietários e administradores do espaço de trabalho podem escolher quais repositórios do GitHub vincular ao seu Espaço de Trabalho ClickUp. O proprietário ou administrador também deve ser um administrador do repositório no GitHub.

Anexar um repositório não dá aos usuários do ClickUp acesso ao código-fonte do seu repositório.

Para adicionar um repositório a um espaço de trabalho:

1. Abra o GitHub na Central de Aplicativos.
2. Clique em Configurações do Espaço de Trabalho.
3. Ao lado de Connect Repositories to ClickUp, clique em Add repo.
4. Selecione todos os repositórios que deseja adicionar.

Se você não está vendo os repositórios corretos, pode ter feito login com a conta errada do GitHub.

Passo 3: Vincule repositórios do GitHub aos Espaços do ClickUp

Depois de adicionar repositórios ao seu espaço de trabalho, você pode adicionar cada repositório a um ou mais espaços. Cada ClickUp Space pode ter vários repositórios adicionados.

Você pode adicionar ou remover repositórios do Spaces a qualquer momento.

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

1. Abra o GitHub na Central de Aplicativos.
2. Clique em Configurações do Espaço de Trabalho.
3. Clique no nome do repositório que você deseja vincular.
4. Clique em + Adicionar espaço.
5. Repita para Espaços adicionais que você deseja vincular.

Etapa 4: Defina o formato do nome da filial

Se sua organização utiliza um formato específico para nomes de branch, você pode configurá-lo na página do GitHub na Central de Aplicativos. Quando as pessoas criam branches a partir de tarefas ClickUp, será usado este formato.

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

Por exemplo: CU-ae27de_Nomeação-Automática_John-smith

As opções disponíveis são mostradas na tabela a seguir:

Para definir seu formato de nome padrão do GitHub no Centro de Aplicativos:

1. Clique em Configurações do Espaço de Trabalho.
2. Em Nome de branch gerado automaticamente, insira o formato de nome de branch preferido.
3. Clique em Salvar.

Pesquisar arquivos do GitHub usando o Connected Search

Ao utilizar uma conexão de Espaço de Trabalho no plano Business ou superior, você pode usar a Busca Conectada do Espaço de Trabalho para permitir que todos os membros do Espaço de Trabalho busquem quaisquer arquivos públicos dos repositórios adicionados. Arquivos privados não podem ser pesquisados.

Vincule tarefas do GitHub

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

Quando um ID de tarefa do ClickUp é incluído em uma solicitação de pull, um comentário com um link para a tarefa do ClickUp será postado na solicitação de pull. Um link não será exibido ao colar manualmente uma solicitação de pull em uma tarefa do ClickUp.

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

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

#{task_id}

CU-{task_id}

{custom_task_id}

#{custom_task_id}

Por exemplo:

#1abc2de

CU-1abc2de

eng-123

#eng-123

Vincule tarefas do ClickUp

Você também pode vincular manualmente tarefas do ClickUp com commits, branches e solicitações de pull do GitHub a partir da tarefa do ClickUp. Certifique-se de que a tarefa esteja localizada em um espaço que esteja vinculado a um repositório.

Para vincular uma tarefa:

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

   À direita, você verá nomes de branch sugeridos e mensagens de commit que você pode copiar para sua área de transferência. Você também pode copiar o ID da tarefa daqui.

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

Previsões de links do GitHub

Quando você cola um link do GitHub em uma tarefa ClickUp, Conversa, ou Documento, você verá a opção de colar como uma pré-visualização, menção ou URL.

Crie problemas, branches e solicitações de pull no GitHub diretamente do ClickUp

Você também pode criar novos problemas, branches e solicitações de pull diretamente das tarefas. Certifique-se de que a tarefa esteja localizada em um espaço que esteja vinculado a um repositório.

Para criar um problema, branch ou solicitação de pull:

1. Abra uma tarefa e clique no ícone GitHub.
   À direita, você verá nomes de branches sugeridos e mensagens de commit que você pode copiar para sua área de transferência. Você também pode copiar o ID da tarefa daqui.
2. No canto inferior direito, clique em Adicionar link do GitHub.
3. Escolha uma das seguintes opções:
   • Novo Problema no GitHub
   • Nova branch do GitHub
   • Nova Solicitação de Pull no GitHub
4. Nomeie o problema, branch ou solicitação de pull.
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 na visualização de Tarefa

Após colar seu primeiro link do GitHub em uma descrição de tarefa ou comentário, você verá um novo ícone GitHub na barra lateral direita da sua visualização de Tarefa. Você pode clicar neste ícone a qualquer momento para ver todos os links do GitHub postados na tarefa.

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

Atualize os status das tarefas a partir do GitHub

Você pode atualizar o status de uma tarefa do ClickUp quando você vincula um commit, faz um push de um commit ou cria uma solicitação de pull. O ClickUp capta 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 da pull request, da descrição da pull request, do nome do branch ou da mensagem de commit.

O ID da tarefa deve ser formatado usando uma das seguintes 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 de commit ou solicitação de pull.
2. Inclua o status atualizado da tarefa entre colchetes.

Por exemplo: #ud5b[pronto]

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

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

Gerenciar problemas, ramificações, solicitações pull e commits do ClickUp no GitHub

Após vincular problemas, branches, solicitações de pull ou commits, eles aparecem do lado direito da sua tarefa quando você clica no ícone do GitHub. Utilize o menu reticências ... para copiar o link ou excluir o item.

Depois que você vincular um item do GitHub, as seguintes informações serão exibidas na sua tarefa do ClickUp:

Informações do problema

Depois que um problema é vinculado, você pode ver os seguintes detalhes:

• A pessoa que abriu o problema, conhecida como autor
• Qualquer revisor atribuído
• Link criado
• Repositório
• O status do problema.
• URL

Informações do branch

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

• O indivíduo que criou o branch, conhecido como autor
• Criador de link
• Repositório
• URL

Informações de solicitação de pull

Após uma solicitação de pull ser vinculada, você pode ver os seguintes detalhes:

• A pessoa que abriu a solicitação de pull, conhecida como autor
• Qualquer revisor atribuído
• Responsáveis
• Alterações de linha
• Link criado
• Repositório
• Ramo de origem
• Ramo alvo
• O status do pull request
• URL

Informações de compromisso

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

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

Adicione sua conta do GitHub ao ClickUp

Membros do espaço de trabalho podem vincular suas contas do GitHub à sua conta ClickUp antecipadamente ou quando criarem um branch ou solicitação de pull.

Para adicionar sua conta do GitHub a partir da Central de Aplicativos:

1. Pesquise e selecione GitHub.
2. Clique na aba Pessoal.
3. Ao lado de Criar uma conexão pessoal, clique em Conectar.
4. Faça login no GitHub e autorize o ClickUp.

Desconectar a integração com o GitHub

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

1. Pesquise e selecione GitHub.
2. Selecione a guia Workspace.
   

   Apenas proprietários e administradores podem desconectar as conexões do espaço de trabalho.

3. Ao lado de Conectado, clique no menu reticências ....
4. Selecione **Desconectar**.
5. Para confirmar, clique em Desconectar.