Skip to main content

Comandos de la CLI para pull requests apiladas

Busque todos los comandos, marcas y código de salida de la gh stack extensión en GitHub CLI.

Nota:

Esta característica está en versión preliminar pública y está sujeta a cambios.

La extensión gh stack para GitHub CLI crea y gestiona pilas de pull requests a partir de tu repositorio local. Para obtener una introducción a las pilas, consulte Solicitudes de incorporación de cambios apiladas.

Installation

gh extension install github/gh-stack

La extensión requiere GitHub CLI (gh) versión 2.0 o posterior.

Nota:

La gh stack extensión usa la GitHub CLI autenticación. Si aún no se ha autenticado, ejecute gh auth login.

Resumen de comandos

ComandoPurpose
gh stack initInicialice una nueva pila en el repositorio actual.
gh stack addAgregue una nueva rama en la parte superior de la pila actual.
gh stack viewVer la pila actual.
gh stack checkoutConsulte una pila por número de pila, número de solicitud de incorporación de cambios, dirección URL de solicitud de incorporación de cambios o nombre de rama.
gh stack modifyReestructurar la pila actual de forma interactiva.
gh stack unstackQuite una pila del seguimiento local y desstackla en GitHub.
gh stack submitInserte todas las ramas y, a continuación, cree o actualice las solicitudes de incorporación de cambios y la pila en GitHub.
gh stack syncObtenga, haga rebase, envíe y sincronice el estado de la solicitud de extracción en un solo comando.
gh stack rebaseExtrae del repositorio remoto y ejecuta un rebase en cascada en toda la pila.
gh stack pushInserte las ramas activas de la pila actual en el remoto.
gh stack linkEnlace las solicitudes de extracción en una pila en GitHub sin seguimiento local.
gh stack mergeFusiona una o varias pull requests apiladas de una vez.
gh stack switchCambie interactivamente a otra rama de la pila.
gh stack upSuba hacia la parte superior de la pila, alejándose del tronco.
gh stack downDesplázate hacia la parte inferior de la pila, hacia el tronco.
gh stack topIr a la parte superior de la pila.
gh stack bottomIr al final de la pila.
gh stack trunkSalta a la rama del tronco.
gh stack aliasCree un alias de comando corto para que pueda escribir menos.
gh stack feedbackComparta comentarios sobre la gh stack extensión.

Gestión de la pila

gh stack init

Inicialice una nueva pila en el repositorio actual.

gh stack init [flags] [branches...]

Inicializa una nueva pila localmente. En modo interactivo (sin argumentos), el comando solicita un nombre de rama y ofrece usar la rama actual como primera capa.

Al proporcionar nombres de rama explícitos, las ramas existentes se adoptan automáticamente y se crean las ramas que faltan. El tronco tiene como valor predeterminado la rama predeterminada del repositorio, a menos que la invalide con --base.

El comando habilita git rerere automáticamente, de modo que las resoluciones de conflictos se conserven de un rebase a otro.

FlagDescription
-b, --base <branch>Rama de tronco para la pila (el valor predeterminado es la rama predeterminada del repositorio)

Ejemplos:

# Interactive — prompts for branch names
gh stack init

# Non-interactive — specify first branch upfront
gh stack init feature-auth

# Use a different trunk branch
gh stack init --base develop feature-auth

# Adopt or create multiple branches at once
gh stack init feature-auth feature-api feature-ui

gh stack add

Agregue una nueva rama en la parte superior de la pila actual.

gh stack add [flags] [branch]

En el caso de una pila existente, crea una nueva rama en head actual, la agrega a la parte superior de la pila y la extrae. Debe ejecutar este comando mientras se encuentra en la rama superior de una pila. Si no proporciona un nombre de rama, el comando solicita uno.

Al ejecutar el comando de forma interactiva desde una rama que no forma parte de una pila, add ofrece inicializar una nueva pila en su lugar. El nombre de rama que proporcione o el nombre generado automáticamente se convierte en la primera capa. Si no proporciona un nombre, se usan las indicaciones estándar init .

Opcionalmente, puede almacenar provisionalmente los cambios y crear una confirmación como parte del add flujo. Cuando se proporciona -m sin un nombre de rama explícito, el nombre de la rama se genera automáticamente en formato de fecha y de slug, como 03-24-add_login.

FlagDescription
-A, --allPreparar todos los cambios, incluidos los archivos no rastreados. Se requiere -m.
-u, --updateSolo se realizan cambios de fase en los archivos con seguimiento. Se requiere -m.
-m, --message <string>Cree una confirmación con este mensaje antes de crear la rama.

Nota:

-A y -u son mutuamente excluyentes.

Ejemplos:

# Create a branch by name
gh stack add api-routes

# Prompt for a branch name interactively
gh stack add

# Stage all changes, commit, and auto-generate the branch name
gh stack add -Am "Add login endpoint"

# Stage only tracked files, commit, and auto-generate the branch name
gh stack add -um "Fix auth bug"

# Commit already-staged changes and auto-generate the branch name
gh stack add -m "Add user model"

# Stage all changes, commit, and use an explicit branch name
gh stack add -Am "Add tests" test-layer

# Stage only tracked files, commit, and use an explicit branch name
gh stack add -um "Update docs" docs-layer

gh stack view

Ver la pila actual.

gh stack view [flags]

Muestra todas las ramas de la pila, su ordenación, vínculos de solicitud de incorporación de cambios y la confirmación más reciente con una marca de tiempo relativa. La salida se redirige a través de un paginador, que tiene en cuenta GIT_PAGER o PAGER, y usa less -R de forma predeterminada.

FlagDescription
-s, --shortSalida compacta de una línea por rama
--jsonDatos de pila de salida como JSON

Ejemplos:

gh stack view
gh stack view --short
gh stack view --json

gh stack view --short usa hipervínculos OSC 8 para los números de las solicitudes de extracción cuando el terminal los admite. De lo contrario, se muestra la dirección URL completa para copiar y pegar. Establezca GH_STACK_HYPERLINKS=1 o GH_STACK_HYPERLINKS=0 para invalidar la detección de terminales.

gh stack checkout

Consulte una pila por su número de pila, un número de solicitud de incorporación de cambios, una dirección URL de solicitud de incorporación de cambios o un nombre de rama.

gh stack checkout [<stack-number> | <pr-number> | <pr-url> | <branch>]

Un número por sí solo se interpreta primero como un número de pila o de solicitud de extracción. Se trata de identificadores de ámbito de repositorio que se muestran en la GitHub interfaz de usuario. Si nada coincide con el número, se prueba como nombre de rama.

Al hacer referencia a una pila remota, el comando captura la pila en GitHub, extrae las ramas y configura la pila localmente. Si la pila ya existe localmente y coincide, el comando cambia a la rama. Si los entornos local y remoto tienen una composición distinta, se le pedirá que resuelva el conflicto.

Al proporcionar un nombre de rama, el comando comprueba primero las pilas con seguimiento local. Si la rama no está siendo rastreada localmente, el comando busca la rama en stacks remotos y descarga el stack correspondiente. Si coincide más de una pila, use un número de pila o de solicitud de extracción para seleccionar una de forma explícita.

Cuando ejecutas el comando sin argumentos en un terminal interactivo, primero comprueba si la rama actual pertenece a una pila del remoto de la que no se hace seguimiento local y te ofrece cambiarte a ella. Si no hay una coincidencia única, o rechazas la opción, se abre un selector con búsqueda que muestra todas las pilas que tienes disponibles, tanto las pilas de las que se hace seguimiento local como las pilas que solo existen en GitHub. Cada fila muestra el número del apilado, su rama inferior y su rama superior, la rama base, una barra de estado que resume cuántas de sus solicitudes de extracción están fusionadas, abiertas, cerradas o aún no se han enviado, y si el apilado está disponible localmente o solo en el repositorio remoto. Filtre con las pestañas Todos, Locales y Remotos , o escriba / para buscar. Se omiten las pilas totalmente combinadas. Al seleccionar una stack solo disponible en remoto, se clona en local antes de cambiar a esta.

Ejemplos:

# Check out a stack by its stack number
gh stack checkout 7

# Check out a stack by pull request number
gh stack checkout 42

# Check out a stack by pull request URL
gh stack checkout https://github.com/owner/repo/pull/42

