Passer au contenu principal

Modèle de note de version linéaire

Utilisez ce modèle lorsque vous demandez à un agent Linear de rédiger des notes de version d'Unraid OS à partir d'un projet de publication, d'un jalon ou d'une liste de tickets.

Invite de l'agent Linear​

Copiez cette invite dans Linear, puis remplacez les valeurs entre crochets avant de l'exécuter.

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)]

Règles de rédaction​

  • Mettez en avant l’impact pour l’utilisateur. Transformez les notes d’ingénierie en ce qui a changé pour les utilisateurs, les administrateurs ou la sécurité de la mise à niveau.
  • Gardez les puces concises et factuelles. N’incluez pas les noms de projet internes, les ID de tickets, les noms de branches, les hachages de commit ni les détails d’implémentation, sauf s’ils ont une incidence pour les utilisateurs.
  • Utilisez les préfixes New:, Improvement:, Fix: et Security: de manière cohérente dans les sections des changements.
  • Regroupez les éléments liés sous l’en-tête le plus spécifique. Utilisez WebGUI / System pour les changements généraux de l’interface utilisateur, des paramètres, du service système, de l’état de licence et des notifications.
  • Incluez une section BREAKING CHANGES uniquement lorsque les utilisateurs doivent modifier leur comportement ou lorsque le retour arrière, la compatibilité, le réseau, le stockage, les données ou le comportement de configuration changent.
  • N’inventez pas de CVE, de paquets concernés, de versions de paquets, d’avertissements de retour arrière, de problèmes connus ou de recommandations de mise à niveau. Si le matériel source n’est pas clair, écrivez [NEEDS CONFIRMATION: ...].
  • Conservez les liens publics vers les sources lorsqu’ils aident les utilisateurs à vérifier les détails, comme les notes de version en amont, les rapports d’utilisateurs ou les documents associés.
  • Préférez les liens de documentation dans ce format : /unraid-os/release-notes/[VERSION]/.
  • Utilisez le gras pour les libellés de l’interface utilisateur et le gras italique pour les chemins de navigation, comme Paramètres → Paramètres du disque.
  • Utilisez le code en ligne pour les noms de paquets, les commandes, les clés de configuration, les chemins, les versions, les symboles de configuration du noyau et les chaînes d’erreur.
  • Supprimez les sections facultatives inutilisées avant la publication.

Liste de vérification des notes de version​

Avant la publication, confirmez que :

  • L’en-tête est # Version [VERSION] [YYYY-MM-DD].
  • Le résumé mentionne les changements les plus importants sans répéter chaque section.
  • Les notes de mise à niveau, de problème connu et de retour arrière sont exactes pour cette version.
  • Les affirmations de sécurité correspondent aux avis confirmés ou aux journaux des modifications des paquets.
  • Les nombres de paquets correspondent aux listes de paquets.
  • Les liens vers la version précédente pointent vers la bonne version.
  • Les sections facultatives contenant des espaces réservés ont été supprimées.