Connectors > GitHub

Introducción

El conector de GitHub de Bizagi está disponible en el Connectors Xchange de Bizagi.

A través de este conector, podrá conectar sus procesos de Bizagi a una cuenta de GitHub y usar sus servicios.

Para más información de las capacidades de este conector, visite nuestro Connectors Xchange.

Este Conector se desarrolló de acuerdo con los contenidos del API o información sobre los mismos suministrada por GitHub. Bizagi no se hace responsable por errores derivados del llamado de los servicios del API, incongruencias en la documentación presentada por GitHub. Ni Bizagi ni sus filiales serán responsables de ofrecer cualquier tipo de garantía sobre los contenidos o errores derivados del llamado de los servicios del API. Bizagi y sus filiales no se harán responsables de las pérdidas, los costos o los daños en los que se incurra como consecuencia del acceso o el uso de los servicios del API de GitHub.

Este conector se encuentra actualmente en versión Beta. Úselo en ambientes de producción bajo su propio riesgo.

Antes de iniciar

Para probar y usar este conector, necesita:

1.Bizagi Studio previamente instalado.

2.El conector previamente instalado, tal como se describe en https://help.bizagi.com/platform/es/index.html?Connectors_Xchange.htm, o a través del manual de instalación descrito en https://help.bizagi.com/platform/es/index.html?connectors_setup.htm.

3.Una cuenta en https://github.com/.

4.Un token de acceso.

Obtener su token de acceso

Siga estos pasos para obtener su token de acceso

1.Diríjase a https://github.com/settings/developers e inicie sección con su cuenta de GitHub.

GitHub001

2.Vaya a la pestaña de nombre Personal access tokens.

GitHub002

3.Haga clic en Generate new token.

GitHub003

4.Dele un nombre a su token.

GitHub005

5.Active por lo menos los siguientes permisos para su token y haga clic en Generate token.

GitHub004

6.Copie este token de acceso y guárdelo en un lugar seguro.

GitHub006

Configurar el conector

Para configurar el conector siga los pasos descritos en el capítulo de configuración en https://help.bizagi.com/platform/es/index.html?connectors_setup.htm.

Tenga en cuenta los siguientes parámetros de autenticación:

•Authentication method: Custom

•TOKEN: Token que se obtuvo en el paso anterior.

•OWNER: Opcional - Nombre de usuario del dueño usado por defecto. Este será usado por todas las actividades que requieran un dueño (owner) a menos que se especifique lo contrario.

•REPO: Opcional - Nombre del repositorio usado por defecto. Este será usado por todas las actividades que requieran un repositorio (repo) a menos que se especifique lo contrario.

•ORG: Opcional - Nombre de la organización usada por defecto. Este será usado por todas las actividades que requieran una organización (org) a menos que se especifique lo contrario.

GitHub007

Usar el conector

Éste conector permite el uso desde Bizagi de varios métodos disponibles para el uso de los servicios de GitHub.

Para configurar el conector, por favor visite el artículo https://help.bizagi.com/platform/es/index.html?Connectors_Studio.htm.

Al usar el conector, asegúrese de tener en cuenta, para los métodos disponibles, los siguientes detalles:

Add assignees to an issue (Agregar asignado a un problema)

Esta acción permite agregar asignados a un problema.

Para configurar las entradas de esta acción tenga en cuenta:

• owner (Requerido): dueño del repositorio (nombre de usuario en GitHub). Si no se especifica este campo, se usa la variable global OWNER. Este parámetro debe ser de tipo String en su modelo de Bizagi.

• repo (Requerido): nombre del repositorio. Si no se especifica este campo, se usa la variable global REPO. Este parámetro debe ser de tipo String en su modelo de Bizagi.

• issue_number (Requerido): número de ID del problema. Este parámetro debe ser un número en su modelo de Bizagi.

• assignees (Requerido): nombres de los usuarios que se quieren asignar al problema. Los usuarios que ya están asignados al problema no se reemplazan. Si un asignado de la lista no existe, no bota ningún error, sino que simplemente se ignora. Este parámetro debe ser un arreglo de strings en su modelo de Bizagi.

Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.

Para más información de este método diríjase a la documentación oficial de GitHub - https://developer.github.com/v3/issues/assignees/#add-assignees-to-an-issue.

Check assignee (Verificar el asignado)

Esta acción permite verificar si se puede asignar un usuario a un problema.

Para configurar las entradas de esta acción tenga en cuenta:

• repo (Requerido): nombre del repositorio. Si no se especifica este campo, se usa la variable global REPO. Este parámetro debe ser de tipo String en su modelo de Bizagi.

• assignee (Requerido): nombre del usuario que se desea verificar. Diferencia entre mayísculas y minusculas. Este parámetro debe ser de tipo String en su modelo de Bizagi.

Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.

Para más información de este método diríjase a la documentación oficial de GitHub - https://developer.github.com/v3/issues/assignees/#check-assignee.

Create a comment (Crear un comentario)

Esta acción permite crear un comentario.

Para configurar las entradas de esta acción tenga en cuenta:

• repo (Requerido): nombre del repositorio. Si no se especifica este campo, se usa la variable global REPO. Este parámetro debe ser de tipo String en su modelo de Bizagi.

• issue_number (Requerido): número de ID del problema. Este parámetro debe ser un número en su modelo de Bizagi.

• body (Requerido): contenido del comentario. Este parámetro debe ser de tipo String en su modelo de Bizagi.

Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.

Para más información de este método diríjase a la documentación oficial de GitHub - https://developer.github.com/v3/issues/comments/#create-a-comment.

Create an issue (Crear un problema)

Esta acción permite crear un problema.

Para configurar las entradas de esta acción tenga en cuenta:

• repo (Requerido): nombre del repositorio. Si no se especifica este campo, se usa la variable global REPO. Este parámetro debe ser de tipo String en su modelo de Bizagi.

• title (Requerido): título del problema. Este parámetro debe ser de tipo String en su modelo de Bizagi.

• body: descripcion del problema. Este parámetro debe ser de tipo String en su modelo de Bizagi.

• labels: . Este parámetro debe ser un arreglo de strings en su modelo de Bizagi.

• assignees: . Este parámetro debe ser un arreglo de strings en su modelo de Bizagi.

Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.

Para más información de este método diríjase a la documentación oficial de GitHub - https://developer.github.com/v3/issues/#create-an-issue.

Delete a comment (Borrar un problema)

Esta acción permite borrar un comentario.

Para configurar las entradas de esta acción tenga en cuenta:

• repo (Requerido): nombre del repositorio. Si no se especifica este campo, se usa la variable global REPO. Este parámetro debe ser de tipo String en su modelo de Bizagi.

• comment_id (Requerido): ID del comentario que se quiere eliminar. Este parámetro debe ser un número en su modelo de Bizagi.

Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.

Para más información de este método diríjase a la documentación oficial de GitHub - https://developer.github.com/v3/issues/comments/#delete-a-comment.

Edit a comment (Editar un comentario)

Esta acción permite editar un comentario.

Para configurar las entradas de esta acción tenga en cuenta:

• repo (Requerido): nombre del repositorio. Si no se especifica este campo, se usa la variable global REPO. Este parámetro debe ser de tipo String en su modelo de Bizagi.

• comment_id (Requerido): ID del comentario que se quiere editar. Este parámetro debe ser un número en su modelo de Bizagi.

• body (Requerido): contenido del comentario. Este parámetro debe ser de tipo String en su modelo de Bizagi.

Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.

Para más información de este método diríjase a la documentación oficial de GitHub - https://developer.github.com/v3/issues/comments/#edit-a-comment.

Edit an issue (Editar un comentario)

Esta acción permite editar un problema.

Para configurar las entradas de esta acción tenga en cuenta:

• repo (Requerido): nombre del repositorio. Si no se especifica este campo, se usa la variable global REPO. Este parámetro debe ser de tipo String en su modelo de Bizagi.

• issue_number (Requerido): número de ID del problema. Este parámetro debe ser un número en su modelo de Bizagi.

• title (Requerido): título del problema. Este parámetro debe ser de tipo String en su modelo de Bizagi.

• body: descripción del problema. Este parámetro debe ser de tipo String en su modelo de Bizagi.

• state: el nuevo estado del problema. Posibles valores: "open", "closed". Default: "open". Este parámetro debe ser de tipo String en su modelo de Bizagi.

• labels: etiquetas a asociar con este problema. Solo los usuarios con "push access" pueden asignar etiquetas a los problemas. Si no se tienen los permisos necesarios, las etiquetas se eliminan sin generar ningun tipo de error. Este parámetro debe ser un arreglo de strings en su modelo de Bizagi.

