Configuración de GitHub como repositorio de origen en cadenas de herramientas

Continuous Delivery Se dejará de ofrecer en las siguientes regiones el 12 de febrero de 2027: au-syd, ca-tor, us-east. Code Risk Analyzer también dejará de estar disponible en todas las regiones a partir de esa fecha. Si en una región no se hace uso activo de estas funciones, es posible que dichas funciones se dejen de ofrecer antes de lo previsto en esa región y dejen de aceptar nuevas instancias. Más información

Configura GitHub en tu cadena de herramientas de IBM Cloud para gestionar el código fuente, colaborar mediante solicitudes de incorporación de cambios y activar la ejecución de los procesos de integración cuando se produzcan cambios en el código.

GitHub Enterprise es un servicio de alojamiento basado en web para repositorios Git.

GitHub Issues es una herramienta de seguimiento que mantiene todo su trabajo y sus planificaciones en un mismo lugar. Está integrado con el repositorio de desarrollo de modo que pueda centrarse en las tareas importantes.

Puede configurar GitHub como una integración de herramientas de la cadena de herramientas para que pueda gestionar el código fuente en un repositorio nuevo o existente en GitHub.com o en la instancia de GitHub Enterprise de su empresa. Entre en la codificación social a través de wikis, seguimiento de problemas y solicitudes de extracción.

Si configura la integración de esta herramienta mientras crea la cadena de herramientas, siga estos pasos:

  1. Si está almacenando el código fuente en un repositorio GitHub, en la sección Integraciones configurables, pulse GitHub. Si estás configurando la integración de esta herramienta en IBM Cloud Public, debes autorizar a IBM Cloud a acceder a GitHub seleccionando OAuth, Token de acceso personal o Aplicación de GitHub.

    • Si elige OAuth, haga clic en Autorizar para ir al sitio web GitHub. Si no tiene ninguna sesión de GitHub activa, se le solicitará que inicie sesión. Pulse Autorizar aplicación para permitir que IBM Cloud acceda a su cuenta de GitHub. Si tiene una sesión de GitHub activa pero no ha especificado la contraseña recientemente, es posible que se le solicite que especifique su contraseña de GitHub para confirmar.

    • Si elige Señal de acceso personal, debe especificar la señal de acceso personal que se utilizará para autorizar con GitHub la clonación de repositorios y realizar otras acciones en su nombre. Si no tiene una señal de acceso personal, puede seguir la documentación del sitio web de GitHub para crear una. Asegúrese de que la señal de acceso personal tenga los derechos repo, delete_repo, read:user y workflow.

    • Si eliges la aplicación de GitHub, IBM Cloud utiliza una instalación de la aplicación de GitHub para autenticarse en GitHub en tu nombre, en lugar de un token de OAuth. Las aplicaciones de GitHub ofrecen un control de permisos más detallado y no dependen de las credenciales de cada usuario. Elija uno de esto métodos:

      • Gestionado: utiliza la aplicación de IBM para GitHub que IBM proporciona y que está preconfigurada para tu servidor de GitHub. Haz clic en Autorizar para que se te redirija a GitHub, donde deberás autorizar el acceso de la aplicación a tu cuenta.

      • Personalizado: utiliza tu propia aplicación de GitHub. Introduce el App ID y la clave privada (formato PEM ) de una aplicación de GitHub que hayas registrado e instalado en tus repositorios. La aplicación debe instalarse en cualquier repositorio que desees utilizar con esta integración. Para obtener más información sobre cómo crear una aplicación de GitHub, consulta la documentación de GitHub.

  2. Si utilizas un repositorio en tu propio servidor GitHub Enterprise, en la sección Integraciones configurables, haz clic en Servidor personalizado.

    a. Escriba un título para su servidor GitHub personalizado, especifique la raíz URL del servidor e introduzca su token de acceso personal.

    b. Si no tiene una señal de acceso personal, puede seguir la documentación del sitio web de GitHub para crear una.

    c. Si su servidor GitHub está bloqueado o no es accesible desde Internet, puede conectar e integrar un Delivery Pipeline Private Worker para ejecutarlo en su propia infraestructura Kubernetes y acceder a recursos internos o locales. Para obtener más información sobre Delivery Pipeline Trabajadores privados, consulte Trabajar con Delivery Pipeline Trabajadores privados.

    d. Si su servidor GitHub Enterprise tiene una aplicación GitHub registrada, también puede elegir el método de autenticación de la aplicación GitHub y proporcionar su App ID y clave privada, o utilizar la aplicación administrada si hay una preconfigurada para su servidor.

  3. Revise las ubicaciones de repositorio de destino predeterminadas para los repositorios GitHub. Dichos repositorios se clonan a partir del repositorio de ejemplo. Si es necesario, cambie el nombre de los repositorios de destino.

