Skip to main content

Notas de lanzamiento generadas automáticamente

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

Who can use this feature

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. Las notas de la versión generadas automáticamente incluyen una lista de solicitudes de incorporación de cambios combinadas, una lista de colaboradores para la versión y un vínculo a un registro de cambios completo.

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. On GitHub.com, navigate to the main page of the repository. 1. A la derecha de la lista de archivos, haga clic en Releases. Sección Releases en la barra lateral del lado derecho
  2. Haga clic en Draft a new release (Borrador de una nueva versión). Botón de borrador de versiones
  3. Haga clic en Choose a tag (Elegir una etiqueta) y escriba un número para la versión. Como alternativa, selecciona una etiqueta existente. Escriba una etiqueta
  4. Si va a crear una etiqueta, haga clic en Create new tag (Crear etiqueta). Confirme que quiere crear una etiqueta
  5. Si creaste una etiqueta nueva, utiliza el menú desplegable para seleccionar la rama que contiene el proyecto que quieres lanzar. Elegir una rama
  6. Opcionalmente, en la parte superior derecha del cuadro de texto de descripción, selecciona el menú desplegable de Etiqueta anterior y haz clic en la etiqueta que identifica la versión anterior. Captura de pantalla en la que se muestra cómo seleccionar una etiqueta para identificar la versión anterior
  7. En la parte superior derecha del cuadro de texto de descripción, haz clic en Generar notas de la versión. Generar notas de la versión
  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. Inclusión de un DMG con la versión
  10. Para notificar a los usuarios que la versión no está lista para producción y puede ser inestable, seleccione Es una versión preliminar. Casilla para marcar una versión como versión preliminar
  11. Opcionalmente, seleccione Create a discussion for this release (Crear un debate para esta versión), después, seleccione el menú desplegable Category (Categoría) y haga clic en una categoría para el debate de la versión. Casilla para crear un debate de versión y menú desplegable para elegir una categoría
  12. Si está listo para publicar la versión, haga clic en Publish release (Publicar versión). Para trabajar después en la versión, haga clic en Save draft (Guardar borrador). Botones para publicar la versión y guardar un borrador

Configurar las notas de lanzamiento generadas automáticamente

  1. On GitHub.com, navigate to the main page of the repository. 1. Encima de la lista de archivos, haga clic en Create new file (Crear archivo) mediante la lista desplegable Add file (Agregar archivo). "Crear archivo" en la lista desplegable "Agregar archivo"
  2. En el campo nombre de archivo, escriba .github/release.yml para crear el archivo release.yml en el directorio .github. Crear un nuevo archivo
  3. 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[*].titleObligatorio. El título de una categoría de cambios en las notas de la versión.
changelog.categories[*].labelsObligatorio. Las etiquetas que califican una solicitud de incorporación de cambios para esta categoría. Use * como comodín para las solicitudes de incorporación de cambios que no encajen en 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.

Configuraciones de ejemplo

Configuración de un repositorio que etiqueta las versiones de semver

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:
        - "*"

Configuración de un repositorio que no etiqueta las solicitudes de incorporación de cambios, pero donde queremos separar solicitudes de incorporación de cambios automatizadas de Dependabot en las notas la versión (labels: '*' es necesario para mostrar una categoría catchall)

YAML
# .github/release.yml

changelog:
  categories:
    - title: 🏕 Features
      labels:
        - '*'
      exclude:
        labels:
          - dependencies
    - title: 👒 Dependencies
      labels:
        - dependencies

Información adicional