# Check out a stack by branch name
gh stack checkout feature-auth

# Interactive — pick from all available stacks (local and remote)
gh stack checkout

gh stack modify

Reestructure la pila actual de forma interactiva.

gh stack modify [flags]

Abre una interfaz de usuario de terminal interactiva para reestructurar una pila. Todos los cambios se almacenan provisionalmente en la interfaz y se aplican juntos al presionar Ctrl+S. No se pueden modificar las ramas de las solicitudes de incorporación de cambios combinadas.

FlagDescription
--continueContinuar después de resolver conflictos
--abortAnule la sesión de modificación y restaure la pila en su estado antes de ejecutar el comando.

Condiciones previas

El comando comprueba estas condiciones antes de abrir la interfaz:

  1. Debe tener una pila activa extraída localmente.
  2. El árbol de trabajo debe estar limpio, sin cambios no confirmados.
  3. No hay ninguna operación de rebase en curso.
  4. No hay ninguna pull request de la pila en cola para su fusión.
  5. El historial de commits debe ser lineal, sin commits de fusión ni ramas divergentes.

Operations

FuncionamientoKeyEffect
Drop
xQuite la rama y sus confirmaciones de la pila. Se conservan la rama local y la solicitud de incorporación de cambios asociadas.
Pliegue hacia abajo
dAbsorba las confirmaciones de cambios en la rama inferior, hacia la rama principal. La rama plegada se elimina de la pila.
Plegado hacia arriba
uAbsorbe los commits en la rama superior, alejándolos de la rama principal. La rama contraída se elimina de la pila.
Insertar a continuación
iInserte una nueva rama vacía debajo del cursor, hacia el tronco.
Insertar arriba
YoInserte una nueva rama vacía encima del cursor, lejos del tronco.
Bajar
Mayús+Reordene la rama hacia abajo, hacia el tronco.
Subir
Mayús+Reordene la rama hacia arriba, lejos del tronco.
Rename
rCambiar el nombre de la rama mediante una solicitud en línea.
Undo
zDeshacer la última acción preconfigurada.

Fase de aplicación

Al presionar Ctrl+S, los cambios preparados se aplican cambiando el nombre de las ramas, insertando ramas nuevas, plegando o eliminando ramas y ejecutando un rebase en cascada para crear un historial lineal de confirmaciones con el estado de la pila que quieras.

Si se produce un conflicto de rebase, puede:

  • Resuelva los conflictos, almacene provisionalmente los archivos y, a continuación, ejecute gh stack modify --continue.
  • Ejecute gh stack modify --abort para anular la operación y restaurar la pila en su estado anterior.

Después de modificar

Si ya ha creado una pila de solicitudes de incorporación de cambios en GitHub, ejecute gh stack submit para insertar las ramas actualizadas y volver a crear la pila. El stack anterior se reemplaza automáticamente.

Ejemplos:

# Open the interactive modify interface
gh stack modify

# Continue after resolving a conflict
gh stack modify --continue

# Abort and restore to the previous state
gh stack modify --abort

gh stack unstack

Quite una pila del seguimiento local y desstackla en GitHub. Este comando también está disponible como gh stack delete.

gh stack unstack [<stack-number>] [flags]

Sin argumentos, el comando se dirige a la pila activa, que es la pila que contiene la rama actualmente seleccionada. Saca de la pila el elemento de GitHub y elimina el seguimiento local.

Proporcione un número de pila, el identificador que se muestra en la interfaz de usuario de pila en GitHub, para desmontar una pila específica. Esto funciona desde cualquier lugar del repositorio, tanto si la pila se ha extraído localmente como si no, porque la pila se desapila directamente a través de la API GitHub. Cuando la pila también está disponible localmente, se elimina también su seguimiento local.

Las pull requests fusionadas, en proceso de fusión o en cola para fusionarse no se pueden eliminar de una pila en GitHub y siguen formando parte de la pila. Cuando se eliminan todas las solicitudes de extracción, la pila se disuelve y se elimina todo seguimiento local. Cuando algunas solicitudes de incorporación de cambios permanecen apiladas, la pila se mantiene y el seguimiento local, si existe, no se modifica. Use --local para omitir la operación remota y quitar solo el seguimiento local.