Si tiene una cadena de herramientas y le está añadiendo esta integración de herramientas, siga estos pasos:

  1. Desde la IBM Cloud consola, haga clic en el icono del menú hamburguesa > Automatización de plataformas > Cadenas de herramientas. En la página Cadenas de herramientas, pulse la cadena de herramientas para abrir su página Visión general.

  2. Pulse Añadir herramienta.

  3. En la sección Integraciones de herramientas, pulse GitHub.

  4. Pulse el servidor GitHub que desea utilizar.

  5. Si tiene un repositorio GitHub o GitHub Enterprise y desea utilizarlo, para el tipo de repositorio, pulse Existente y escriba el URL.

  6. Si desea utilizar un nuevo repositorio GitHub o GitHub Enterprise, escriba un nombre para el repositorio, escriba el URL para el repositorio que está clonando o bifurcando, y seleccione el tipo de repositorio:

    a. Para crear un repositorio vacío, pulse Nuevo.

    b. Para crear una copia de un repositorio GitHub o GitHub Enterprise, pulse Clonar.

    c. Para bifurcar un repositorio GitHub o GitHub Enterprise de modo que pueda aportar cambios a través de solicitudes de extracción, pulse Bifurcar.

  7. Si es un usuario de GitHub.com con una cuenta actualizada, o si ha seleccionado un servidor de GitHub Enterprise y desea crear un nuevo repositorio privado en el servidor, marque el recuadro de selección Convertir este repositorio en privado.

  8. Si desea utilizar GitHub Issues para realizar un seguimiento de los problemas, marque el recuadro de selección Habilitar GitHub Issues.

  9. Si desea realizar un seguimiento del despliegue de cambios en el código mediante la creación de etiquetas y comentarios en las confirmaciones, y etiquetas y comentarios en los problemas a los que hacen referencia las confirmaciones, marque el recuadro de selección Hacer un seguimiento del despliegue cambios de código.

  10. Pulse Crear integración.

  11. En la página Visión general de la cadena de herramientas, en la tarjeta Repositorios, pulse el repositorio de GitHub o GitHub Enterprise con el que desee trabajar. En función del repositorio seleccionado, se abrirá el sitio web de GitHub o el repositorio de GitHub Enterprise de su empresa, donde puede ver el contenido del repositorio.

  12. Si ha habilitado GitHub Issues, pulse GitHub Issues para abrirlo. Puede utilizar esta instancia de GitHub Issues para toda la cadena de herramientas, aunque la cadena de herramientas contenga varios repositorios GitHub o GitHub Enterprise.

    Si no tiene privilegios de administrador sobre el repositorio con el que va a enlazar, la integración se verá limitada porque no podrá utilizar un webhook. Los webhooks se necesitan para ejecutar automáticamente un conducto cuando se envía una confirmación al repositorio. Sin un webhook, debe iniciar los conductos manualmente.

Configuración de GitHub mediante la API

La integración de GitHub herramientas admite los siguientes parámetros de configuración que puede utilizar con la API y los HTTP SDK de Toolchain al crear, leer y actualizar integraciones de herramientas.

