Integración de GitHub

Enlaza espacios directamente con repositorios de GitHub para siempre saber qué trabajo está relacionado.

Los propietarios del entorno de trabajo y los administradores pueden conectar los espacios a sus repositorios, permitiendo a los miembros añadir su trabajo de Github a las tareas.

Las tareas en espacios con un repositorio conectado pueden vincularse con confirmaciones, ramas y solicitudes de validación.

Qué necesitas

  • La integración de GitHub está disponible en cada plan de ClickUp.
  • Solo los administradores del repositorio pueden añadir repositorios de GitHub a ClickUp. Una vez añadidos, ¡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 los Ajustes del Entorno de Trabajo en el Centro de aplicaciones.
  • Solo los propietarios y administradores del entorno de trabajo pueden añadir y enlazar repositorios a espacios.
  • Solo los propietarios y administradores del entorno de trabajo pueden crear conexiones de entorno de trabajo. Se permiten múltiples conexiones de entornos de trabajo.
  • Miembros y superiores pueden crear conexiones personales.
  • Invitados no pueden utilizar la integración de GitHub.
  • La Búsqueda Conectada del entorno de trabajo está disponible en el plan Business y superiores.

  • La Búsqueda Conectada Personal no está disponible para la integración con GitHub.

Ejemplo real

El equipo de ingeniería de tu aplicación móvil y el equipo de desarrollo web trabajan en repositorios y espacios separados, dentro de la misma organización de GitHub y entorno de trabajo de ClickUp.

Para comenzar con la integración:

  1. El propietario del entorno de trabajo o el administrador crea una conexión (a internet) a GitHub.
  2. El gestor de la app móvil conecta el repositorio app-mobile de GitHub al espacio de desarrollo de apps móviles.
  3. El gestor del sitio web conecta el repositorio GitHub del sitio web con el espacio web de marketing.
  4. Las tareas en los espacios de desarrollo de apps móviles y sitio web de marketing ahora muestran el icono de GitHub, permitiendo que ambos equipos enlacen sus tareas con commits, ramas y solicitudes de validación de GitHub.

Configura la integración

Hay cuatro pasos para configurar la integración de GitHub en ClickUp:

  1. Conecta GitHub.
  2. Adjunta repositorios de GitHub a tu entorno de trabajo.
  3. Enlaza repositorios de GitHub con espacios de ClickUp.
  4. Opcionalmente, puedes establecer un formato de nombre de rama personalizado.

Paso 1: Conectar GitHub

Necesitarás ser propietario o administrador del entorno de trabajo para configurar una conexión de entorno de trabajo para GitHub.

Puedes configurar una conexión con GitHub desde el Centro de aplicaciones o el centro de comandos.

En el Centro de aplicaciones:

  1. Busca y selecciona GitHub.
  2. Haz clic en la pestaña Entorno de trabajo.

    También puedes configurar una conexión personal para crear solicitudes de validación y ramas desde ClickUp. Las conexiones personales también pueden utilizarse para enlazar solicitudes de validación, ramas y confirmaciones existentes directamente desde las tareas de ClickUp. 

  3. Haz clic en Conectar.
  4. Inicia sesión en tu cuenta de GitHub para autorizar el acceso.

Captura de pantalla del botón Autorizar clickup al configurar la integración.

En el centro de comandos:

  1. Debajo de la barra de búsqueda, haz clic en Aplicaciones.
  2. Bajo GitHub, haz clic en Conectar.
  3. Bajo Conexiones del entorno de trabajo, haz clic en Conectar.
  4. Inicia sesión en tu cuenta de GitHub para autorizar el acceso.

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

Los propietarios y administradores del entorno de trabajo pueden elegir qué repositorios de GitHub vincular a su entorno de trabajo de ClickUp. El propietario o administrador también debe ser un administrador del repositorio de GitHub.

Vincular un repositorio no otorga a los usuarios de ClickUp acceso a la base de código de tu repositorio.

Para añadir un repositorio a un entorno de trabajo:

  1. Abre GitHub en el Centro de aplicaciones.
  2. Haz clic en Ajustes del entorno de trabajo.
  3. Junto a Conectar repositorios a ClickUp, haz clic en Añadir repositorio.
  4. Selecciona todos los repositorios que quieras añadir.

Si no ves los repositorios correctos, puede que hayas iniciado sesión con la cuenta de GitHub incorrecta.

Paso 3: Vincula repositorios de GitHub con espacios de ClickUp