• assignees: usuarios asignados a este problema. Solo los usuarios con "push access" pueden asignar usuarios a los problemas. Si no se tienen los permisos necesarios, los asignados se eliminan sin generar ningun tipo de error. Este parámetro debe ser un arreglo de strings en su modelo de Bizagi.

Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.

Para más información de este método diríjase a la documentación oficial de GitHub - https://developer.github.com/v3/issues/#edit-an-issue.

Get a single comment (Obtener un comentario)

Esta acción permite obtener un comentario específico.

Para configurar las entradas de esta acción tenga en cuenta:

• repo (Requerido): nombre del repositorio. Si no se especifica este campo, se usa la variable global REPO. Este parámetro debe ser de tipo String en su modelo de Bizagi.

• comment_id (Requerido): ID del comentario que se quiere consultar. Este parámetro debe ser un número en su modelo de Bizagi.

Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.

Para más información de este método diríjase a la documentación oficial de GitHub - https://developer.github.com/v3/issues/comments/#get-a-single-comment.

Get a single issue (Obtener un problema)

Esta acción permite obtener un problema específico.

Para configurar las entradas de esta acción tenga en cuenta:

• repo (Requerido): nombre del repositorio. Si no se especifica este campo, se usa la variable global REPO. Este parámetro debe ser de tipo String en su modelo de Bizagi.

• issue_number (Requerido): número de ID del problema. Este parámetro debe ser un número en su modelo de Bizagi.

Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.

Para más información de este método diríjase a la documentación oficial de GitHub - https://developer.github.com/v3/issues/#get-a-single-issue.

List all issues (Listar los problemas)

Esta acción permite get obtener multiples problemas.

Para configurar las entradas de esta acción tenga en cuenta:

• org: se puede especificar este parámetro de manera opcional, para solo listar problemas dentro de una organización específica. Ej: la organización "bizagi". De esta manera, se le hace más fácil al usuario ver solo los problemas de una organización, sin mezclarlos con sus repositorios privados u otras organizaciones a las que pertenece. Si no se especifica este parámetro en la entrada de la acción, se usa la variable global ORG, y si no existe en la variable global ORG, se ignora y se muestran los problemas que el usuario autenticado puede ver según los filtros que haya puesto en el parámetro "filter". Este parámetro debe ser de tipo String en su modelo de Bizagi.

• filter: filtra los problemas a retornar. Posibles valores: "assigned" (solo problemas asignados al usuario autenticado), "created" (problemas creados por el usuario autenticado), "mentioned" (problemas donde se menciona el usuario autenticado), "subscribed" (problemas a los que el usuario autenticado está inscrito para recibir actualizaciones), "all" (todos los problemas que el usuario autenticado puede ver, sin importar su participación o creación). Default: "assigned". Este parámetro debe ser de tipo String en su modelo de Bizagi.

• state: indica el estado de los problemas a retornar. Posibles valores: "open", "closed", "all". Default: "open". Este parámetro debe ser de tipo String en su modelo de Bizagi.

• labels: etiquetas utilizados para filtrar los problemas. Este parámetro debe ser un arreglo de strings en su modelo de Bizagi.

Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.

Para más información de este método diríjase a la documentación oficial de GitHub - https://developer.github.com/v3/issues/#list-issues.

List all labels in a repository (Listar las etiquetas de un repositorio)

Esta acción permite obtener todas las etiquetas de un repositorio.

Para configurar las entradas de esta acción tenga en cuenta:

• repo (Requerido): nombre del repositorio. Si no se especifica este campo, se usa la variable global REPO. Este parámetro debe ser de tipo String en su modelo de Bizagi.

Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.

Para más información de este método diríjase a la documentación oficial de GitHub - https://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository.

List assignees (Listar los asignados)

Esta acción permite obtener todos los asignados.

Para configurar las entradas de esta acción tenga en cuenta:

• repo (Requerido): nombre del repositorio. Si no se especifica este campo, se usa la variable global REPO. Este parámetro debe ser de tipo String en su modelo de Bizagi.

Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.

Para más información de este método diríjase a la documentación oficial de GitHub - https://developer.github.com/v3/issues/assignees/#list-assignees.

List comments in a repository (Listar los comentarios de un repositorio)

Esta acción permite obtener todos los comentarios de un repositorio.

