Buscar
  • Angel Taborda

Plantilla para los Pull Request en Azure DevOps

Empezare por explicar brevemente qué son estas plantillas y para qué nos valen.


Cada vez que hacemos un pull request, dar una buena descripción de lo que hemos hecho es una manera muy buena de indicar el contexto en el que deben ubicarse aquellos que revisen el código.


Crear plantillas para los pull request es una manera de ayudar a los desarrolladores a saber qué deberían escribir dentro de la descripción.


¿Qué son las plantillas?


Son archivos .md, es decir texto en formato markdown, cuyo contenido se agregará automáticamente en nuestra descripción cuando creamos un nuevo pull request.


Por ejemplo:

            
    Antes de enviar este pull request, por favor asegúrate de:
    - [ ] El código compila sin errores o advertencias.
    - [ ] Estás usando terminología aprobada.
    - [ ] Has agregado pruebas unitarias.
    
    ## Detalles del pull request

En los repositorios de Azure podemos crear 3 tipos de plantillas:

  • Plantilla por defecto

  • Plantilla por rama

  • Plantillas adicionales

El tipo de plantilla que se usa dependerá del nombre del fichero y la ubicación de la carpeta que lo contenga.


NOTA: Todas las plantillas deben existir en la rama principal (usualmente master) de tu repositorio ya que son las que se tomarán en cuenta.


Plantilla por defecto


Esta plantilla se aplicará automáticamente a la descripción del pull request cuando se cree uno nuevo. Para crear esta plantilla sigue estos sencillos pasos:

  1. Crea en la raíz de tu repositorio una carpeta llamada .azuredevops

  2. Crea un nuevo fichero llamado pull_request_template.md dentro de la carpeta.

TIP: Para crear la carpeta .azuredevops puedes navegar a tu repositorio usando el cmd y crearla usando el comando mkdir.


Plantilla por rama


Esta plantilla se aplicará solamente a los pull request cuyo nombre de rama de origen coincida con alguno de las plantillas existentes. El nombre de la plantilla tendrá que coincidir con el nombre del primer nivel de la rama, por ejemplo:


Si tenemos una plantilla feature.md esta será aplicada a los pull request creados desde las ramas feature/*.


Para crear plantillas por rama debemos hacer lo siguiente:

  1. Crear dentro de la carpeta .azuredevops la carpeta pull_request_template

  2. Crear dentro de la carpeta pull_request_template la carpeta branches

  3. Crear dentro de la carpeta branches la plantilla, por ejemplo dev.md


El resultado sería el siguiente:


/.azuredevops/pull_request_template/branches/dev.md


Plantillas adicionales


Estas plantillas se pueden seleccionar de manera manual al momento de crear un nuevo pull request. Estas plantillas deben crearse en la ruta:


/.azuredevops/pull_request_template/


A diferencia de los tipos anteriores, estas plantillas pueden tener el nombre que queramos, por ejemplo:


/.azuredevops/pull_request_template/mi_plantilla_adicional.md


Resumen


Las plantillas para descripciones de pull request nos ayudan a dar más y mejor información a los que deban revisar el código y nos permite definir un estándar a seguir dentro de la empresa.


Es posible definir plantillas que se usarán por defecto, por rama o adicionales y todas deben ser guardadas en la rama principal que por lo general es la rama master.


Para más detalles sobre la estructuración de las carpetas y plantillas, visita la documentación citada en la sección de fuentes.


Fuentes

5 vistas0 comentarios

Entradas Recientes

Ver todo
 
  • LinkedIn

©2021 Angel Taborda Chinea