Integración con GitHub

Busca archivos de GitHub desde ClickUp, sincroniza la actividad de GitHub con tareas de ClickUp, crea pull requests, ramas e issues de GitHub desde ClickUp y mucho más.

Al configurar la integración, vincularás Espacios directamente a repositorios de GitHub para que siempre sepas qué trabajo está relacionado.

Los propietarios y administradores del Entorno de trabajo pueden conectar Espacios a sus repositorios, lo que permite a los miembros añadir su trabajo de GitHub a las tareas.

Las tareas en Espacios con un repositorio conectado se pueden vincular con commits, ramas y pull requests.

Qué necesitarás

  • La integración con GitHub está disponible en todos los planes de ClickUp.
  • Solo los administradores de repositorios pueden añadir repositorios de GitHub a ClickUp. Una vez añadidos, los administradores del Entorno de trabajo pueden añadir esos repositorios a los Espacios de ClickUp.
  • Solo los propietarios y administradores del Entorno de trabajo pueden actualizar la configuración del Entorno de trabajo en el App Center.
  • Solo los propietarios y administradores del Entorno de trabajo pueden añadir y vincular repositorios a los Espacios.
  • Solo los propietarios y administradores del Entorno de trabajo pueden crear conexiones del Entorno de trabajo. Se permiten varias conexiones del Entorno de trabajo.
  • Los miembros y roles superiores pueden crear conexiones personales.
  • Los invitados y los miembros con acceso limitado no pueden usar la integración con GitHub.

Tipos de conexión

Las funciones y los comandos disponibles dependen del tipo de conexión que uses.

Tipo de conexión Descripción Funciones Comandos
Conexión personal Conecta tu cuenta de GitHub con tu cuenta de usuario de ClickUp para cada Entorno de trabajo que hayas creado o al que te hayas unido. Los datos de tu cuenta de GitHub no estarán disponibles para nadie más a través de ClickUp. Vistas previas de enlaces de GitHub:
Las vistas previas de enlaces te permiten ver visualizaciones en tiempo real y sincronizadas de los enlaces directamente en ClickUp.
Crear ramas y pull requests:
Crea y asocia rápidamente objetos de GitHub a las tareas.
Panel de aplicación en la vista de tarea:
Consulta los enlaces de GitHub desde un lugar central en las tareas.
Al usar los comandos de GitHub, los usuarios solo pueden ver aquello para lo que tienen autorización en GitHub.

Abrir GitHub: abre GitHub en una pestaña nueva.

Crear nuevo issue de GitHub: crea un nuevo issue de GitHub desde ClickUp.

Crear nuevo Gist de GitHub: abre una pestaña en la página de creación de Gist.

Crear nueva rama de GitHub: crea una nueva rama de GitHub desde ClickUp.

Crear nuevo pull request de GitHub: la forma más rápida de crear un pull request de GitHub.
Conexión del Entorno de trabajo El propietario o los administradores del Entorno de trabajo pueden habilitar GitHub como conexión del Entorno de trabajo.
Usa esta conexión para que todos tengan acceso a la búsqueda conectada.
Sincronizar actividad con tareas:
Sincroniza la actividad de GitHub con las tareas tras vincular Espacios directamente a repositorios de GitHub.
Actualizar el estado de la tarea desde GitHub:
Cambia el estado de tus tareas de ClickUp directamente desde GitHub.
Búsqueda conectada del Entorno de trabajo:
La búsqueda conectada del Entorno de trabajo permite a todos los miembros buscar tanto registros públicos como privados de la cuenta conectada.
Vistas previas de enlaces de GitHub:
Las vistas previas de enlaces te permiten ver visualizaciones en tiempo real y sincronizadas de los enlaces directamente en ClickUp.
Panel de aplicación en la vista de tarea:
Consulta los enlaces de GitHub desde un lugar central en las tareas.
No disponible

Configurar una conexión personal

Para configurar una conexión personal con GitHub:

  1. En la esquina superior izquierda, haz clic en el avatar de tu Entorno de trabajo y selecciona Apps.
  2. Busca y selecciona GitHub.
  3. Haz clic en Conectar.
  4. Sigue las instrucciones para autorizar ClickUp y haz clic en Listo.

Configurar una conexión de Entorno de trabajo

Hay tres pasos para configurar una conexión de Entorno de trabajo para GitHub en ClickUp:

  1. Conectar GitHub.
  2. Adjuntar repositorios de GitHub a tu Entorno de trabajo. Los repositorios son necesarios para que ClickUp pueda vincular automáticamente las solicitudes de incorporación de cambios a sus respectivas tareas de ClickUp.
  3. Vincular repositorios de GitHub a Espacios de ClickUp.

Paso 1: Conectar GitHub

Para configurar una conexión de Entorno de trabajo para GitHub:

  1. En la esquina superior izquierda, haz clic en el avatar de tu Entorno de trabajo y selecciona Apps.
  2. Busca y selecciona GitHub.
  3. En la parte superior, haz clic en la pestaña Entorno de trabajo.
    • Opcional: Desactiva la Búsqueda conectada del Entorno de trabajo haciendo clic en el interruptor que aparece junto a ella.
  4. Haz clic en Conectar.
  5. Sigue las instrucciones para autorizar ClickUp.
  6. Elige qué repositorios quieres que se puedan buscar a través de la Búsqueda conectada del Entorno de trabajo haciendo clic en el menú desplegable Seleccionar repositorios.
  7. Cuando hayas añadido los repositorios, haz clic en Guardar.

    Captura de pantalla que resalta el botón Guardar.

  8. Haz clic en Siguiente y luego selecciona Hecho.

Paso 2: Añadir repositorios de GitHub a tu Entorno de trabajo

Solo el propietario de la conexión puede añadir repositorios.

Adjuntar un repositorio no concede a los usuarios de ClickUp acceso al código fuente de tu repositorio.

Para añadir un repositorio a tu Entorno de trabajo:

  1. Desde la página de GitHub en el App Center, haz clic en Ajustes en la parte superior derecha.
  2. Haz clic en Añadir repo.
  3. Selecciona un repositorio.
  4. Para añadir más repositorios, repite los pasos 2 y 3.

Si no ves los repositorios correctos, comprueba que has iniciado sesión en la cuenta adecuada. Un propietario o administrador del Entorno de trabajo debe seleccionar cada repositorio para conectarlo. Los repositorios vinculados se pueden consultar en el App Center.

Paso 3: Vincular repositorios de GitHub a Espacios de ClickUp

Tras añadir repositorios a tu Entorno de trabajo, los administradores pueden conectar cada repositorio a uno o varios Espacios. También es posible añadir varios repositorios a un mismo Espacio.

Para vincular un repositorio a un Espacio:

  1. Desde la página de GitHub en el App Center, haz clic en Ajustes en la parte superior derecha.
  2. Haz clic en el nombre del repositorio que quieras vincular.
  3. Haz clic en + Añadir Espacio.

    Captura de pantalla del botón Añadir Espacio.

  4. Busca y selecciona un Espacio.
  5. Para vincular Espacios adicionales, repite los pasos 2-4.

Cambiar el formato del nombre de rama

Si tu organización usa un formato específico para los nombres de rama, puedes configurarlo desde la página de GitHub en el App Center. Cuando los usuarios creen ramas a partir de tareas de ClickUp, se aplicará ese formato.

El formato predeterminado es: :taskId:_:taskName:_:username:

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

Los valores disponibles aparecen en la siguiente tabla:

Valor Descripción
:username: El nombre de usuario de la cuenta de ClickUp que creó la rama. Los espacios se reemplazan por un guion.
:taskId: El ID de la tarea de ClickUp donde se crea la rama. Incluye el prefijo obligatorio.
:taskName: El nombre de la tarea donde se crea la rama. Los espacios se reemplazan por un guion.

Para cambiar el formato del nombre de rama:

  1. Desde la página de GitHub en el App Center, haz clic en Ajustes en la esquina superior derecha.
  2. En Nombre de rama generado automáticamente, escribe el formato de nombre de rama que prefieras.
  3. Haz clic en Guardar.

Captura de pantalla de alguien creando un nombre de rama generado automáticamente personalizado.

Buscar archivos de GitHub con la Búsqueda conectada

Usa la Búsqueda conectada del Entorno de trabajo para que todos los miembros del Entorno de trabajo puedan buscar cualquier archivo público de los repositorios que añadas.

Editar los repositorios en los que se puede buscar

Para editar qué repositorios se pueden buscar a través de la Búsqueda conectada del Entorno de trabajo:

  1. Desde la página de GitHub en el App Center, haz clic en la pestaña Entorno de trabajo.
  2. Añade o elimina repositorios de la Búsqueda conectada del Entorno de trabajo:
    • Añadir nuevos repositorios: haz clic en el menú desplegable repositorios seleccionados y selecciona un repositorio.
    • Eliminar un repositorio existente: a la derecha del repositorio, haz clic en el icono x.

Captura de pantalla del menú desplegable y los iconos x.

Permitir que los Super Agent busquen en GitHub

Para que un Super Agent pueda buscar archivos en tu cuenta de GitHub conectada, activa la Búsqueda externa para GitHub en su perfil.

Vincular tareas desde GitHub

ClickUp asocia automáticamente la nueva actividad de GitHub con las tareas si incluyes un ID de tarea de ClickUp válido en cualquier parte del título de la solicitud de extracción, la descripción, el nombre de la rama o el mensaje de confirmación.

Cuando se incluye un ID de tarea de ClickUp en una solicitud de extracción, se publica un comentario con un enlace a la tarea de ClickUp en dicha solicitud. El enlace no aparece si pegas manualmente una solicitud de extracción en una tarea de ClickUp.

El comentario se publica con la cuenta de GitHub de la persona que configuró el repositorio y la asignación del Espacio.

El ID de tarea debe tener el formato de una de estas opciones:

#{task_id}

CU-{task_id}

{custom_task_id}

#{custom_task_id}

Por ejemplo:

#1abc2de

CU-1abc2de

eng-123

#eng-123

Vincular tareas desde ClickUp

Vincula manualmente tareas de ClickUp a confirmaciones, ramas y solicitudes de extracción de GitHub desde la tarea. Asegúrate de que la tarea esté en un Espacio vinculado a un repositorio.

Para vincular una tarea:

  1. Abre una tarea y haz clic en el icono de GitHub.

    Alguien haciendo clic en el icono de GitHub.

  2. En la esquina inferior derecha, haz clic en Añadir enlace de GitHub.
  3. Pega un enlace.
  4. En la esquina inferior derecha, haz clic en Añadir.

Actividad de tareas de ClickUp

Puedes acceder a la actividad de GitHub desde el feed de Actividad de la tarea de ClickUp vinculada.

Captura de pantalla que muestra el feed de actividad.

A veces, los feeds de actividad de las tareas contraen elementos similares para que puedas ver los detalles más importantes.

Puedes realizar las siguientes acciones para localizar la actividad de GitHub en una tarea:

  • Haz clic en Mostrar más para ver la actividad que se ha ocultado.

    Captura de pantalla del botón Mostrar más.

  • Cuando se fusiona una rama, las confirmaciones aparecen como un único elemento de actividad en el feed de actividad de la tarea.
    • Haz clic en el enlace a todas las confirmaciones para abrir un modal.
    • Haz clic en una confirmación individual para abrirla en GitHub.
  • Filtra la actividad de la tarea por Elementos de Git.

    Captura de pantalla del icono de filtro.

Actividad que falta

Si no encuentras cierta actividad, asegúrate de que estás referenciando correctamente el ID de tarea de ClickUp para vincular la actividad en GitHub. Puedes usar cualquiera de estas tres opciones para referenciar tus tareas de ClickUp en confirmaciones, nombres de rama y solicitudes de extracción:

#{task_id}

CU-{task_id}

{custom_task_id}

Por ejemplo:

#1abc2de

CU-1abc2de

prefix-1

También puedes vincular manualmente tareas de ClickUp con confirmaciones, ramas y solicitudes de extracción de GitHub desde la propia tarea de ClickUp.

Vistas previas de enlaces de GitHub

Cuando pegas un enlace de GitHub en medio de una frase o dentro de un texto existente, se mostrará una vista previa del enlace en línea sobre la que puedes pasar el cursor para ver más detalles.

Cuando pegas un enlace de GitHub en una línea nueva, puedes elegir mostrarlo en línea, como vista previa en directo o como una URL normal.

Las vistas previas de enlaces funcionan en descripciones de tareas, comentarios, Documentos y mensajes de Chat. Para cambiar manualmente el tipo de vista previa de un enlace, pasa el cursor sobre él y haz clic en el icono de puntos suspensivos ….

Crear issues, ramas y pull requests de GitHub desde ClickUp

Crea nuevos issues, ramas y pull requests directamente desde las tareas.

Asegúrate de que la tarea esté en un Espacio vinculado a un repositorio y de que tengas una conexión personal configurada.

Para crear un issue, una rama o un pull request:

  1. Abre una tarea y haz clic en el icono de GitHub. A la derecha verás nombres de rama sugeridos y mensajes de commit que puedes copiar en el portapapeles. También puedes copiar el ID de la tarea desde aquí.
  2. En la esquina inferior derecha, haz clic en Añadir enlace de GitHub.
  3. Elige una de las siguientes opciones:
    • Nuevo issue de GitHub
    • Nueva rama de GitHub
    • Nueva pull request de GitHub
  4. Ponle nombre al issue, la rama o el pull request.
  5. Selecciona un repositorio y rellena la información. Si procede, añade una rama de origen y una rama de destino.

    Captura de pantalla de alguien creando un nuevo issue de GitHub.

  6. Haz clic en Crear.

Panel de GitHub en las tareas

Las tareas de los Espacios vinculados a repositorios tienen un icono de GitHub en el que puedes hacer clic para ver todos los enlaces de GitHub publicados en la tarea.

Captura de pantalla del icono de GitHub.png