Para configurar las entradas de esta acción tenga en cuenta:

• repo (Requerido): nombre del repositorio. Si no se especifica este campo, se usa la variable global REPO. Este parámetro debe ser de tipo String en su modelo de Bizagi.

Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.

Para más información de este método diríjase a la documentación oficial de GitHub - https://developer.github.com/v3/issues/comments/#list-comments-in-a-repository.

List comments on an issue (Listar los comentarios de un problema)

Esta acción permite obtener todos los comentarios.

Para configurar las entradas de esta acción tenga en cuenta:

• repo (Requerido): nombre del repositorio. Si no se especifica este campo, se usa la variable global REPO. Este parámetro debe ser de tipo String en su modelo de Bizagi.

• issue_number (Requerido): número de ID del problema. Este parámetro debe ser un número en su modelo de Bizagi.

Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.

Para más información de este método diríjase a la documentación oficial de GitHub - https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue.

List issues for a repository (Listar los problemas de un repositorio)

Esta acción permite obtener multiples problemas de un repositorio.

Para configurar las entradas de esta acción tenga en cuenta:

• repo (Requerido): nombre del repositorio. Si no se especifica este campo, se usa la variable global REPO. Este parámetro debe ser de tipo String en su modelo de Bizagi.

• state: indica el estado de los problemas a retornar. Posibles valores: "open", "closed", "all". Default: "open". Este parámetro debe ser de tipo String en su modelo de Bizagi.

• labels: etiquetas utilizados para filtrar los problemas. Este parámetro debe ser un arreglo de strings en su modelo de Bizagi.

Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.

Para más información de este método diríjase a la documentación oficial de GitHub - https://developer.github.com/v3/issues/#list-issues-for-a-repository.

List releases for a repository (Listar los lanzamientos de un repositorio)

Esta acción permite obtener todos los lanzamientos de un repositorio.

Para configurar las entradas de esta acción tenga en cuenta:

• repo (Requerido): nombre del repositorio. Si no se especifica este campo, se usa la variable global REPO. Este parámetro debe ser de tipo String en su modelo de Bizagi.

Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.

Para más información de este método diríjase a la documentación oficial de GitHub - https://developer.github.com/v3/repos/releases/#list-releases-for-a-repository.

Lock an issue (Bloquear un problema)

Esta acción permite bloquear un problema.

Para configurar las entradas de esta acción tenga en cuenta:

• repo (Requerido): nombre del repositorio. Si no se especifica este campo, se usa la variable global REPO. Este parámetro debe ser de tipo String en su modelo de Bizagi.

• issue_number (Requerido): número de ID del problema. Este parámetro debe ser un número en su modelo de Bizagi.

Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.

Para más información de este método diríjase a la documentación oficial de GitHub - https://developer.github.com/v3/issues/#lock-an-issue.

Remove assignees from an issue (Eliminar todos los asignados de un problema)

Esta acción permite eliminar todos los asignados de un problema.

Para configurar las entradas de esta acción tenga en cuenta:

• repo (Requerido): nombre del repositorio. Si no se especifica este campo, se usa la variable global REPO. Este parámetro debe ser de tipo String en su modelo de Bizagi.

• issue_number (Requerido): número de ID del problema. Este parámetro debe ser un número en su modelo de Bizagi.

• assignees (Requerido): nombres de los usuarios que se quieren eliminar del problema. Si se pasan usuarios que no existen o que no están asignados al problema, no genera ningún tipo de error, sino que simplemente se ignoran. Este parámetro debe ser un arreglo de strings en su modelo de Bizagi.

Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.

Para más información de este método diríjase a la documentación oficial de GitHub - https://developer.github.com/v3/issues/assignees/#remove-assignees-from-an-issue.

Unlock an issue (Desbloquear un problema)

Esta acción permite desbloquear un problema.

Para configurar las entradas de esta acción tenga en cuenta:

• repo (Requerido): nombre del repositorio. Si no se especifica este campo, se usa la variable global REPO. Este parámetro debe ser de tipo String en su modelo de Bizagi.

• issue_number (Requerido): número de ID del problema. Este parámetro debe ser un número en su modelo de Bizagi.

Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.

Para más información de este método diríjase a la documentación oficial de GitHub - https://developer.github.com/v3/issues/#unlock-an-issue.

Last Updated 10/28/2022 11:57:28 AM