Automatizar 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 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 puede personalizar las notas de la versión automatizadas.

Es posible usar etiquetas para crear categorías personalizadas y organizar las solicitudes de incorporación de cambios; de esta forma, se pueden incluir o excluir ciertas etiquetas y usuarios específicos para que no aparezcan en el resultado.

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

Mientras configura su lanzamiento, verá la opción Generar automáticamente notas del lanzamiento para incluir todos los cambios entre su tag y el último lanzamiento. Si nunca ha creado una versión, esta consta de todos los cambios de su repositorio.

Captura de pantalla de cómo crear notas de la versión desde GitHub.

Puede elegir si desea personalizarlo o dejarlo tal como está.

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

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

  1. Vaya a su repositorio y cree un nuevo archivo.

    Captura de pantalla de cómo crear 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 de cómo crear release.yml archivo en GitHub.

  3. Especifique en YAML las etiquetas de solicitud de incorporación de cambios y los autores que desea excluir de esta versión. También puede crear nuevas categorías y enumerar las etiquetas de solicitud de incorporación de cambios en cada una. Para obtener más información sobre las opciones de configuración, consulte notas de la versión generadas automáticamente en GitHub Docs.

    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 de cómo confirmar el nuevo archivo en GitHub.

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

Para obtener más información, consulte: