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 agregar su trabajo de GitHub a las tareas.

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

Lo que necesitas

  • La integración con GitHub está disponible en todos los planes de ClickUp.
  • Solo los administradores de repositorios pueden agregar repositorios de GitHub a ClickUp. Una vez agregados, los administradores del entorno de trabajo pueden agregar 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 agregar 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
Integración personal Conecta tu cuenta de GitHub con tu cuenta de usuario de ClickUp en 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 objetos de GitHub a tareas rápidamente.
Panel de aplicaciones en la vista de tarea:
Ve los enlaces de GitHub desde un lugar central en las tareas.
Al usar comandos de GitHub, las personas solo pueden ver lo que están autorizadas a ver 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.
Integración de entorno de trabajo El propietario o los administradores del entorno de trabajo pueden habilitar GitHub como conexión de entorno de trabajo.
Usa esta conexión para darle acceso a todos a la búsqueda conectada.
Sincronizar actividad con tareas
Sincroniza la actividad de GitHub con las tareas después de 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 registros públicos y 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 aplicaciones en la vista de tarea:
Ve 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 luego haz clic en Listo.

Configurar una conexión del entorno de trabajo

Hay tres pasos para configurar una conexión del 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 cambio a sus tareas de ClickUp correspondientes.
  3. Vincular repositorios de GitHub a Espacios de ClickUp.

Paso 1: Conectar GitHub

Para configurar una conexión del 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 indicaciones para autorizar ClickUp.
  6. Elige qué repositorios quieres que aparezcan en la búsqueda conectada del entorno de trabajo haciendo clic en el menú desplegable Seleccionar repositorios.
  7. Una vez que hayas agregado los repositorios, haz clic en Guardar.

    Captura de pantalla que resalta el botón Guardar.

  8. Haz clic en Siguiente y luego selecciona Listo.

Paso 2: Agregar repositorios de GitHub a tu entorno de trabajo

Solo el propietario de la conexión puede agregar repositorios.

Adjuntar un repositorio no les da a los usuarios de ClickUp acceso al código base de tu repositorio.

Para agregar un repositorio a tu entorno de trabajo:

  1. Desde la página de GitHub en el App Center, haz clic en Configuración en la parte superior derecha.
  2. Haz clic en Agregar repositorio.
  3. Selecciona un repositorio.
  4. Para agregar más repositorios, repite los pasos 2 y 3.

Si no ves los repositorios correctos, verifica que hayas iniciado sesión en la cuenta adecuada. El 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

Después de agregar repositorios a tu entorno de trabajo, los administradores pueden conectar cada repositorio a uno o más Espacios. Un mismo Espacio puede tener varios repositorios agregados.

Para vincular un repositorio a un Espacio:

  1. Desde la página de GitHub en el App Center, haz clic en Configuración en la parte superior derecha.
  2. Haz clic en el nombre del repositorio que quieres vincular.
  3. Haz clic en + Agregar Espacio.

    Captura de pantalla del botón Agregar Espacio.

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

Cambiar el formato del nombre de tu 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 alguien cree una rama desde una tarea de ClickUp, se usará este formato.

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

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

Los valores disponibles se muestran 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 con 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 con un guion.

Para cambiar el formato del nombre de tu rama:

  1. Desde la página de GitHub en el App Center, haz clic en Configuración 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 agregues.

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. Agrega o quita repositorios de la Búsqueda Conectada del entorno de trabajo:
    • Agregar nuevos repositorios: Haz clic en el menú desplegable repositorios seleccionados y selecciona un repositorio.
    • Quitar un repositorio existente: A la derecha del repositorio, haz clic en el ícono x.

Captura de pantalla del menú desplegable y los íconos x.

Permitir que los Super Agents busquen en GitHub

Para permitir que un Super Agent busque 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 del pull request, la descripción del pull request, el nombre de la rama o el mensaje del commit.

Cuando se incluye un ID de tarea de ClickUp en un pull request, se publica un comentario con un enlace a la tarea de ClickUp en ese pull request. El enlace no aparecerá si pegas manualmente un pull request en una tarea de ClickUp.