Debe especificar la propiedad tool_type_id en el cuerpo de la solicitud con el valor githubconsolidated.

Parámetros de integración de la herramientaGitHub
Parámetro Uso Tipo Argumento de Terraform Descripción
url_raíz_api opcional, actualizable Serie url_raíz_api La raíz URL de la API para el GitHub servidor.
señal_api opcional, actualizable Contraseña señal_api El token de acceso personal (PAT). Este parámetro sólo es necesario si auth_type se establece en pat, de lo contrario se ignora.
auth_type opcional, actualizable Serie auth_type Configura el método de autenticación que se utilizará para acceder al proveedor de Git. Los valores válidos son oauth, pat, y github_app. Cuando github_app se especifica, la autenticación utiliza un token de instalación de la aplicación de GitHub en lugar de un token OAuth de usuario o un PAT.
inicio_automático opcional, inmutable, Default: false Boolean inicio_automático Establezca este valor en true para inicializar este repositorio con un archivo léame. Este parámetro sólo se utiliza al crear un repositorio.
conexión_ciega opcional, actualizable, Default: false Boolean conexión_ciega Si se establece este valor en true significa que el servidor no es direccionable en la Internet pública. IBM Cloud no puede validar los detalles de conexión que proporcione. Determinadas funciones que requieren acceso de API al servidor git se inhabilitarán. El conducto de entrega sólo funcionará utilizando un trabajador privado que tenga acceso de red al servidor git.
rama_predeterminada opcional, actualizable Serie rama_predeterminada La rama predeterminada del repositorio Git.
enable_traceability opcional, actualizable, Default: false Boolean enable_traceability Establece este valor en para true realizar un seguimiento de la implementación de los cambios en el código mediante la creación de etiquetas, marcas y comentarios en las confirmaciones, las solicitudes de incorporación de cambios y los incidencias a las que se hace referencia.
id_git opcional, inmutable Serie id_git Establezca este valor en github para github.com, o en el GUID de un servidor GitHub Enterprise personalizado.
github_app_auth_method opcional, actualizable Serie github_app_auth_method El método de autenticación de la aplicación de GitHub que se debe utilizar cuando auth_type es github_app. Selecciona para managed utilizar la aplicación de IBM para GitHub (opción predeterminada), o custom para introducir tus propias credenciales de la aplicación de GitHub a través de github_app_credential_app_id y github_app_credential_private_key.
github_app_credential_app_id opcional, actualizable Serie github_app_credential_app_id El GitHub App ID de una aplicación personalizada de GitHub. Se requiere cuando github_app_auth_method es custom.
github_app_credential_private_key opcional, actualizable Contraseña github_app_credential_private_key La clave privada RSA (formato PEM ) para una aplicación personalizada de GitHub. Se requiere cuando github_app_auth_method es custom. La clave se almacena cifrada.
has_issues opcional, actualizable, Default: true Boolean problemas_de_cadena_de_herramientas_habilitados Establezca este valor en true para habilitar los problemas en el repositorio GitHub y añadir una tarjeta de herramienta Problemas a la cadena de herramientas. Establezca el valor en false para eliminar la tarjeta de integración de herramientas de la cadena de herramientas. Este valor no afecta a si los problemas están habilitados en el propio repositorio GitHub.
propietario_integración opcional, actualizable Serie propietario_integración Seleccione el usuario con el que se realizan las operaciones Git.
owner_id opcional, inmutable Serie owner_id El usuario u organización de GitHub propietario del repositorio. Este parámetro es necesario al crear un repositorio, o clonar o bifurcar un repositorio. Este valor se calcula cuando se enlaza a un repositorio existente.
repositorio privado opcional, inmutable, Default: false Boolean repositorio privado Establezca este valor en true para que el repositorio sea privado al crear un repositorio o clonar o bifurcar un repositorio. Este parámetro no se utiliza cuando se enlaza a un repositorio existente.
id_reposición opcional, inmutable Serie id_reposición El ID del repositorio GitHub.
repo_name opcional, inmutable Serie repo_name El nombre del repositorio GitHub que se va a crear. Este parámetro es necesario al crear un repositorio, o clonar o bifurcar un repositorio. Este valor se calcula cuando se enlaza a un repositorio existente.
repo_url opcional, inmutable Serie repo_url El URL del repo GitHub para la integración de esta herramienta. Este parámetro es necesario cuando se enlaza a un repositorio existente. Este valor se calcula al crear un repositorio, o clonar o bifurcar un repositorio.
url_raíz opcional, actualizable Serie url_raíz La raíz URL del servidor. Por ejemplo: https://github.example.com
url_repo_origen opcional, inmutable Serie url_repo_origen El URL del repositorio que estás bifurcando o clonando. Este parámetro es necesario cuando bifurca o clona un repositorio. No se utiliza al crear un repositorio o enlace a un repositorio existente.
título opcional, actualizable Serie título El título del servidor. por ejemplo, Mi servidor GitHub Enterprise
url_señal opcional, actualizable Serie url_señal El token URL que se utiliza para autorizar con el GitHub servidor.
tipo necesario, inmutable Serie tipo La operación que se debe realizar para inicializar la nueva integración de herramientas. Utilice new para crear un repositorio Git, clone para clonar un repositorio existente en un nuevo repositorio Git, fork para bifurcar un repositorio Git existente o link para enlazar a un repositorio Git existente.

