Revisión y envío de una solicitud de cambios

5 minutos

La solicitud de cambios (PR) es su vale para proporcionar sus conocimientos a la plataforma de Learn. Ha creado una PR, pero aún no se ha enviado a la cola de PR del repositorio de destino. Como ocurre con muchos proyectos de código abierto, se realizan una serie de comprobaciones y revisiones para validar los cambios antes de publicarlos.

Anatomía de una PR

Captura de pantalla de una solicitud de cambios abierta.

Una PR muestra el usuario de GitHub que creó la PR, el repositorio de destino y la rama en la que se creó la PR. Las PR contienen varias pestañas en la parte superior, entre ellas:

Pestaña Conversación: Un panel en el que puede ver y responder a los comentarios de otros colaboradores, ver una lista de notificaciones a lo largo del proceso de creación y revisión, y utilizar la automatización de comentarios para realizar acciones.
Pestaña Compromisos: Un registro de los cambios que se han realizado en esa rama.
Pestaña Archivos modificados: Una comparación de los archivos modificados en la PR con su estado anterior.

Preste mucha atención a la pestaña Conversación, que es donde aparecen las actualizaciones o notificaciones y tienen lugar las discusiones entre usted, los revisores y otros colaboradores. También puede agregar comentarios de hashtag aquí para realizar acciones, como aprobar la PR para indicar que está lista para ser validada y combinada, o detenerla si necesita pausar el proceso.

Las PR suelen llevar etiquetas adjuntas para indicar su estado, como draft para especificar los borradores de la PR que no están listos para su revisión, o do-not-merge para las PR que son nuevas o no han sido revisadas.

Validation

Antes de que la PR pueda combinarse en su rama de destino, es posible que tenga que pasar por uno o más procesos de validación de PR. Después de seleccionar Crear solicitud de cambios, GitHub ejecuta las validaciones configuradas para el repositorio. Cuando finaliza el proceso de validación, los resultados aparecen en la PR.

Los procesos de validación varían según el ámbito de los cambios propuestos y las reglas del repositorio de destino. Después de enviar la PR, puede esperar que se produzca una o varias de las siguientes acciones:

Capacidad de combinación: En primer lugar, se realiza una prueba básica de capacidad de combinación en GitHub para verificar si los cambios propuestos en su rama entran en conflicto con la rama de destino. Si la PR indica que se produjo un error en esta prueba, debe conciliar el contenido que está causando el conflicto de combinación antes de que el procesamiento pueda continuar.
Contrato de licencia de contribución (CLA): Si contribuye a un repositorio público y no es un empleado de Microsoft, en función de la magnitud de los cambios propuestos, es posible que se le pida que complete un CLA breve la primera vez que envíe una solicitud de PR a ese repositorio. Una vez completado el paso de CLA, se procesará la PR.
Etiquetado: Las etiquetas se aplican automáticamente a la solicitud de incorporación de cambios para indicar su estado a medida que pasa a través del flujo de trabajo de validación. Por ejemplo, las nuevas solicitudes de incorporación de cambios pueden recibir automáticamente la etiqueta de do-not-merge, lo que indica que la solicitud de incorporación de cambios aún no ha completado los pasos de validación, revisión y cierre de sesión.
Validación y compilación: comprobaciones automatizadas certifican que los cambios pasan las pruebas de validación. Las pruebas de validación pueden producir advertencias o errores, lo que requiere que realice cambios en uno o varios archivos de la PR antes de que se pueda combinar. Los resultados de las pruebas de validación se agregan como un comentario en la PR para su revisión, y es posible que también se le envíen por correo electrónico.
Ensayo: las páginas del artículo afectadas por los cambios se implementan automáticamente en un entorno de ensayo para revisarlas una vez que se han validado y compilado correctamente. En los comentarios de solicitud de incorporación de cambios, aparecen direcciones URL de vista previa.
Combinación automática: La PR se puede combinar automáticamente si supera las pruebas de validación y determinados criterios. En este caso, no es necesario hacer nada más.

Revisión y aprobación

Casi ha terminado. Una vez finalizado el procesamiento de la PR, es recomendable revisar los resultados (por ejemplo, los comentarios de la PR, las URL de vista previa) para determinar si es necesario realizar más cambios antes de aprobar la combinación. Si un revisor de PR ha revisado su PR, también puede proporcionar información a través de comentarios si hay errores o preguntas pendientes que impidan la combinación.

Use la automatización de comentarios para realizar acciones importantes en la PR. La automatización de comentarios permite a los usuarios asignar la etiqueta adecuada a la PR para actualizar su estado o clasificarla. Si está trabajando en un repositorio en el que se ha implementado la automatización de comentarios, utilice los comentarios de hashtag para asignar o cambiar etiquetas, cerrar una PR o pausar la combinación. Por ejemplo, cuando haya terminado de realizar cambios, escriba el comentario #sign-off para cambiar la etiqueta de solicitud de incorporación de cambios de do-not-merge a ready-for-review.

Use los comentarios de la siguiente tabla para realizar acciones clave en la PR:

Comentario de hashtag	¿Qué hace?
`#sign-off`	Asigna automáticamente la etiqueta `ready-to-merge` para que los revisores del repositorio sepan que la solicitud de incorporación de cambios está lista para la revisión o combinación. Si es no el autor enumerado e intenta cerrar sesión en una solicitud de incorporación de cambios del repositorio público mediante el comentario `#sign-off`, la solicitud de incorporación de cambios se actualiza para indicar que solo el autor puede asignar la etiqueta.
`#hold-off`	Quita la etiqueta `ready-to-merge` en caso de que cambie de opinión o realice un error.
`#please-close`	Cierra la PR si decide no combinar los cambios.
`#please-open`	Vuelve a abrir una PR o un asunto cerrado.

Debe introducir el comentario para combinar los #sign-off cambios. Incluso si se pasan todas las revisiones y comprobaciones de validación, usted es responsable de usar este comentario para decir a los revisores de la PR y a los administradores del repositorio que sus cambios están listos para ser combinados desde su lado. Cuando los revisores determinan que la PR no tiene problemas y la aprueban, los cambios se combinan de nuevo en la rama principal y se cierra la PR.

Captura de pantalla del cuadro de comentarios en una solicitud de cambios con #sign-off escrito en el campo de comentarios y el botón Comentar resaltado.

Publicación

Recuerde que la PR debe ser combinada por un revisor de PR antes de que los cambios puedan incluirse en la siguiente publicación programada. Normalmente, las PR se revisan y combinan por orden de envío.

Una vez que se hayan aprobado y combinado las contribuciones, se seleccionan durante el proceso de publicación. En función del equipo que administre el repositorio al que contribuye, los tiempos de publicación pueden variar, pero normalmente se producen al menos una vez cada día de la semana. Es posible que los artículos tarden hasta 45 minutos en aparecer en línea tras publicarlos.

Una vez publicados, los cambios se publican en Microsoft Learn para que otros puedan aprender de ellos.

Escenario: Publicación de cambios en Azure App Service