Este comando es útil cuando necesita reestructurar una pila quitando una rama, insertando una rama, reordenando ramas, cambiando el nombre de las ramas o realizando otros cambios grandes. Después de desmontar, use gh stack init para volver a crear la pila con la estructura que desee. Las ramas existentes se incorporan automáticamente.

FlagDescription
--localEliminar solo la pila localmente, manteniéndola en GitHub

Ejemplos:

# Unstack the current stack on GitHub and remove local tracking
gh stack unstack

# Unstack a specific stack by its number
gh stack unstack 7

# Only remove local tracking
gh stack unstack --local

Operaciones remotas

gh stack submit

Inserte todas las ramas y, a continuación, cree o actualice las solicitudes de incorporación de cambios y la pila en GitHub.

gh stack submit [flags]

Crea una solicitud de extracción para cada rama del conjunto, enviando las ramas al repositorio remoto. Después de crear solicitudes de incorporación de cambios, submit crea automáticamente una pila en GitHub para vincular las solicitudes de incorporación de cambios. Si la pila ya existe en GitHub, por ejemplo de un envío anterior, las nuevas pull requests se añaden a la pila existente.

Si todas las solicitudes de extracción de la pila ya se han fusionado, esa pila está completa y no se puede extender. En ese caso, submit inicia automáticamente una nueva pila con base en el tronco para tus ramas sin fusionar y la crea en GitHub, dejando intacta la pila ya fusionada.

En un terminal interactivo, submit abre un editor de pantalla completa en una sola pantalla.

  • Panel izquierdo. Todas las ramas sin una pull request se incluyen de forma predeterminada. Deseleccione los que no quiera enviar con Ctrl+X. Dado que cada solicitud de extracción se basa en la rama que tiene debajo, al deseleccionar una rama también se deseleccionan las que están apiladas sobre ella, y al volver a incluir una rama se vuelven a incluir las que están debajo de ella y de las que depende. Las ramas que ya tienen una pull request, ya esté abierta, en borrador, en cola o fusionada, se muestran como referencia, pero están bloqueadas. Edite los de la Web.
  • Panel derecho. Para la rama centrada, redacte el título y la descripción y elija si la solicitud de incorporación de cambios se abre lista para su revisión o como borrador. La descripción se completa automáticamente a partir de la plantilla de pull request o de los commits de tu repositorio, con una vista previa de Markdown y una secuencia de escape $EDITOR. Al seleccionar una rama bloqueada, se muestra una tarjeta de solo lectura con un enlace a su solicitud de extracción. Presione o para abrirlo en el explorador.

Presione Ctrl+S para enviar todas las solicitudes de incorporación de cambios incluidas a la vez. El editor admite la entrada de teclado y mouse. Pase --autoo ejecute el comando en un terminal no interactivo, como CI, para omitir el editor y usar títulos generados automáticamente.

Si las ramas ya tienen solicitudes de incorporación de cambios abiertas, pero no hay ninguna pila en GitHub, puede vincular las solicitudes de incorporación de cambios a una pila con Ctrl+B.

En el editor, las nuevas solicitudes de incorporación de cambios están listas para su revisión. Puede cambiar cualquier solicitud de extracción a borrador con el conmutador. Con --auto, los pull requests se crean en modo borrador, a menos que se pase --open.

FlagDescription
--autoOmitir el editor y usar títulos de solicitud de incorporación de cambios generados automáticamente
--openCree nuevas solicitudes de incorporación de cambios como listas para su revisión en lugar de borradores y marque las solicitudes de incorporación de cambios existentes como listas para su revisión.
--remote <name>Remoto al que hacer push (por defecto, el remoto detectado automáticamente)

Ejemplos:

gh stack submit
gh stack submit --auto
gh stack submit --open

gh stack sync

Obtenga, haga rebase, envíe y sincronice el estado de la solicitud de extracción en un solo comando.

gh stack sync [flags]

