Skip to main content
Publicamos actualizaciones para la documentación con frecuencia y es posible que aún se esté traduciendo esta página. Para obtener la información más reciente, consulta la documentación en inglés.
GitHub AE es una versión limitada en este momento.

Notas de lanzamiento generadas automáticamente

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

Quién puede usar esta característica

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. En tu empresa, navega a la página principal del repositorio. 1. A la derecha de la lista de archivos, haga clic en Releases.

    Captura de pantalla de la página principal de un repositorio. Un vínculo con la etiqueta "Versiones" aparece resaltado con un contorno naranja. 1. At the top of the page, click Draft a new release.

  2. To choose a tag for the release, select the Choose a tag dropdown menu.

    • To use an existing tag, click the tag.
    • To create a new tag, type a version number for your release, then click Create new tag.
  3. If you created a new tag, select the Target dropdown menu, then click the branch that contains the project you want to release.

  4. Si quieres, encima del campo de descripción, selecciona el menú desplegable Etiqueta anterior y haz clic en la etiqueta que identifica la versión anterior.

    Captura de pantalla del formulario "Nueva versión". Un menú desplegable con la etiqueta "Etiqueta anterior: automática" aparece resaltado con un contorno naranja.

  5. En el campo "Título de versión", escribe un título para la versión.

  6. Encima del campo de descripción, haz clic en Generar notas de la versión.

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

  8. 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.

  9. De manera opcional, para notificar a los usuarios de que la versión no está lista para producción y puede ser inestable, selecciona Esta es una versión preliminar.

  10. 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). Después, puedes ver las versiones publicadas o los borradores en la fuente de versiones del repositorio. Para obtener más información, vea «Visualizar los lanzamientos y etiquetas de tu repositorio».

Configurar las notas de lanzamiento generadas automáticamente

  1. En tu empresa, navega a la página principal del repositorio.

  2. Encima de la lista de archivos, haga clic en Create new file (Crear archivo) mediante la lista desplegable Add file (Agregar archivo).

  3. En el campo del nombre de archivo, escriba .github/release.yml. Se creará un archivo denominado release.yml en el directorio .github.

  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[*].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