Saltar al contenido principal

Plantilla de notas de lanzamiento lineales

Use esta plantilla cuando le pida a un agente de Linear que redacte las notas de la versión de Unraid OS a partir de un proyecto de lanzamiento, un hito o una lista de incidencias.

Indicador del agente de Linear

Copie este indicador en Linear y luego reemplace los valores entre corchetes antes de ejecutarlo.

Draft Unraid OS release notes for [VERSION] using the linked Linear issues, pull requests, package diff, and security notes.

Release context:
- Version: [VERSION]
- Release date: [YYYY-MM-DD]
- Previous release: [PREVIOUS_VERSION]
- Release type: [stable / bugfix / security / beta / release candidate]
- Audience: Unraid OS users upgrading from [PREVIOUS_VERSION]
- Source scope: [Linear project, milestone, label, or issue list]

Output only the final release note Markdown. Do not include process notes, issue IDs, internal-only implementation details, or unsupported claims.

Follow this structure:

# Version [VERSION] [YYYY-MM-DD]

[One short summary paragraph. Mention the most important user-facing themes: security, kernel, Docker, storage, WebGUI, virtualization, licensing, hardware support, API, or package updates.]

[Optional recommendation sentence for security or important bugfix releases.]

## Upgrading

For step-by-step instructions, see [Updating Unraid](/unraid-os/updating-unraid/). Questions about your [license](/unraid-os/troubleshooting/licensing-faq/)?

### Known issues

[List release-specific known issues. If there are no new release-specific known issues, refer to the previous relevant release notes.]

### Notes

[Optional operational notes that are important but not bugs, warnings, or rollback blockers.]

### Rolling back

[List rollback warnings and compatibility limits. Include prior-release links when users need to read earlier rollback notes.]

## BREAKING CHANGES

[Include only when the release changes behavior, configuration, compatibility, data format, upgrade safety, rollback safety, or user workflows in a way users must act on.]

## Changes vs. [PREVIOUS_VERSION_LINK_TEXT]([PREVIOUS_VERSION_LINK])

### Security

- Security: [User-facing security fix, CVE coverage, or hardening change.]

### Containers / Docker

- New: [New Docker or container capability.]
- Improvement: [Improved Docker or container behavior.]
- Fix: [Corrected Docker or container issue.]

### Storage

- New: [New storage capability.]
- Improvement: [Improved storage behavior.]
- Fix: [Corrected storage issue.]

### WebGUI / System

- New: [New WebGUI or system capability.]
- Improvement: [Improved WebGUI or system behavior.]
- Fix: [Corrected WebGUI or system issue.]

### File Manager

- Improvement: [Improved File Manager behavior.]
- Fix: [Corrected File Manager issue.]

### Networking / Hardware

- New: [New networking or hardware support.]
- Improvement: [Improved networking or hardware behavior.]
- Fix: [Corrected networking or hardware issue.]

### Virtualization

- New: [New VM capability.]
- Improvement: [Improved VM behavior.]
- Fix: [Corrected VM issue.]

### Unraid API

- Update Unraid API to dynamix.unraid.net [VERSION] - [see changes](https://github.com/unraid/api/releases).
- Fix: [Corrected API issue.]

### Linux kernel

- Linux kernel: update to `[KERNEL_VERSION]-Unraid`.
- Security: [Kernel CVE coverage, when applicable.]

### Base distro updates

#### Removed packages ([COUNT])

- [package]: version [VERSION] removed

#### Downgraded packages ([COUNT])

- [package]: version [OLD_VERSION] -> [NEW_VERSION]

#### Added packages ([COUNT])

- [package]: version [VERSION]

#### Updated packages ([COUNT])

- [package]: version [OLD_VERSION] -> [NEW_VERSION] [(CVE list, when applicable)]

Reglas de redacción

  • Lidere con el impacto para el usuario. Convierta las notas de ingeniería en lo que cambió para los usuarios, los administradores o la seguridad de actualización.
  • Mantenga las viñetas concisas y objetivas. No incluya nombres internos de proyectos, IDs de incidencias, nombres de ramas, hashes de commits ni detalles de implementación, a menos que sean importantes para los usuarios.
  • Use los prefijos New:, Improvement:, Fix: y Security: de forma coherente en las secciones de cambios.
  • Agrupe los elementos relacionados bajo el encabezado más específico. Use WebGUI / System para cambios amplios de la interfaz de usuario, ajustes, servicio del sistema, estado de licencias y notificaciones.
  • Incluya una sección BREAKING CHANGES solo cuando los usuarios deban cambiar su comportamiento o cuando cambie el comportamiento de reversión, compatibilidad, red, almacenamiento, datos o configuración.
  • No invente CVE, paquetes afectados, versiones de paquetes, advertencias de reversión, problemas conocidos ni recomendaciones de actualización. Si el material de origen no está claro, escriba [NEEDS CONFIRMATION: ...].
  • Conserve los enlaces públicos de origen cuando ayuden a los usuarios a verificar detalles, como notas de la versión aguas arriba, informes de usuarios o documentación relacionada.
  • Prefiera los enlaces de documentación en este formato: /unraid-os/release-notes/[VERSION]/.
  • Use negrita para las etiquetas de la interfaz y negrita en cursiva para las rutas de navegación, como Settings → Disk Settings.
  • Use código en línea para nombres de paquetes, comandos, claves de configuración, rutas, versiones, símbolos de configuración del kernel y cadenas de error.
  • Elimine las secciones opcionales no usadas antes de publicar.

Lista de verificación de notas de la versión

Antes de publicar, confirme que:

  • El encabezado es # Version [VERSION] [YYYY-MM-DD].
  • El resumen menciona los cambios más importantes sin repetir todas las secciones.
  • Las notas de actualización, de problemas conocidos y de reversión son precisas para esta versión.
  • Las afirmaciones de seguridad coinciden con los avisos confirmados o los registros de cambios de los paquetes.
  • Los conteos de paquetes coinciden con las listas de paquetes.
  • Los enlaces de la versión anterior apuntan a la versión correcta.
  • Las secciones opcionales con marcadores de posición se han eliminado.