Sincroniza toda la pila.

  1. Obtener. Captura los cambios más recientes de origin.
  2. Sincroniza la pila remota. Replica localmente la pila en GitHub. Cuando se han añadido solicitudes de extracción a la pila de GitHub, de modo que el repositorio remoto vaya por delante de tu pila local, sus ramas se descargan y se añaden automáticamente a tu pila local. Cuando las pilas local y remota han divergido realmente, por ejemplo, porque has añadido una rama localmente mientras se añadían distintos pull requests a la pila de GitHub, se te pedirá que resuelvas la diferencia. Consulte Pilas divergentes. En un terminal no interactivo, una divergencia interrumpe la sincronización y no se envía ni se actualiza nada.
  3. Tronco rápido hacia delante. Avanza rápidamente la rama del tronco para que coincida con el remoto. Este paso se omite si las ramas se han divergido.
  4. Rebase en cascada. Reasenta todas las ramas apiladas sobre sus ramas padre actualizadas, pero solo si trunk se ha movido. Si se detecta un conflicto, todas las ramas se restauran a su estado original y se recomienda ejecutar gh stack rebase para resolver los conflictos de forma interactiva.
  5. Presionar. Envía todas las ramas usando --force-with-lease si se realizó un rebase.
  6. Sincronizar solicitudes de incorporación de cambios. Sincroniza el estado de la solicitud de incorporación de cambios de GitHub e informa del estado de cada solicitud de incorporación de cambios.
  7. Sincroniza la pila. Vincula los pull requests abiertos de la pila en una pila en GitHub, creando el objeto remoto de la pila si aún no existe, o actualizándolo si solo está creado parcialmente. Esto solo sucede cuando existen dos o más solicitudes de incorporación de cambios. La sincronización nunca abre solicitudes de incorporación de cambios. Úselo gh stack submit para eso.
  8. Prune. En terminales interactivos, se solicita eliminar las ramas locales de las solicitudes de extracción fusionadas. Usa --prune para depurar automáticamente.

Una actualización remota limpia en la que las solicitudes de extracción se añaden sobre la pila local se descarga automáticamente sin pedir confirmación, por lo que sync se puede ejecutar de forma segura en automatizaciones. La sincronización solo solicita cuándo las pilas se han divergido realmente.

Pilas divergidas

Cuando ninguna pila es un prefijo exacto de la otra, por ejemplo, porque has añadido una rama localmente al mismo tiempo que se han añadido solicitudes de extracción independientes a la misma pila en GitHub, la sincronización no puede fusionarlas automáticamente. En un terminal interactivo, ofrece tres opciones.

  • Use la pila remota como origen de la verdad. Reemplaza la composición de la pila local por el control remoto y extrae las ramas que faltan. Si estaba en una rama que ya no está en la pila remota, se le moverá a la rama superviviente más cercana. Esto requiere un estado de trabajo limpio sin cambios no confirmados.
  • Elimine la pila en GitHub. Elimina la pila en GitHub y detiene la sincronización. Los pull requests y las ramas locales no se ven afectados, y solo se elimina la pila en GitHub. Vuelva a crear la pila con gh stack submit, ejecutando gh stack modify primero si desea cambiar su estructura. Esta es la forma de hacer que GitHub coincida con tu pila local, porque submit, a diferencia de sync, también crea solicitudes de incorporación de cambios para las ramas que aún no has enviado.
  • Cancelar. Anula la sincronización sin insertar ramas ni actualizar las solicitudes de incorporación de cambios.

En un terminal no interactivo, una divergencia anula la sincronización, saliendo correctamente, sin insertar ramas ni actualizar solicitudes de incorporación de cambios. Resuélvelo desapilando y recreando la pila.

FlagDescription
--remote <name>Repositorio remoto desde el que obtener y al que enviar (por defecto, el remoto detectado automáticamente)
--pruneEliminar ramas locales de las solicitudes de extracción fusionadas

Ejemplos:

gh stack sync

# Sync and automatically prune merged branches
gh stack sync --prune

gh stack rebase

Extrae del repositorio remoto y ejecuta un rebase en cascada en toda la pila.

gh stack rebase [flags] [branch]

Captura los cambios más recientes de originy garantiza que cada rama de la pila tenga la punta de la capa anterior en su historial de confirmaciones. Las ramas se reorganizan mediante rebase en orden, de abajo arriba, a partir de la rama principal.

