Notas de lanzamiento generadas automáticamente

Puedes generar notas de lanzamiento automáticamente para tus lanzamientos de GitHub

Repository collaborators and people with write access to a repository can generate and customize automated release notes for a release.

Acerca de las notas de lanzamiento generadas automáticamente

Las notas de lanzamiento generadas automáticamente proporcionan una alternativa de automatización para escribir notas de lanzamiento manualmente para tus lanzamientos de GitHub. Con las notas de lanzamiento generadas automáticamente, puedes generar rápidamente un resumen del contenido de un lanzamiento. También puedes personalizar tus notas de lanzamiento automatizadas, utilizando etiquetas para crear categorías personalizadas para organizar las solicitudes de cambio que quieras incluir y excluyendo ciertas etiquetas y usuarios para que no aparezcan en la salida.

Crear notas de lanzamiento generadas automáticamente para un lanzamiento nuevo

  1. En GitHub.com, visita la página principal del repositorio.

  2. A la derecha de la lista de archivos, haz clic en Lanzamientos. Sección de lanzamientos en la barra lateral de lado derecho

  3. Haz clic en Borrador de un nuevo lanzamiento. Botón Borrador de lanzamientos

  4. Haz clic en Elige una etiqueta y teclea un número de versión para tu lanzamiento. Como alternativa, selecciona una etiqueta existente.

    Ingresa una etiqueta

  5. Si estás creando una etiqueta nueva, haz clic en Crear etiqueta nueva. Confirma si quieres crear una etiqueta nueva

  6. Si creaste una etiqueta nueva, utiliza el menú desplegable para seleccionar la rama que contiene el proyecto que quieres lanzar. Elige una rama

  7. En la caja de texto de descripción que se encuentra en la esquina superior derecha, haz clic en Autogenerar notas de lanzamiento. Autogenerar notas de lanzamiento

  8. Verifica las notas generadas para garantizar que incluyan toda (y únicamente) la información que quieras incluir.

  9. Opcionalmente, para incluir los archivos binarios tales como programas compilados en tu lanzamiento, arrastra y suelta o selecciona manualmente los archivos en la caja de binarios. Proporcionar un DMG con el lanzamiento

  10. Para notificar a los usuarios que el lanzamiento no está listo para producción y puede ser inestable, selecciona Esto es un pre-lanzamiento. Casilla de verificación para marcar un lanzamiento como prelanzamiento

  11. Si estás listo para publicitar tu lanzamiento, haz clic en Publicar lanzamiento. Para seguir trabajando luego en el lanzamiento, haz clic en Guardar borrador. Botones Publicar lanzamiento y Borrador de lanzamiento

Configurar las notas de lanzamiento generadas automáticamente

  1. En GitHub.com, visita la página principal del repositorio.
  2. En la parte superior de la lista de archivos, utilizando el menú desplegable de Agregar archivo, da clic en Crear archivo nuevo. "Crear archivo nuevo" en el menú desplegable de "Agregar archivo"
  3. En el campo de nombre de archivo, teclea .github/release.yml para crear el archivo release.yml en el directorio .github. Crear archivo nuevo
  4. En el archivo, el utilizar las opciones de configuración siguientes, especificarán en YAML las etiquetas de solicitudes de cambio y los autores que quieras excluir de este lanzamiento. También puedes crear categorías nuevas y listar las etiquetas de la solicitud de cambios que se deben incluir en cada una de ellas.

Opciones de configuración

ParámetroDescripción
changelog.exclude.labelsUna lista de etiquetas que excluyen una solicitud de cambios para que no aparezca en las notas de lanzamiento.
changelog.exclude.authorsUna lista de manejos de inicio de sesión de usuarios o bots cuyas solicitudes de cambio deben excluirse de las notas de lanzamiento.
changelog.categories[*].titleRequerido. El título de una categoría de cambios en las notas de lanzamiento.
changelog.categories[*].labelsRequerido. Las etiquetas que califican a una solicitud de cambios para esta categoría. Utiliza * como un comodín para solicitudes de cambio que no empataron con ninguna de las categorías anteriores.
changelog.categories[*].exclude.labelsUna lista de etiquetas que excluye una solicitud de cambio para que no aparezca en esta categoría.
changelog.categories[*].exclude.authorsUna lista de manejos de inicio de sesión de usuarios o bots cuyas solicitudes de cambio deben excluirse de esta categoría.

Ejemplo de configuración

YAML
# .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:
        - "*"

Leer más

¿Te ayudó este documento?

Política de privacidad

¡Ayúdanos a hacer geniales estos documentos!

Todos los documentos de GitHub son de código abierto. ¿Notas algo que esté mal o que no sea claro? Emite una solicitud de cambios.

Haz una contribución

O, aprende cómo contribuir.