Menu

Artículos en esta sección

Más información

Integración con Github

Avatar
Eugenia Mendez Zubieta
  • Actualización

En COR tenemos la posibilidad de integrar nuestra cuenta de Github y de esa manera asociar nuestros PRs a las tareas existentes.

 

Activación

Lo primero que tenemos que hacer, es ir al repositorio donde tenemos la pull request que queremos asociar a la tarea de COR. Allí, tenemos que ir a Settings → Webhooks → Add webhooks:

webhook0.png
Nota: Esto debemos hacerlo en todos los repositorios que queremos asociar.


Luego, debemos completar:

  • Payload URL con la url de la api: https://api.projectcor.com/v1/git
  • Content type con: application/json
  • Secret: con cualquier palabra para firmar la integración.
Cuando agreguemos esa Secret, es necesario que la enviemos a help@projectcor.com para que desde COR se asigne en la cuenta.

 

En eventos, debemos seleccionar "enviarme todo" para que podamos integrar correctamente nuestras tareas y para finalizar, debemos hacer click en "Agregar Webhook":

webhook.png

Documentación en GitHub, sobre webhooks: Creating webhooks

 

Conexión

Para poder conectar un pull request con una tarea, será necesario incorporar al nombre que el pull request tiene en GitHub la palabra COR + un guión medio (-) + el ID de la tarea correspondiente de COR al comienzo. Es importante que si le agregamos una descripción al nombre de la pr, dejemos un espacio en blanco entre el ID de la tarea y esa descripción.

Nombre del pull request: COR-{task_id} Descripción

 

webhook2.png

A una tarea se le pueden asociar múltiples PRs, pero a una pull request se le puede asociar sólo una tarea de COR.

Para cambiar la asociación de un PR de una tarea a otra, simplemente podemos sobrescribir el ID de tarea con el de la nueva a asociarle.

Para desasociar un PR de una tarea, alcanza con eliminar el ID de la tarea del nombre del pull request, en GitHub.

 

Funcionalidad

Una vez activada la integración y asociada una Pull Request a una tarea de COR, aparecerá automáticamente en el margen exterior izquierdo del panel de la tarea, el ícono de GitHub.

TAREA_1.png
​​

Al hacer clic en el ícono de GitHub, se desplegará un modal que contendrá información esencial:

  • Repositorio linkeado
  • Pull request linkeado
  • Estado en que se encuentra el Pull request
  • Release (rama correspondiente)
  • El ícono del usuario Autor (de GitHub) con un tooltip con su nombre de usuario.


TAREA_2.png​​

Los estados que se muestran en COR son:

  • PULL_REQUEST: Esperando aprobación de la PR

  • MERGED: Aprobado


Hacer click en el nombre del Repositorio en este modal, nos redirecciona al repositorio del Pull request en GitHub.
Hacer click en el nombre del Pull request en este modal, nos redirecciona al código correspondiente a ese Pull Request.