Si se ha combinado la solicitud de incorporación de cambios de una rama, la base cambia automáticamente al --onto modo para reproducir correctamente las confirmaciones en la parte superior del destino de combinación.

Si se produce un conflicto de rebase, la operación pausa e imprime los archivos en conflicto con números de línea. Resuelva los conflictos, preconfigurarlos con git addy, a continuación, continúe con --continue. Para deshacer completamente el rebase, usa --abort para restaurar todas las ramas al estado en que se encontraban antes del rebase.

FlagDescription
--downstackSolo rebase las ramas del tronco a la rama actual
--upstackHacer rebase solo de las ramas desde la rama actual hasta la parte superior
--no-trunkOmita el tronco. Solo se bifurca la pila de rebase entre sí, sin captura ni base de tronco.
--continueContinuar con el rebase después de resolver los conflictos
--abortAnule la base de datos y restaure todas las ramas en su estado antes de la rebase.
--remote <name>Repositorio remoto desde el que obtener (por defecto, el repositorio remoto detectado automáticamente)
--committer-date-is-author-dateEstablezca la fecha del confirmador como la fecha del autor durante el rebase. Alias: --preserve-dates.
ArgumentoDescription
[branch]Rama de destino (por defecto es la rama actual)

Ejemplos:

# Rebase the entire stack
gh stack rebase

# Only rebase branches below the current one
gh stack rebase --downstack

# Only rebase branches above the current one
gh stack rebase --upstack

# Rebase stack branches without pulling from or rebasing with trunk
gh stack rebase --no-trunk

# After resolving a conflict
gh stack rebase --continue

# Abort rebase and restore everything
gh stack rebase --abort

# Rebase and preserve committer date as author date
gh stack rebase --committer-date-is-author-date

gh stack push

Inserte las ramas activas de la pila actual en el remoto.

gh stack push [flags]

Envía cada rama activa, excepto las ramas fusionadas y en cola, en un solo git push, utilizando una comprobación --force-with-lease explícita por rama. La actualización no es atómica. Las ramas cuyos arrendamientos sigan siendo válidos se pueden actualizar aunque se rechace otra rama. Corrija la rama rechazada y vuelva a ejecutar el comando. Las ramas que ya se actualizaron permanecen sin cambios. Este comando no crea ni actualiza pull requests. Úselo gh stack submit para eso.

FlagDescription
--remote <name>Remoto al que hacer push (por defecto, el remoto detectado automáticamente)

Ejemplos:

gh stack push
gh stack push --remote upstream

Enlace las solicitudes de extracción en una pila en GitHub sin seguimiento local.

gh stack link [flags] <stack-number | branch-or-pr> <branch-or-pr> [...]

Crea o actualiza una pila en GitHub a partir de nombres de ramas o números y URL de solicitudes de extracción. Este comando no crea ni modifica ningún estado de seguimiento local. Está diseñado para usuarios que gestionan ramas localmente con otras herramientas, como Jujutsu, Sapling o git-town, y quieren abrir una serie de pull requests. Consulte Uso de otras herramientas con solicitudes de incorporación de cambios apiladas.

Proporcione argumentos en orden de pila, de abajo a arriba. Los argumentos de rama se envían automáticamente al repositorio remoto antes de crear o buscar solicitudes de extracción. En el caso de las ramas que ya tienen solicitudes de incorporación de cambios abiertas, se usan esas solicitudes de incorporación de cambios. Para las ramas sin solicitudes de extracción, se crean automáticamente nuevas solicitudes de extracción con el encadenamiento correcto de ramas base. Las solicitudes de extracción existentes cuya rama base no coincide con la cadena esperada se corrigen automáticamente.

Si las solicitudes de incorporación de cambios aún no están en una pila, se crea una nueva pila. Si algunas de las solicitudes de incorporación de cambios ya están en una pila, la pila existente se actualiza para incluir las nuevas solicitudes de incorporación de cambios. Las pull requests existentes nunca se eliminan de la pila, porque la actualización únicamente añade cambios.

