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 las notas de la versión generadas automáticamente para las versiones de GitHub.

Puede crear información general sobre lo que se incluye en una versión y también puede personalizar las notas de la versión automatizadas.

Puede usar etiquetas para crear categorías personalizadas para organizar las solicitudes de incorporación de cambios. También puede elegir incluir o excluir etiquetas y usuarios específicos de la salida.

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

Al configurar su lanzamiento, tiene la opción "Generar automáticamente las notas del lanzamiento" para incluir todos los cambios entre su etiqueta y el último lanzamiento. Si nunca ha creado una versión, incluye todos los cambios del repositorio.

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

Puede elegir personalizarla o dejarla tal como está.

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

Puede personalizar la plantilla de notas de la versión generada automáticamente siguiendo estos pasos:

  1. Vaya al repositorio y cree un nuevo archivo.

    Captura de pantalla de cómo crear un archivo en GitHub.

  2. Use 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. Escriba en formato YAML, que extrae etiquetas de solicitud y 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: Documentos 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 de cómo confirmar un nuevo archivo en GitHub.

  5. Intente crear una nueva versión y seleccione + Generar automáticamente notas de la versión para ver cómo funciona la plantilla.

Para obtener más información, consulte: