Ejercicio: Adición de una regla para requerir una revisión

En esta unidad configurará una regla en GitHub que requiera que un revisor apruebe los cambios antes de que se puedan combinar en la rama main. Como bonificación, también corregirás el error de escritura en la página principal del sitio web de Space Game .

Actualmente, el equipo permite que cualquiera que realice una solicitud de incorporación de cambios combine el código en la rama main. Dado que no se requiere ninguna revisión, es posible que el código incorrecto o inestable encuentre su camino.

Andy decide que quiere agregar una comprobación a la solicitud de incorporación de cambios en forma de otro par de ojos. Quiere configurar GitHub para solicitar a alguien que no es el autor de la solicitud de incorporación de cambios revise el código antes de que se combine. Veamos cómo hacerlo.

Andy va en busca de Mara y la encuentra trabajando en su mesa, moviendo la cabeza al ritmo de la música de sus auriculares.

Andy: Mara, he estado queriendo hablar contigo sobre algo.

Mara le mira.

Mara: ¿Con qué puedo ayudarte?

Andy: Varios errores menores se han filtrado en la compilación. Justo hoy ha aparecido un error tipográfico en la página principal. Amita tiene que dedicarle demasiado tiempo a estas cosas. Necesitamos detenerlos antes de que lleguen a la rama main. Necesitamos otro par de ojos en el código antes de que se apruebe la solicitud de incorporación de cambios.

Mara: Puedo configurar eso. En GitHub, hay una manera de asegurarse de que no se combine ninguna solicitud de incorporación de cambios antes de que alguien la revise y la apruebe.

Configuración de aprobaciones

En esta sección configurará una regla en GitHub que requiere al menos un revisor para aprobar una solicitud de incorporación de cambios antes de que se pueda combinar en la rama main. A continuación, comprobará que la regla funciona insertando una corrección del error tipográfico que Mara ha cometido antes.

Adición de la regla

1. En GitHub, vaya al repositorio del proyecto Space Game .
2. Seleccione la pestaña Configuración cerca de la parte superior de la página.
3. En el menú de la izquierda, seleccione Sucursales.
4. Asegúrese de que main está seleccionado como la rama predeterminada.
5. Seleccione Agregar regla de protección de rama clásica.
6. En Patrón de nombre de rama, escriba principal.
7. Active la casilla Requerir una solicitud de cambios antes de combinar.
8. Active la casilla Requerir aprobaciones .
9. Mantenga el valor de revisiones de aprobación requeridas en 1.
10. Seleccione Crear.
11. Seleccione Guardar cambios.

Envío de la corrección

En esta sección enviará una corrección para el error tipográfico de la página principal. Recuerde que la palabra "official" está mal escrita: "oficial".

1. En Visual Studio Code, vaya al terminal.

2. Para cambiar a la rama main, ejecute git checkout:

   git checkout main
   

3. Para incorporar los cambios más recientes a la rama main desde GitHub, ejecute git pull:

   git pull origin main
   

   Verá que se actualizan dos archivos:

   • README.md: contiene el código markdown para mostrar la notificación de compilación.
   • Index.cshtml: contiene el texto de la página principal actualizada, que incluye el error de escritura.

4. Para corregir el error, cree y cambie a una rama:

   git checkout -B bugfix/home-page-typo
   

5. En el Explorador de archivos, abra Index.cshtml.

6. Busque el error:

   <p>Welcome to the oficial Space Game site!</p>
   

7. Cambie la línea para corregir el error:

   <p>Welcome to the official Space Game site!</p>
   

8. Guarde el archivo.

9. En el terminal, almacene de forma provisional el cambio y confírmelo:

   git status
   git add Tailspin.SpaceGame.Web/Views/Home/Index.cshtml
   git commit -m "Fix typing error on the home page"
   

   En la práctica, normalmente podría compilar y ejecutar el sitio de forma local para comprobar el cambio. En esta unidad, por razones de brevedad, vamos a omitir ese paso.

10. Inserte la rama en GitHub.

    git push origin bugfix/home-page-typo
    

Prueba de la regla

1. En GitHub, busque y seleccione la rama bugfix/home-page-typo.

   

2. Para iniciar la solicitud de incorporación de cambios, seleccione Contribuir y, después, Abrir solicitud de incorporación de cambios.

3. Establezca el repositorio bifurcado como el repositorio base.

   

4. Seleccione Crear solicitud de incorporación de cambios.

   Verá que se requiere una revisión humana para poder combinar el cambio.

   

   En la práctica, podría asignar un miembro del equipo para revisar el cambio. En esta unidad, puede combinar su propia solicitud de cambios con fines de aprendizaje.

5. Active la casilla Combinar sin esperar a que se cumplan los requisitos (omitir protecciones de rama) y, a continuación, seleccione Combinar solicitud de cambios.

6. Seleccione Confirmar combinación.

   El cambio se combina.

7. Para eliminar la bugfix/home-page-typo rama, seleccione Eliminar rama.