Para ampliar una pila existente sin volver a enumerar sus solicitudes de extracción, pase como primer argumento un número de pila, el número que se muestra en la interfaz de usuario de la pila en GitHub. Los argumentos restantes se anexan a la parte superior de esa pila. Los argumentos que ya están en la pila se omiten y se rechazan los argumentos que pertenecen a una pila diferente. Dado que los números de las pilas y de las solicitudes de extracción nunca se superponen, un primer argumento numérico se interpreta como una pila solo cuando coincide con una pila existente. De lo contrario, se trata como una pull request o una rama.

FlagDescription
--base <branch>Rama base en la parte inferior de la pila (por defecto, es la rama predeterminada del repositorio). Esta marca se omite cuando se agrega a una pila existente.
--openMarcar las solicitudes de incorporación de cambios nuevas y existentes como listas para su revisión
--remote <name>Remoto al que hacer push (por defecto, el remoto detectado automáticamente)

Ejemplos:

# Link branches into a stack (pushes, creates pull requests, creates stack)
gh stack link feature-auth feature-api feature-ui

# Link existing pull requests by number
gh stack link 10 20 30

# Link existing pull requests by URL
gh stack link https://github.com/owner/repo/pull/10 https://github.com/owner/repo/pull/20

# Add branches to an existing stack of pull requests
gh stack link 42 43 feature-auth feature-ui

# Append to the top of an existing stack by its stack number, with no need
# to list the pull requests already in stack 7 again
gh stack link 7 48 feature-ui

# Use a different base branch and mark pull requests as ready for review
gh stack link --base develop --open feat-a feat-b feat-c

gh stack merge

Fusiona una o varias pull requests apiladas de una vez.

gh stack merge [<stack-number> | <pr-number>]

Combina todas las solicitudes de extracción de la pila, hasta la solicitud de extracción que elijas incluida, en la rama base. La fusión es una sola operación de todo o nada. Si alguna solicitud de extracción no se puede fusionar, no se fusiona ninguna.

Si no se especifica ningún argumento, el comando usa la pila local activa. Indique un número de stack para fusionar un stack que no tiene en su copia local, lo que constituye una operación completamente remota, o indique un número de pull request para fusionar directamente hasta ese pull request.

En un terminal interactivo, el comando le pide que elija qué solicitudes de extracción fusionar, elija el método de fusión y confirme. En un terminal no interactivo, o cuando usas --yes, se fusiona toda la pila, o todo hasta la solicitud de extracción que especifiques, sin pedir confirmación, utilizando el método de fusión que usaste por última vez, a menos que especifiques uno.

Solo se comprueba el estado básico de la solicitud de incorporación de cambios antes de la combinación. Cada solicitud de incorporación de cambios debe estar abierta y no debe ser un borrador. GitHub evalúa las reglas de protección de ramas y las reglas del repositorio cuando se ejecuta la fusión, y se te notifica cualquier fallo.

Nota:

No se pueden omitir los requisitos de fusión al fusionar pull requests apiladas.

Si la rama base usa una cola de mezcla, la pila se agrega a la cola en lugar de combinarse directamente. La cola elige el método de combinación, por lo que el indicador omite el paso del método de combinación, y las marcas --merge-method, --squash, --rebase y --merge se ignoran con una advertencia. Las solicitudes de incorporación de cambios que seleccione se agregan juntas a la cola, pero se fusionan a medida que la cola las procesa, por lo que pueden fusionarse en grupos distintos en lugar de fusionarse todas a la vez.

FlagDescription
--merge-method <method>Método de combinación que se va a usar: merge, squasho rebase
--merge, , --squash, --rebaseAbreviaturas del método de combinación correspondiente
-y, --yesCombinar sin solicitar confirmación

Ejemplos:

# Merge the current stack, choosing pull requests interactively
gh stack merge

# Merge a stack you do not have checked out, by stack number
gh stack merge 7

# Merge everything up to and including pull request 42
gh stack merge 42

# Merge the whole current stack without prompting, squashing commits
gh stack merge --yes --squash

Los comandos de navegación te permiten moverte entre ramas del stack actual sin tener que recordar los nombres de las ramas. La parte inferior de la pila es la rama más cercana al tronco, y la superior es la rama más alejada de este. up se aleja del tronco y down se mueve hacia él.