La actividad de las tareas en GitHub utiliza el nombre de usuario de ClickUp de la persona, o su nombre de usuario de GitHub si no tiene cuenta de ClickUp.

Actualizar estados de tareas desde GitHub

Puedes actualizar el estado de una tarea de ClickUp cuando vinculas un commit, haces push de un commit o creas un pull request. ClickUp detecta automáticamente la nueva actividad de GitHub y la asocia con las tareas si incluyes un ID de tarea válido en cualquier parte del título del pull request, la descripción del pull request, el nombre de la rama o el mensaje del commit.

El ID de la tarea debe tener uno de estos formatos:

#{task_id}[status]

CU-{task_id}[status]

{custom_task_id}[status]

#{custom_task_id}[status]

Para actualizar el estado de una tarea:

  1. Añade el ID de tarea de ClickUp en cualquier parte del mensaje del commit o del pull request.
  2. Incluye el estado actualizado de la tarea entre corchetes.

Por ejemplo: #ud5b[ready]

Puedes usar cualquiera de los formatos indicados en la sección «Vincular tareas desde GitHub» de este artículo. Para que el formato sea correcto, no añadas un espacio entre el ID de la tarea y la información del estado.

También puedes actualizar los estados de las tareas con las automatizaciones de GitHub.

Gestionar issues, ramas, pull requests y commits de GitHub desde ClickUp

Cuando vinculas issues, ramas, pull requests o commits, estos aparecen en la lista al hacer clic en el icono de GitHub en una tarea. Usa el menú de puntos suspensivos ... para copiar el enlace o eliminar el elemento.

Al vincular un elemento de GitHub, se muestra la siguiente información en tu tarea de ClickUp:

Información del issue

Al vincular un issue, puedes ver los siguientes detalles:

  • La persona que abrió el issue, conocida como el autor
  • Los revisores asignados
  • Enlace creado
  • Repositorio
  • El estado del issue
  • URL

Información de la rama

Al vincular una rama, puedes ver los siguientes detalles:

  • La persona que creó la rama, conocida como el autor
  • Creador del enlace
  • Repositorio
  • URL

Información del pull request

Al vincular un pull request, puedes ver los siguientes detalles:

  • La persona que abrió el pull request, conocida como el autor
  • Los revisores asignados
  • Asignados
  • Cambios de línea
  • Enlace creado
  • Repositorio
  • Rama de origen
  • Rama de destino
  • El estado del pull request
  • URL

Información del commit

Al vincular un commit, puedes ver los siguientes detalles:

  • La persona que creó el commit, conocida como el autor
  • Archivos modificados
  • Cambios de línea
  • Enlace creado
  • Repositorio
  • URL

Ver pull requests en la Vista Lista o la Vista Tabla

Añade la columna Pull Requests a cualquier Vista Lista o Vista Tabla para ver rápidamente tus pull requests de GitHub de un vistazo general.

Problemas de conexión

A veces, la cuenta de GitHub vinculada es incorrecta o hay un problema con la conexión. En ese caso, puedes intentar desconectar y volver a conectar tus repositorios o toda la cuenta.

Estas acciones no afectan a la capacidad de nadie para acceder a los repositorios con su cuenta de GitHub a través de GitHub.

Para desconectar un repositorio:

  1. En el App Center, selecciona GitHub.
  2. En la esquina superior derecha, haz clic en Ajustes.
  3. A la derecha del repositorio, haz clic en el icono de puntos suspensivos ....
  4. Haz clic en Eliminar de ClickUp.

Captura de pantalla del botón Delete from ClickUp.

Desconectar GitHub de ClickUp

Si ya no necesitas acceder a los archivos de GitHub en ClickUp, puedes desconectar la integración:

  1. En el App Center, selecciona GitHub.
  2. Selecciona la pestaña Entorno de trabajo. Solo los propietarios y los administradores pueden desconectar las conexiones del Entorno de trabajo.
  3. Junto a Conectado, haz clic en el menú de puntos suspensivos ...
  4. Selecciona Desconectar.
  5. Para confirmar, haz clic en Desconectar.

Ámbitos de OAuth

A continuación encontrarás una tabla con todos los ámbitos de OAuth de la integración con GitHub para que puedas tomar decisiones informadas sobre seguridad y cumplimiento normativo antes de activarla en tu Entorno de trabajo.

Ámbito Descripción
read:user Identifica al usuario y su perfil básico
repo Permite indexar el contenido del repositorio, mostrar vistas previas de enlaces y ejecutar comandos de repositorio
admin:repo_hook Permite crear y gestionar webhooks para las funciones de sincronización
project Cuando está activado, permite acceder a los datos de proyectos y tableros
read:org Cuando está activado, permite acceder a los datos de proyectos y tableros