Uso de la autenticación mediante la aplicación de GitHub

La autenticación mediante la aplicación de GitHub es una alternativa a los métodos OAuth y de token de acceso personal (PAT). Las aplicaciones de GitHub se autentican como aplicación en lugar de como usuario, lo que permite establecer permisos de repositorio más detallados, no depende de las credenciales de cuentas de usuario individuales y ofrece tokens que se renuevan automáticamente y cuyo ámbito de aplicación se limita a repositorios específicos.

Hay dos modos disponibles:

Gestionados (github_app_auth_method: managed)
IBM Cloud utiliza una aplicación de GitHub proporcionada por IBM que está prerregistrada para tu servidor de GitHub. La aplicación se autoriza mediante un flujo de consentimiento de OAuth, y el token de usuario a servidor resultante (ghu_) se almacena y se utiliza automáticamente.
Personalizado (github_app_auth_method: custom)
Puedes registrar y gestionar tu propia aplicación de GitHub en GitHub o en GitHub Enterprise. Debes proporcionar el App ID y una clave privada RSA codificada en PEM. IBM Cloud utiliza estas credenciales para generar automáticamente tokens de acceso de instalación de corta duración (ghs_). La aplicación de GitHub debe estar instalada en todos los repositorios que quieras utilizar con esta integración.

Antes de empezar con la autenticación de aplicaciones personalizadas de GitHub

Antes de configurar la autenticación personalizada de la aplicación de GitHub, sigue estos pasos:

  1. Crea una aplicación de GitHub en tu organización de GitHub o en tu cuenta personal. Otorga a la aplicación, como mínimo, los siguientes permisos de repositorio:

    • Contenido: Lectura y escritura
    • Metadatos: Solo lectura
    • Solicitudes de incorporación de cambios: leer y escribir (si utilizas el seguimiento de solicitudes de incorporación de cambios)
    • Flujos de trabajo: lectura y escritura (si tus pipelines activan GitHub Actions)
  2. Genera una clave privada para la aplicación y guarda el archivo PEM. Necesitarás esta clave cuando configures la integración.

  3. Instala la aplicación de GitHub en la organización o en los repositorios a los que accederá tu cadena de herramientas. Es necesario instalar la aplicación antes de poder validar las credenciales.

Una vez que hayas configurado la integración de la herramienta con tu App ID y tu clave privada, IBM Cloud valida las credenciales llamando a la API de GitHub. Si la aplicación aún no está instalada en un repositorio específico, aparecerá un mensaje de error indicándote que primero debes instalar la aplicación.