Nota:
Esta característica está en versión preliminar pública y está sujeta a cambios.
Las GitHub API REST y GraphQL exponen solicitudes de incorporación de cambios 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 la pila de una solicitud de incorporación de cambios o para crear su propia automatización e integraciones para las solicitudes de incorporación de cambios apiladas.
REST API
La API REST expone solicitudes de incorporación de cambios apiladas de dos maneras:
- Objeto
stacken recursos de solicitud de incorporación de cambios. Cuando una solicitud de incorporación de cambios pertenece a una pila, su recurso REST incluye unstackobjeto . Esto le permite leer la pertenencia a la pila de la solicitud de incorporación de cambios, incluido el número y el tamaño de la pila y la posición y la base de la solicitud de incorporación de cambios, directamente desde la solicitud de incorporación de cambios. - Api stacks. Un conjunto dedicado de puntos de conexión para enumerar, leer, crear, extender y disolver pilas. Esta es la superficie 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 a través de la API y quiere usar solicitudes de incorporación de cambios apiladas, debe usar la nueva API de combinación asincrónica.
Merge API
Al combinar una solicitud de incorporación de cambios 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 conexión de combinación sincrónicos heredados ni las mutaciones. Al combinar una solicitud de incorporación de cambios apilada, todas las solicitudes de incorporación de cambios de la pila se combinan o se ponen en cola para combinarlas en la rama base. La combinación de una pila de solicitudes de incorporación de cambios puede implicar varias solicitudes de incorporación de cambios que pueden tardar unos minutos en combinarse. Por este motivo, la combinación se ejecuta en segundo plano al enviar una solicitud de combinación y, a continuación, puede sondear el resultado.
Solo se comprueba el estado básico de la solicitud de incorporación de cambios al enviar una solicitud de incorporación de cambios abierta. Las reglas de repositorio y protección de rama se evalúan más adelante, cuando la combinación se ejecuta realmente y se notifica un error de regla como resultado de error al sondear. Una solicitud de combinación de pila es atómica, lo que significa que todo el grupo de combinaciones de solicitudes de incorporación de cambios o se agrega a la cola de mezcla o ninguno de él.
Para obtener más información, consulte Puntos de conexión de la API REST para solicitudes de incorporación de cambios.
GraphQL API
GraphQL API expone la pertenencia a la pila de una solicitud de incorporación de cambios a través de campos y stack de solo stackEntry lectura en el PullRequest tipo. Use estos campos para consultar la pila a la que pertenece una solicitud de incorporación de cambios y su posición dentro de ella.
GraphQL API es de solo lectura para pilas; no hay mutaciones de pila. Para crear o modificar pilas, 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 primaria 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.