El comentario se publicará con la cuenta de GitHub de la persona que configuró el repositorio y el mapeo del Space.

El ID de tarea debe tener uno de estos formatos:

#{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 commits, ramas y pull requests 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 ícono de GitHub.

    Alguien haciendo clic en el ícono de GitHub.

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

Actividad de tareas en ClickUp

La actividad de GitHub se puede ver desde el feed de Actividad de la tarea de ClickUp vinculada.

Captura de pantalla que resalta el feed de actividad.

Los feeds de actividad de las tareas a veces agrupan elementos similares para que puedas ver los detalles más importantes.

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

  • Haz clic en Mostrar más para ver la actividad oculta.

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

  • Cuando se fusiona una rama, los commits aparecen como un único elemento de actividad en el feed de actividad de la tarea.
    • Haz clic en el enlace a todos los commits para abrir un modal.
    • Haz clic en un commit individual para abrirlo en GitHub.
  • Filtra la actividad de la tarea por Elementos de Git.

    Captura de pantalla del ícono de filtro.

Actividad faltante

Si no encuentras cierta actividad, asegúrate de referenciar 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 commits, nombres de ramas y pull requests:

#{task_id}

CU-{task_id}

{custom_task_id}

Por ejemplo:

#1abc2de

CU-1abc2de

prefix-1

También puedes vincular manualmente tareas de ClickUp con commits, ramas y pull requests de GitHub desde la tarea de ClickUp.

Vistas previas de enlaces de GitHub

Cuando pegas un enlace de GitHub en medio de una oración o dentro de un texto existente, se muestra una vista previa en línea del enlace 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 vivo 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 ícono de puntos suspensivos ….

Crear incidencias, ramas y pull requests de GitHub desde ClickUp

Crea nuevas incidencias, 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 una incidencia, rama o pull request:

  1. Abre una tarea y haz clic en el ícono de GitHub. A la derecha verás nombres de ramas sugeridos y mensajes de commit que puedes copiar al portapapeles. También puedes copiar el ID de la tarea desde ahí.
  2. En la esquina inferior derecha, haz clic en Add GitHub link.
  3. Elige una de las siguientes opciones:
    • New GitHub Issue
    • New GitHub Branch
    • New GitHub Pull Request
  4. Ponle nombre a la incidencia, rama o pull request.
  5. Selecciona un repositorio y completa la información. Agrega una rama de origen y una rama de destino si aplica.

    Captura de pantalla de alguien creando una nueva incidencia de GitHub.

  6. Haz clic en Create.

Panel de GitHub en las tareas

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

Captura de pantalla del ícono de GitHub.png

La actividad de tareas de GitHub usa el nombre de usuario de ClickUp de la persona, o su nombre de usuario de GitHub si no tiene una 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 de commit.

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

#{task_id}[status]

CU-{task_id}[status]

{custom_task_id}[status]

#{custom_task_id}[status]

Para actualizar el estado de una tarea:

  1. Agrega 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 listados en la sección Vincular tareas desde GitHub de este artículo. Para que el formato sea correcto, no agregues espacio entre el ID de la tarea y la información del estado.

¡También puedes actualizar los estados de las tareas con Automatizaciones de GitHub!

Administra incidencias, ramas, pull requests y commits de GitHub desde ClickUp

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

Una vez que vinculas un elemento de GitHub, tu tarea de ClickUp muestra la siguiente información:

Información de la incidencia

Al vincular una incidencia, puedes ver los siguientes detalles:

  • La persona que abrió la incidencia, conocida como el autor
  • Revisores asignados
  • Enlace creado
  • Repositorio
  • El estado de la incidencia
  • 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
  • Revisores asignados
  • Personas asignadas
  • 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 en la vista Tabla

Agrega la columna Pull Requests a cualquier vista Lista o vista Tabla para ver tus pull requests de GitHub de un vistazo.

Problemas de conexión

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

Estas acciones no afectan 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 Configuración.
  3. A la derecha del repositorio, haz clic en el ícono de puntos suspensivos ...
  4. Haz clic en Delete from 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 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.

Alcances de OAuth

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

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