Todos los comandos de navegación se limitan a los límites de la pila. Moverse hacia arriba desde la parte superior, o hacia abajo desde la parte inferior, no hace nada y muestra un mensaje.

gh stack switch

Cambie interactivamente a otra rama de la pila.

gh stack switch

Muestra un selector interactivo que muestra todas las ramas de la pila actual, ordenadas desde arriba, más alejadas del tronco, hasta la parte inferior, más cercanas al tronco, con su número de posición. Seleccione una rama para desérsela.

Este comando requiere un terminal interactivo.

Ejemplos:

gh stack switch
#    → Select a branch in the stack to switch to
#      5. frontend
#      4. api-endpoints
#      3. auth-layer
#      2. db-schema
#      1. config-setup

gh stack up

Suba hacia la parte superior de la pila, alejándose del tronco.

gh stack up [n]

Mueve las ramas ascendentes n , de forma predeterminada a 1. Si está en la rama del tronco, up se mueve a la primera rama de pila.

Ejemplos:

# Move up one layer
gh stack up

# Move up three layers
gh stack up 3

gh stack down

Desplázate hacia la parte inferior de la pila, hacia el tronco.

gh stack down [n]

Mueve las ramas hacia abajo n , de forma predeterminada a 1.

Ejemplos:

# Move down one layer
gh stack down

# Move down two layers
gh stack down 2

gh stack top

Ir a la parte superior de la pila.

gh stack top

Echa un vistazo a la rama más alejada del tronco.

gh stack bottom

Ir al final de la pila.

gh stack bottom

Echa un vistazo a la rama más cercana al tronco.

gh stack trunk

Salta a la rama del tronco.

gh stack trunk

Comprueba la rama de tronco de la pila actual, como main. Debe estar en una rama que forme parte de una pila.

Utilities

gh stack alias

Cree un alias de comando corto para que pueda escribir menos.

gh stack alias [flags] [name]

Instala un script contenedor pequeño en ~/.local/bin/ que reenvía todos los argumentos a gh stack. El nombre de alias predeterminado es gs, pero puede elegir cualquier nombre pasándolo como argumento. Después de la instalación, puede ejecutar gs push en lugar de gh stack push.

En Windows, no se admite la creación automática de alias. El comando imprime instrucciones manuales para crear un archivo por lotes o una función de PowerShell.

FlagDescription
--removeEliminación de un alias que creó anteriormente

Ejemplos:

# Create the default alias (gs), so that "gs push" and "gs view" both work
gh stack alias

# Create a custom alias
gh stack alias gst

# Remove an alias
gh stack alias --remove
gh stack alias --remove gst

gh stack feedback

Comparta comentarios sobre la gh stack extensión.

gh stack feedback [title]

Abre una discusión en el repositorio gh-stack para que pueda enviar comentarios. Opcionalmente, puede proporcionar un título para la publicación de discusión.

Ejemplos:

gh stack feedback
gh stack feedback "Support for reordering branches"

Variables de entorno

VariableValoresDescription
GH_STACK_THEME
auto (predeterminado), light, darkControla la paleta de colores de las pantallas interactivas para submit, modify y view, y toda la salida de comandos en color. Los colores se adaptan automáticamente al fondo del terminal. Establezca esta variable para forzar la paleta clara u oscura cuando un terminal no informa del color de fondo, lo que puede ocurrir en algunas configuraciones de SSH o tmux.
GH_STACK_HYPERLINKS
0, 1Deshabilita o habilita hipervínculos de OSC 8 cuando la detección de terminales es incorrecta. Los terminales no admitidos muestran la dirección URL completa de forma predeterminada.
# Force the light palette for one command
GH_STACK_THEME=light gh stack view

Códigos de salida

CodeMeaning
0Success
1Error genérico
2No está en una pila o no se encontró la pila
3Conflicto de rebase
4
GitHub Error de API
5Argumentos o marcas no válidos
6Se requiere la desambiguación, porque la rama pertenece a varias pilas
7Rebase ya está en curso
8La pila está bloqueada por otro proceso
9Las solicitudes de incorporación de cambios apiladas no están habilitadas para este repositorio
10Se interrumpió la sesión de modificación y es necesario recuperarla.

Lectura adicional