Notas de lanzamiento generadas automáticamente

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 GitHub, navegue hasta la página principal del repositorio.

2. A la derecha de la lista de archivos, haga clic en Releases.

   

3. En la parte superior de la página, haz clic en Borrador de una versión nueva.

4. Para elegir una etiqueta para la versión, selecciona el menú desplegable Elegir una etiqueta.

   • Para usar una etiqueta existente, haz clic en ella.
   • Para crear una etiqueta, escribe un número para la versión y, luego, haz clic en Crear etiqueta.

5. Si creaste una etiqueta, selecciona el menú desplegable Destino y, luego, haz clic en la rama que contiene el proyecto que quieres lanzar.

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

   

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

8. Encima del campo descripción, haga clic en Generar notas de la versión.

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

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

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

12. Si lo deseas, selecciona Establecer como la versión más reciente. Si no seleccionas esta opción, la etiqueta de versión más reciente se asignará automáticamente en función del Versionamiento Semántico.

13. De manera opcional, si se habilitó GitHub Discussions para el repositorio, crea un debate para la versión.

    • Selecciona Crear un debate para esta versión.
    • Selecciona el menú desplegable Categoría y, luego, haz clic en una categoría para el debate de la versión.

14. 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).

Configurar las notas de lanzamiento generadas automáticamente

1. En GitHub, navegue hasta la página principal del repositorio.

2. Encima de la lista de archivos, selecciona el menú desplegable Add file y, a continuación, haz clic en Create new file.

   Como alternativa, puedes hacer clic en en la vista de árbol de archivos a la izquierda.

   

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

Configuraciones de ejemplo

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

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

# .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)

# .github/release.yml

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

# .github/release.yml

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

Información adicional

• Administrar las etiquetas