Las GitHub API REST y GraphQL exponen pull requests apiladas. La API REST admite la lectura y administración de pilas, mientras que GraphQL API admite consultas de solo lectura.
Use la API para leer la pertenencia a una pila de un pull request o para crear su propia automatización e integraciones para los pull requests apilados.
REST API
La API REST expone pull requests apiladas de dos maneras:
- El objeto
stackde los recursos de solicitud de extracción. Cuando una solicitud de incorporación de cambios pertenece a una pila, su recurso REST incluye unstackobjeto . Esto le permite leer la pertenencia al stack del pull request, incluido el número y el tamaño del stack y la posición y la base del pull request, directamente desde el pull request. - The Stacks API. Un conjunto dedicado de endpoints para listar, leer, crear, extender y eliminar pilas. Esta es la interfaz para crear y modificar pilas.
Para ver los puntos de conexión, los parámetros y los esquemas, consulte Puntos de conexión de la API REST para solicitudes de incorporación de cambios.
Importante
Si combina mediante la API y quiere usar pull requests apiladas, debe usar la nueva API de combinación asincrónica.
Merge API
Al combinar una pull request apilada a través de la API, debe usar el punto de conexión de combinación asincrónico.
No se puede combinar una pila con los puntos de enlace de combinación sincrónicos heredados ni las mutations. Al combinar una solicitud de incorporación de cambios apilada, todas las solicitudes de incorporación de cambios de la pila hasta la que solicitas inclusive se combinan o se ponen en cola para combinarse en la rama base. Fusionar una pila de pull requests puede implicar varias solicitudes de incorporación de cambios, por lo que el proceso puede tardar unos minutos. Por este motivo, la fusión se ejecuta en segundo plano al enviar una solicitud de fusión y, a continuación, puede consultar el resultado.
Solo se comprueba el estado básico de la solicitud de extracción al enviar una solicitud de extracción abierta. Las reglas de repositorio y protección de rama se evalúan más adelante, cuando la fusión se ejecuta realmente, y se notifica un error de regla como un resultado fallido durante el sondeo. Una solicitud de fusión de una pila es atómica, lo que significa que o bien se fusiona todo el grupo de solicitudes de extracción, o bien se añade a la cola de fusión, o no se fusiona nada.
Para obtener más información, consulte Puntos de conexión de la API REST para solicitudes de incorporación de cambios.
GraphQL API
La API de GraphQL expone la pertenencia a la pila de una solicitud de incorporación de cambios a través de campos stack y stackEntry de solo lectura en el tipo PullRequest. Utilice estos campos para consultar la pila a la que pertenece una pull request y su posición dentro de ella.
La API de GraphQL es de solo lectura para stacks; no hay mutaciones de stacks. Para crear o modificar stacks, use la API REST.
Para los campos, objetos y esquemas, consulte Solicitudes de incorporación de cambios.
Webhooks
Cuando una solicitud de incorporación de cambios pertenece a una pila, GitHub agrega una stack propiedad al pull_request objeto en cargas de eventos de webhook. Esto permite a las aplicaciones e integraciones inspeccionar la rama de destino de la pila, no solo la rama padre directa de la solicitud de incorporación de cambios.
El stack objeto se incluye en la carga del pull_request webhook para los eventos del ciclo de vida de la solicitud de incorporación de cambios que se producen mientras que la solicitud de incorporación de cambios forma parte de una pila.
Consulte Eventos y cargas de webhook.