Después de añadir repositorios a tu entorno de trabajo, puedes agregar cada repositorio a uno o más espacios. Cada espacio de ClickUp puede tener múltiples repositorios añadidos.

Puedes añadir o eliminar repositorios de los espacios en cualquier momento.

Para enlazar un repositorio a un espacio:

  1. Abre GitHub en el Centro de aplicaciones.
  2. Haz clic en Ajustes del entorno de trabajo.
  3. Haz clic en el nombre del repositorio que quieres enlazar.
  4. Haz clic en + Añadir Espacio.
  5. Repite la operación para los espacios adicionales que quieras enlazar.

Paso 4: Establece el formato del nombre de tu rama

Si tu organización utiliza un formato específico para los nombres de las ramas, puedes definirlo desde la página de GitHub en el App Center. Cuando las personas crean ramas desde tareas de ClickUp, se utilizará este formato.

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

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

Las opciones 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 por un guion.
:taskId: El ID de la tarea de ClickUp donde se crea la ramificación. Incluye el prefijo requerido.
:taskName: El nombre de la tarea donde se crea la rama. Los espacios se reemplazan por un guion.

Para establecer tu formato de nombre predeterminado desde GitHub en el Centro de aplicaciones:

  1. Haz clic en Ajustes del entorno de trabajo.
  2. En la sección Nombre de rama autogenerado, introduce el formato de nombre de rama que prefieras.
  3. Haz clic en Guardar.

Captura de pantalla de alguien creando un nombre de rama auto-generado personalizado.

Buscar archivos en GitHub utilizando la Búsqueda Conectada

Al utilizar una conexión de entorno de trabajo en el plan Business y superior, puedes utilizar la Búsqueda Conectada de Entorno de Trabajo para permitir que todos los miembros del entorno de trabajo busquen cualquier archivo público de los repositorios que agregues. Los archivos privados no pueden buscarse.

En el Centro de aplicaciones:

  1. Busca y selecciona GitHub.
  2. Haz clic en la pestaña Entorno de trabajo.
  3. Haz clic en el interruptor junto a Búsqueda Conectada del Espacio de Trabajo.
  4. Junto a tu conexión de entorno de trabajo, haz clic en Guardar.
  5. Los archivos de GitHub en los repositorios que has añadido se mostrarán al buscar en tu entorno de trabajo.

Anclar GitHub al centro de comandos

Filtra los resultados de búsqueda para archivos de GitHub anclando GitHub al centro de comandos.

Enlaza tareas desde GitHub

ClickUp asocia automáticamente la nueva actividad de GitHub con las tareas si incluyes un ID de tarea válido de ClickUp en cualquier parte del título de la solicitud de validación, la descripción de la solicitud de validació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 validación, se publicará un comentario con un enlace a la tarea de ClickUp en la solicitud de validación. Un enlace no se mostrará al pegar manualmente una solicitud de validación en una tarea de ClickUp.

El comentario se publicará utilizando la cuenta de GitHub de la persona que definió el repositorio y correlacionó los espacios.

El ID de tarea debe estar formateado utilizando una de estas opciones:

#{task_id}

CU-{task_id}

{custom_task_id}

#{custom_task_id}

Por ejemplo:

#1abc2de

CU-1abc2de

eng-123

#eng-123

Enlaza tareas desde ClickUp

También puedes vincular manualmente las tareas de ClickUp con confirmaciones, ramas y solicitudes de validación de GitHub desde la tarea de ClickUp. Asegúrate de que la tarea esté ubicada en un espacio que esté enlazado a un repositorio.

Para vincular una tarea:

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

    A la derecha, verás nombres de ramas sugeridos y mensajes de confirmación que puedes copiar al portapapeles. También puedes copiar el ID de tarea desde aquí.

  2. En la esquina inferior derecha, haz clic en Añadir enlace de GitHub.
    Captura de pantalla del cuadro de diálogo para añadir enlace de GitHub.
  3. Pegue un enlace.
  4. En la esquina inferior derecha, haz clic en Añadir.

Crear problemas, ramas y solicitudes de validación de GitHub desde ClickUp

También puedes crear nuevos problemas, ramificaciones y solicitudes de validación directamente desde las tareas. Asegúrate de que la tarea esté ubicada en un espacio que esté enlazado a un repositorio.

Para crear un problema, rama o solicitud de validación:

  1. Abre una tarea y haz clic en el icono de GitHub.
    A la derecha, verás nombres de ramas sugeridos y mensajes de confirmación que puedes copiar al portapapeles. También puedes copiar el ID de 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 problema en GitHub
    • Nueva rama de GitHub
    • Nueva solicitud de validación de GitHub
  4. Nombre el problema, la rama o la solicitud de validación.
  5. Seleccione un repositorio y complete la información. Añade una rama fuente y una rama objetivo si es aplicable.
    Captura de pantalla de alguien creando un nuevo problema en GitHub.
  6. Haz clic en Crear.

Vea la actividad de GitHub en ClickUp

Para ver toda la actividad de GitHub para una tarea, haz clic en el icono de GitHub en el lado derecho de la tarea.

Captura de pantalla de la pestaña de GitHub en una tarea después de que alguien añadiera una rama y un problema desde ClickUp.

La actividad de la tarea de GitHub utiliza el nombre de usuario de ClickUp de la persona, o su nombre de usuario de GitHub si no tiene una cuenta de ClickUp.

Actualiza los estados de las tareas desde GitHub

Puedes actualizar el estado de una tarea de ClickUp cuando enlazas una confirmación, empujas una confirmación o creas una solicitud de extracción. ClickUp recoge automáticamente la nueva actividad de GitHub y la asocia a las tareas si incluyes un ID de tarea válido en cualquier parte del título de la solicitud de pull, la descripción de la solicitud de pull, el nombre de la ramificación o el mensaje de confirmación.

El ID de tarea debe estar formateado utilizando una de estas opciones:

#{task_id}[estado]

CU-{task_id}[estado]

{custom_task_id}[estado]

#{custom_task_id}[estado]

Para actualizar el estado de una tarea:

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

Por ejemplo: #ud5b[ready]

Todos los formatos listados en la sección Enlazar tareas desde GitHub de este artículo pueden utilizarse. Para asegurar el formato adecuado, no añadas un espacio entre el ID de tarea y la información de estado.

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

Gestiona problemas, ramas, solicitudes de extracción y confirmaciones de GitHub desde ClickUp

Después de enlazar problemas, ramas, solicitudes de validación o confirmaciones, se mostrarán en el lado derecho de tu tarea cuando hagas clic en el icono de GitHub. Utiliza el menú de puntos suspensivos ... para copiar el enlace o eliminar el elemento.

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

Información del problema

Después de que se enlace un problema, puedes ver los siguientes detalles:

  • La persona que abrió el problema, conocida como el autor
  • Cualquier revisor asignado
  • Se ha creado el enlace.
  • Repositorio
  • El estado del problema.
  • URL

Información de la rama

Una vez enlazada una rama, puedes ver los detalles siguientes:

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

Información de solicitud de validación

Después de que una solicitud de validación esté enlazada, puedes ver los detalles siguientes:

  • La persona que abrió la solicitud de validación, conocida como el autor
  • Cualquier revisor asignado
  • Personas asignadas
  • Cambios de línea
  • Se ha creado el enlace.
  • Repositorio
  • Rama de origen
  • Rama objetivo
  • El estado de la solicitud de fusión
  • URL

Información de confirmación

Después de que se enlace una confirmación, puedes ver los siguientes detalles:

  • La persona que creó la confirmación, conocida como el autor
  • Archivos cambiados
  • Cambios de línea
  • Se ha creado el enlace.
  • Repositorio
  • URL

Añade tu cuenta de GitHub a ClickUp

Los miembros del entorno de trabajo pueden vincular sus cuentas de GitHub a su cuenta de ClickUp con antelación o cuando crean una rama o solicitud de validación.

Para añadir tu cuenta de GitHub desde el App Center:

  1. Busca y selecciona GitHub.
  2. Haz clic en la pestaña Personal.
  3. Junto a Crear una conexión personal, haz clic en Conectar.
  4. Inicia sesión en GitHub y autoriza ClickUp.

Desconectar la integración de GitHub

Si ya no necesitas acceder a archivos de GitHub en ClickUp, puedes desconectar la integración desde el Centro de aplicaciones:

  1. Busca y selecciona GitHub.
  2. Selecciona la pestaña Entorno de trabajo.

    Solo los propietarios y administradores pueden desconectar las conexiones de Workspace.

  3. Junto a Conectado, haz clic en el menú de puntos suspensivos ....
  4. Selecciona Desconectar.
  5. Para confirmar, haz clic en Desconectar.

¿Fue útil este artículo?