Automatización de las notas de la versión con GitHub

  • 5 minutos

Después de aprender a crear y administrar etiquetas de versión en el repositorio, aprenderá a configurar la plantilla de notas de la versión generada automáticamente a partir de las versiones de GitHub.

Puede generar información general sobre el contenido de una versión y también personalizar las notas de la versión automatizadas.

Se pueden usar etiquetas para crear categorías personalizadas a fin de organizar solicitudes de incorporación de cambios que quiera incluir o excluir etiquetas o usuarios concretos en la salida.

Creación de notas de la versión generadas automáticamente

Al configurar la versión, verá la opción Generar automáticamente notas de la versión para incluir todos los cambios entre la etiqueta y la última versión. Si nunca ha creado una versión, consta de todos los cambios del repositorio.

Captura de pantalla del proceso de creación de notas de la versión desde GitHub.

Puede elegir si quiere personalizarla o dejarla tal cual.

Configuración de la plantilla de notas de la versión generadas automáticamente

Puede personalizar la plantilla de notas de la versión de generación automática mediante los pasos siguientes.

  1. Vaya al repositorio y cree un archivo.

    Captura de pantalla del proceso de creación de un archivo en GitHub.

  2. Puede usar el nombre .github/release.yml para crear el archivo release.yml en el directorio .github.

    Captura de pantalla del proceso de creación de un archivo release.yml en GitHub.

  3. Especifique en YAML las etiquetas de solicitud de incorporación de cambios y los creadores que quiera excluir de esta versión. También puede crear categorías y enumerar las etiquetas de solicitud de incorporación de cambios en cada una de ellas. Para más información sobre las opciones de configuración, vea Notas de la versión generadas automáticamente: Documentación de GitHub.

    Configuración de ejemplo:

    # .github/release.yml

changelog:
  exclude:
    labels:
    - ignore-for-release
    authors:
    - octocat
  categories:
    - title: Breaking Changes 🛠
      labels:
        - Semver-Major
        - breaking-change
    - title: Exciting New Features 🎉
      labels:
        - Semver-Minor
        - enhancement
    - title: Other Changes
      labels:
        - *

  4. Confirme el nuevo archivo.

    Captura de pantalla del proceso de confirmación de un archivo nuevo en GitHub.

  5. Intente crear una versión y haga clic en + Generar automáticamente notas de la versión para ver la estructura de la plantilla.

Para más información, consulte: