GitHub
El conector de GitHub te permite realizar operaciones de inserción, eliminación, actualización y lectura en datos de GitHub.
Antes de comenzar
Antes de usar el conector de GitHub, realiza las siguientes tareas:
- En tu proyecto de Google Cloud, haz lo siguiente:
- Otorga el rol de IAM roles/connectors.admin al usuario que configure el conector.
- Otorga los siguientes roles de IAM a la cuenta de servicio que deseas usar para el conector:
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
Una cuenta de servicio es un tipo de Cuenta de Google especial que representa a un usuario no humano que debe autenticarse y tener autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crear una. Para obtener más información, consulta Crea una cuenta de servicio.
- Habilita los siguientes servicios:
secretmanager.googleapis.com
(API de Secret Manager)connectors.googleapis.com
(API de conectores)
Para comprender cómo habilitar servicios, consulta Habilita servicios.
Si estos servicios o permisos no se habilitaron antes para tu proyecto, se te solicitará que los habilites cuando configures el conector.
- En GitHub, según tus requisitos, completa las siguientes tareas:
- Crea una cuenta de GitHub.
- Crea repositorios nuevos.
- Crear organizaciones nuevas.
- Crea proyectos.
- Crea una app de OAuth.
- Crea una app de GitHub.
Configura el conector
Para configurar el conector, debes crear una conexión a tu fuente de datos (sistema de backend). Una conexión es específica de una fuente de datos. Significa que, si tienes muchas fuentes de datos, debes crear una conexión independiente para cada fuente. Para crear una conexión, sigue estos pasos:
- En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.
- Haz clic en + CREAR NUEVO para abrir la página Crear conexión.
- En la sección Ubicación, elige la ubicación para la conexión.
- Región: selecciona una ubicación de la lista desplegable.
Para obtener la lista de todas las regiones compatibles, consulta Ubicaciones.
- Haz clic en SIGUIENTE.
- Región: selecciona una ubicación de la lista desplegable.
- En la sección Detalles de la conexión, completa lo siguiente:
- Conector: Selecciona GitHub en la lista desplegable de conectores disponibles.
- Versión del conector: selecciona la versión del conector de la lista desplegable de versiones disponibles.
- En el campo Nombre de la conexión, ingresa un nombre para la instancia de conexión.
Los nombres de las conexiones deben cumplir con los siguientes criterios:
- Los nombres de las conexiones pueden usar letras, números o guiones.
- Las letras deben estar en minúsculas.
- Los nombres de las conexiones deben comenzar con una letra y terminar con una letra o un número.
- Los nombres de las conexiones no pueden superar los 49 caracteres.
- De manera opcional, ingresa una Descripción para la instancia de conexión.
- De manera opcional, habilita Cloud Logging.
y, luego, selecciona un nivel de registro. De forma predeterminada, el nivel de registro se establece en
Error
. - Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
- De manera opcional, especifica OwnerLogin: un nombre de acceso único que pertenece a un usuario o a una organización.
- De manera opcional, especifica Esquema: Usa el esquema para restringir los esquemas recuperados de forma dinámica a un proyecto o esquema de repositorio específico. Para recuperar todos los esquemas, no especifiques ningún valor en este campo. Para obtener información sobre los esquemas compatibles, consulta Esquemas y permisos.
- De manera opcional, configura los parámetros de nodo de conexión:
- Cantidad mínima de nodos: Ingresa la cantidad mínima de nodos de conexión.
- Cantidad máxima de nodos: Ingresa la cantidad máxima de nodos de conexión.
Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se requieren más nodos para procesar más transacciones para una conexión y, del mismo modo, se requieren menos para procesar menos transacciones. Para comprender cómo los nodos afectan el precio del conector, consulta Precios de nodos de conexión. Si no ingresas ningún valor, se establecen de forma predeterminada los nodos mínimos en 2 (para una mejor disponibilidad) y los nodos máximos se establecen en 50.
- De forma opcional, haz clic en + AGREGAR ETIQUETA para agregar una etiqueta a la conexión en forma de un par clave-valor.
- Haga clic en SIGUIENTE.
- En la sección Destinos, ingresa los detalles del host remoto (sistema de backend) al que deseas conectarte.
- Tipo de destino: Selecciona un Tipo de destino.
- Selecciona Dirección de host en la lista para especificar el nombre de host o la dirección IP del destino.
- Si deseas establecer una conexión privada a tus sistemas de backend, selecciona Adjunto de extremo en la lista y, luego, selecciona el archivo adjunto de extremo requerido en la lista Adjunto de extremo.
Si deseas establecer una conexión pública a tus sistemas de backend con seguridad adicional, puedes configurar direcciones IP salientes estáticas para tus conexiones y, luego, configurar tus reglas de firewall para incluir en la lista de entidades permitidas solo las direcciones IP estáticas específicas.
Para ingresar destinos adicionales, haz clic en +AGREGAR DESTINO.
- Haga clic en SIGUIENTE.
- Tipo de destino: Selecciona un Tipo de destino.
-
En la sección Autenticación, ingresa los detalles de autenticación.
Para comprender cómo configurar estos tipos de autenticación, consulta Configura la autenticación.
- Haga clic en SIGUIENTE.
- Revisa: Revisa tus detalles de conexión y autenticación.
- Haz clic en Crear.
Configura la autenticación
Ingresa los detalles según la autenticación que desees usar.
- ID de cliente: el ID de cliente que se usa para solicitar tokens de acceso.
- Permisos: Es una lista de permisos deseados separados por comas.
- Secreto de cliente: Secret de Secret Manager que contiene el secreto del cliente para la app conectada que creaste.
Muestras de configuración de conexión
En esta sección, se enumeran los valores de muestra de los diversos campos que configuras cuando creas la conexión.
OAuth 2.0: Tipo de conexión de código de autorización
Nombre del campo Detalles Ubicación europe-west1 Conector GitHub Versión del conector 1 Nombre de la conexión GitHub-connector Habilita Cloud Logging No Cuenta de servicio Tu_Número_de_Proyecto@serviceaccount OwnerLogin souvikg-Your_Owner_Login Esquema Cantidad mínima de nodos 2 Cantidad máxima de nodos 50 ID de cliente ClientID Permisos repo repo:status repo_deployment Secreto del cliente Secreto del cliente Versión del Secret 1 Esquemas y permisos de GitHub
El conector de GitHub admite los siguientes esquemas:- Esquema de información: Este esquema contiene tablas con información de licencias y resúmenes de alto nivel de los proyectos y repositorios asociados con la cuenta autenticada. Solo existe un esquema de información. Para recuperar el esquema de información, especifica lo siguiente en el campo de esquema: Information
- Esquema del repositorio: El conector admite el esquema de cada repositorio en la cuenta del usuario o la organización autenticada. Usa el siguiente formato para especificar un esquema de repositorio: Repository_
. - Esquema del proyecto: El conector admite esquemas para cada proyecto del usuario autenticado o la cuenta de la organización. Usa el siguiente formato para especificar un esquema de proyecto: Project_
Para obtener más información sobre los permisos, consulta Permisos de GitHub.
Entidades, operaciones y acciones
Todos los Integration Connectors proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se expone como entidades, operaciones y acciones.
- Entidades: Una entidad puede considerarse como un objeto o una colección de propiedades en la aplicación o servicio conectados. La definición de una entidad difiere de conector a conector. Por ejemplo, en un conector de bases de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; en un conector de sistema de mensajería, las colas son las entidades.
Sin embargo, es posible que un conector no admita o tenga ninguna entidad, en cuyo caso la lista
Entities
estará vacía. - Operaciones: Una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:
Cuando se selecciona una entidad de la lista disponible, se genera una lista de operaciones disponibles para esa entidad. Para obtener una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea de conectores. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, estas operaciones no compatibles no se incluyen en la lista
Operations
. - Acción: Una acción es una función de primera clase que está disponible para la integración mediante la interfaz de Conectores. Una acción te permite realizar cambios en una entidad o entidades y variar de un conector a otro. Por lo general, una acción tendrá algunos parámetros de entrada y un parámetro de salida. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista
Actions
estará vacía.
Limitaciones del sistema
El conector de GitHub puede procesar 2 transacciones por segundo, por nodo, y throttles las transacciones supera este límite. De forma predeterminada, Integration Connectors asigna 2 nodos (para una mejor disponibilidad) por una conexión.
Para obtener información sobre los límites aplicables a Integration Connectors, consulta Límites.
Acción
En esta sección, se enumera la acción que admite el conector de GitHub. Para entender cómo configurar el consulta Ejemplos de acciones.
Acción UpdatePullRequestBranch
Esta acción actualiza la rama de la solicitud de extracción.
Parámetros de entrada de la acción UpdatePullRequestBranch
Nombre Tipo Descripción PullRequestId string El ID del nodo de la solicitud de extracción. ExpectedHeadOid string El oid de la referencia principal de la rama upstream. UpdateMethod string El método de rama de actualización que se usará. El valor predeterminado es "MERGE". Los valores permitidos son MERGE y REBASE. Parámetros de salida de la acción AppsDeployStatus
Esta acción devuelve el estado 200 (OK) y actualiza la rama de solicitud de extracción.
Para ver ejemplos sobre cómo configurar la acción
UpdatePullRequestBranch
, consulta Ejemplos.Acción MergePullRequest
Esta acción combina la solicitud de extracción.
Parámetros de entrada de la acción MergePullRequest
Nombre Tipo Descripción PullRequestId string El ID de nodo de la solicitud de extracción que se fusionará. ExpectedHeadOid string OID que debe coincidir con la ref de la solicitud de extracción para permitir la combinación. Si se omite, no se realiza ninguna verificación. CommitHeadline string Título de confirmación para usar en la confirmación de combinación; si se omite, se usa un mensaje predeterminado. CommitBody string Cuerpo de confirmación para usar en la confirmación de combinación; si se omite, se usa un mensaje predeterminado. MergeMethod string El método de combinación que se usará. El valor predeterminado es "MERGE". Los valores permitidos son MERGE, SQUASH y REBASE. AuthorEmail string La dirección de correo electrónico que se asociará con esta combinación. Parámetros de salida de la acción MergePullRequest
Esta acción devuelve el estado 200 (OK) y combina la solicitud de extracción.
Para ver ejemplos sobre cómo configurar la acción
MergePullRequest
, consulta Ejemplos.Ejemplos de acciones
En esta sección, se describe cómo realizar algunas de las acciones en este conector.
Ejemplo: UpdatePullRequestBranch
En este ejemplo, se recuperan los estados de implementación de la aplicación.
- En el cuadro de diálogo
Configure connector task
, haz clic enAction
. - Selecciona la acción
UpdatePullRequestBranch
y haz clic en Listo. - En la sección Task Input de la tarea Connectors, haz clic en
connectorInputPayload
y, luego, ingresa un valor similar al siguiente en el CampoDefault Value
:{ "PullRequestId": "PR_kwDOLywhW8537gcA" }
Si la acción tiene éxito, el Respuesta
connectorOutputPayload
de la tareaUpdatePullRequestBranch
tendrá un valor similar al siguiente:{ "pullrequestid": "PR_kwDOLywhW8537gcA" }
Ejemplo: MergePullRequest
En este ejemplo, se combina una solicitud de extracción.
- En el cuadro de diálogo
Configure connector task
, haz clic enAction
. - Selecciona la acción
MergePullRequest
y haz clic en Listo. - En la sección Task Input de la tarea Connectors, haz clic en
connectorInputPayload
y, luego, ingresa un valor similar al siguiente en el CampoDefault Value
:{ "PullRequestId": "PR_kwDOLywhW8537gcA", "CommitHeadline": "Google MERGE", "CommitBody": "This is Google Merge" }
Si la acción se realiza correctamente, el parámetro de respuesta
connectorOutputPayload
de la tareaMergePullRequest
tendrá un valor similar al siguiente:{ "pullrequestid": "PR_kwDOLywhW8537gcA" }
Ejemplos de operaciones de entidades
En esta sección, se muestra cómo realizar algunas de las operaciones de entidad en este conector.
Ejemplo: operación LIST para la entidad "Branches"
- En el cuadro de diálogo
Configure connector task
, haz clic enEntities
. - Selecciona Branches en la lista
Entity
. - Selecciona la operación
LIST
y haz clic en Listo. - Entrada de tarea de la tarea Conectores, puedes configurar filterClause según los requisitos del cliente. Consulta la sección de notas a continuación
En este ejemplo, branches es el nombre de la entidad y el valor de la cláusula de filtro siempre debe pasarse entre comillas simples ('), como City='Pune'. Ciudad es el nombre de la columna y Pune es el valor
Puedes usar la cláusula de filtro para filtrar cierto conjunto de registros según las columnas. Si hay 20 registros con el nombre = demo16975280986860, puedes filtrar los registros con la columna Address='Miami'. y region='us-east1'.
Puedes realizar operaciones LIST en las siguientes entidades:
Commits,CommitComments, Forks, IssueComments, Issue, IssueAssignees, AssignableUser,Labels, Milestones, PullRequestReviews, PullRequests, PullRequestComments, ReleaseAssets, Releases, Watcher, Users, Repositories, Collaborators, OrganizationTeams, OrganizationsMannequins, OrganizationMember, Organization, Licenses, LicensePermission, LicenseLimitation, LicenseConditions, Projects y PullRequestReviewRequests.
Ejemplo: Operación GET para la entidad "Sucursales"
- En el cuadro de diálogo
Configure connector task
, haz clic enEntities
. - Selecciona Branches en la lista
Entity
. - Selecciona la operación
GET
y haz clic en Listo. - Establece el ID de entidad en 4, que es la clave que se pasará. Para establecer el ID de la entidad, en
la sección Task Input de la tarea Connectors, haz clic en EntityId y
Luego, ingresa
4
en el campo Valor predeterminado.
En este ejemplo, las ramas son el nombre de la entidad y el valor del ID de la entidad se debe pasar directamente, como 4. Si pasar un ID de entidad único arroja un error debido a dos claves compuestas, debes usar la cláusula de filtro con las columnas requeridas.
Ejemplo: Operación GET para la entidad "Repositorios"
- En el cuadro de diálogo
Configure connector task
, haz clic enEntities
. - Selecciona Repositorios en la lista
Entity
. - Selecciona la operación
GET
y haz clic en Listo. - Establece el ID de la entidad en 4, que es la clave que se pasará. Para establecer el ID de la entidad, en
la sección Task Input de la tarea Connectors, haz clic en EntityId y
Luego, ingresa
4
en el campo Valor predeterminado.
En este ejemplo, repositorios es el nombre de la entidad y el valor del ID de la entidad se debe pasar directamente, como 4. Si pasar un ID de entidad único arroja un error debido a dos claves compuestas, debes usar la cláusula de filtro con las columnas requeridas.
Puedes realizar operaciones GET en las siguientes entidades:
CommitComments, Commits, IssueAssignees, Labels, Milestones, PullRequestReviews, PullRequests, PullRequestComments, ReleaseAssets, Release, Topics, Users, Collaborators, Organizations y Licenses.
Ejemplo: operación CREATE para la entidad “Problemas”
- En el cuadro de diálogo
Configure connector task
, haz clic enEntities
. - Selecciona Problemas de la lista
Entity
. - Selecciona la operación
Create
y haz clic en Listo. - En la sección Task Input de la tarea Connectors, haz clic en
connectorInputPayload
y, luego, ingresa un valor similar al siguiente en el CampoDefault Value
:{ "Title": "Google_Cloud_GitHub_Issues_Create", "Body": "Please check hence raising the Feature Request for the same." }
Cuando se ejecuta este ejemplo, se muestra una respuesta similar a la siguiente en la variable de salida
connectorOutputPayload
de la tarea del conector:{ "Id": "I_kwDOLywhW86Sd-xF" }
Ejemplo: Operación CREATE para la entidad "PullRequests"
- En el cuadro de diálogo
Configure connector task
, haz clic enEntities
. - Selecciona PullRequests en la lista
Entity
. - Selecciona la operación
Create
y haz clic en Listo. - En la sección Task Input de la tarea Connectors, haz clic en
connectorInputPayload
y, luego, ingresa un valor similar al siguiente en el CampoDefault Value
:{ "BaseRefName": "main", "HeadRefName": "New_Branch", "Title": "DEMO_Google_Cloud_PULLRequest", "Body": "This is demo Google_Cloud pull" }
Cuando se ejecuta este ejemplo, se muestra una respuesta similar a la siguiente en la variable de salida
connectorOutputPayload
de la tarea del conector:{ "Id": "PR_kwDOLywhW8537gcA" }
Ejemplo: operación CREATE para la entidad “Repositories”
- En el cuadro de diálogo
Configure connector task
, haz clic enEntities
. - Selecciona Repositorios de la lista
Entity
. - Selecciona la operación
Create
y haz clic en Listo. - En la sección Task Input de la tarea Connectors, haz clic en
connectorInputPayload
y, luego, ingresa un valor similar al siguiente en el CampoDefault Value
:{ "Name": "Google_Cloud_DEMO_REPO", "OwnerId": "O_kgDOCaxLsg", "Visibility": "PUBLIC" }
Cuando se ejecuta este ejemplo, se muestra una respuesta similar a la siguiente en la variable de salida
connectorOutputPayload
de la tarea del conector:{ "Id": "R_kgDOMhWBEQ" }
Ejemplo: Operación UPDATE para la entidad “Problemas”
- En el cuadro de diálogo
Configure connector task
, haz clic enEntities
. - Selecciona Problemas de la lista
Entity
. - Selecciona la operación
UPDATE
y haz clic en Listo. - En la sección Task Input de la tarea Connectors, haz clic en
connectorInputPayload
y, luego, ingresa un valor similar al siguiente en el CampoDefault Value
:{ "Title": "New_Updated_Google_Cloud_Issue", "Body": "Newly Updated from Google_Cloud" }
- Establece el valor de entityId en I_kwDOLywhW86Sd-xF. Para establecer el valor de filterClause,
Haz clic en entityId y, luego, ingresa
I_kwDOLywhW86Sd-xF
en el Valor predeterminado .Cuando se ejecuta este ejemplo, se muestra una respuesta similar a la siguiente en la variable de salida
connectorOutputPayload
de la tarea del conector:{ "Id": "I_kwDOLywhW86Sd-xF" }
Ejemplo: Operación UPDATE para la entidad "PullRequests"
- En el cuadro de diálogo
Configure connector task
, haz clic enEntities
. - Selecciona PullRequests en la lista
Entity
. - Selecciona la operación
UPDATE
y haz clic en Listo. - En la sección Task Input de la tarea Connectors, haz clic en
connectorInputPayload
y, luego, ingresa un valor similar al siguiente en el CampoDefault Value
:{ "Title": "Updated_Google_Cloud_PULL", "Body": "Update New pull Body" }
- Establece el valor de entityId como PR_kwDOLywhW8537gcA. Para establecer el valor de filterClause,
Haz clic en entityId y, luego, ingresa
PR_kwDOLywhW8537gcA
en el Valor predeterminado .Cuando se ejecuta este ejemplo, se muestra una respuesta similar a la siguiente en el conector variable de salida
connectorOutputPayload
de la tarea:{ "Id": "PR_kwDOLywhW8537gcA" }
Ejemplo: operación UPDATE para la entidad “Repositories”
- En el cuadro de diálogo
Configure connector task
, haz clic enEntities
. - Selecciona Repositorios en la lista
Entity
. - Selecciona la operación
UPDATE
y haz clic en Listo. - En la sección Task Input de la tarea Connectors, haz clic en
connectorInputPayload
y, luego, ingresa un valor similar al siguiente en el campoDefault Value
:{ "Name": "Updated_New_Google_Cloud_Repo" }
- Establece el valor de entityId en R_kgDOMhWBEQ. Para establecer el valor de filterClause,
Haz clic en entityId y, luego, ingresa
R_kgDOMhWBEQ
en el Valor predeterminado .Cuando se ejecuta este ejemplo, se muestra una respuesta similar a la siguiente en el conector variable de salida
connectorOutputPayload
de la tarea:{ "Id": "R_kgDOMhWBEQ" }
Ejemplo: Operación DELETE para la entidad "PullRequestReviewRequests"
- En el cuadro de diálogo
Configure connector task
, haz clic enEntities
. - Selecciona PullRequestReviewRequests en la lista
Entity
. - Selecciona la operación
DELETE
y, luego, haz clic en Listo. - Establece el valor de filterClause,
Haz clic en filterClause y, luego, ingresa
PullRequestId= 'PR_kwDOLywhW85yNWPa' and RequestedReviewerUserId= 'U_kgDOCebPLA'
en el Valor predeterminado. .
- Para comprender cómo crear y usar la tarea Conectores en la integración de Apigee, consulta Tarea Conectores.
- Para comprender cómo crear y usar la tarea Conectores en Application Integration, consulta la Tarea Conectores.
- Obtén información sobre cómo suspender y reanudar una conexión.
- Aprende a supervisar el uso del conector.
- Aprende a ver los registros del conector.
Usa la conexión de GitHub en una integración
Después de que crees la conexión, estará disponible en Apigee Integration y Application Integration. Puedes usar la conexión en una integración a través de la tarea Connectors.