|
| 1 | +--- |
| 2 | +sidebar_position: 2 |
| 3 | +sidebar_label: Linear release note template |
| 4 | +--- |
| 5 | + |
| 6 | +# Linear release note template |
| 7 | + |
| 8 | +Use this template when asking a Linear agent to draft Unraid OS release notes from a release project, milestone, or issue list. |
| 9 | + |
| 10 | +## Linear agent prompt |
| 11 | + |
| 12 | +Copy this prompt into Linear, then replace the bracketed values before running it. |
| 13 | + |
| 14 | +```markdown |
| 15 | +Draft Unraid OS release notes for [VERSION] using the linked Linear issues, pull requests, package diff, and security notes. |
| 16 | + |
| 17 | +Release context: |
| 18 | +- Version: [VERSION] |
| 19 | +- Release date: [YYYY-MM-DD] |
| 20 | +- Previous release: [PREVIOUS_VERSION] |
| 21 | +- Release type: [stable / bugfix / security / beta / release candidate] |
| 22 | +- Audience: Unraid OS users upgrading from [PREVIOUS_VERSION] |
| 23 | +- Source scope: [Linear project, milestone, label, or issue list] |
| 24 | + |
| 25 | +Output only the final release note Markdown. Do not include process notes, issue IDs, internal-only implementation details, or unsupported claims. |
| 26 | + |
| 27 | +Follow this structure: |
| 28 | + |
| 29 | +# Version [VERSION] [YYYY-MM-DD] |
| 30 | + |
| 31 | +[One short summary paragraph. Mention the most important user-facing themes: security, kernel, Docker, storage, WebGUI, virtualization, licensing, hardware support, API, or package updates.] |
| 32 | + |
| 33 | +[Optional recommendation sentence for security or important bugfix releases.] |
| 34 | + |
| 35 | +## Upgrading |
| 36 | + |
| 37 | +For step-by-step instructions, see [Updating Unraid](/unraid-os/updating-unraid/). Questions about your [license](/unraid-os/troubleshooting/licensing-faq/)? |
| 38 | + |
| 39 | +### Known issues |
| 40 | + |
| 41 | +[List release-specific known issues. If there are no new release-specific known issues, refer to the previous relevant release notes.] |
| 42 | + |
| 43 | +### Notes |
| 44 | + |
| 45 | +[Optional operational notes that are important but not bugs, warnings, or rollback blockers.] |
| 46 | + |
| 47 | +### Rolling back |
| 48 | + |
| 49 | +[List rollback warnings and compatibility limits. Include prior-release links when users need to read earlier rollback notes.] |
| 50 | + |
| 51 | +## BREAKING CHANGES |
| 52 | + |
| 53 | +[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.] |
| 54 | + |
| 55 | +## Changes vs. [PREVIOUS_VERSION_LINK_TEXT]([PREVIOUS_VERSION_LINK]) |
| 56 | + |
| 57 | +### Security |
| 58 | + |
| 59 | +- Security: [User-facing security fix, CVE coverage, or hardening change.] |
| 60 | + |
| 61 | +### Containers / Docker |
| 62 | + |
| 63 | +- New: [New Docker or container capability.] |
| 64 | +- Improvement: [Improved Docker or container behavior.] |
| 65 | +- Fix: [Corrected Docker or container issue.] |
| 66 | + |
| 67 | +### Storage |
| 68 | + |
| 69 | +- New: [New storage capability.] |
| 70 | +- Improvement: [Improved storage behavior.] |
| 71 | +- Fix: [Corrected storage issue.] |
| 72 | + |
| 73 | +### WebGUI / System |
| 74 | + |
| 75 | +- New: [New WebGUI or system capability.] |
| 76 | +- Improvement: [Improved WebGUI or system behavior.] |
| 77 | +- Fix: [Corrected WebGUI or system issue.] |
| 78 | + |
| 79 | +### File Manager |
| 80 | + |
| 81 | +- Improvement: [Improved File Manager behavior.] |
| 82 | +- Fix: [Corrected File Manager issue.] |
| 83 | + |
| 84 | +### Networking / Hardware |
| 85 | + |
| 86 | +- New: [New networking or hardware support.] |
| 87 | +- Improvement: [Improved networking or hardware behavior.] |
| 88 | +- Fix: [Corrected networking or hardware issue.] |
| 89 | + |
| 90 | +### Virtualization |
| 91 | + |
| 92 | +- New: [New VM capability.] |
| 93 | +- Improvement: [Improved VM behavior.] |
| 94 | +- Fix: [Corrected VM issue.] |
| 95 | + |
| 96 | +### Unraid API |
| 97 | + |
| 98 | +- Update Unraid API to dynamix.unraid.net [VERSION] - [see changes](https://github.com/unraid/api/releases). |
| 99 | +- Fix: [Corrected API issue.] |
| 100 | + |
| 101 | +### Linux kernel |
| 102 | + |
| 103 | +- Linux kernel: update to `[KERNEL_VERSION]-Unraid`. |
| 104 | +- Security: [Kernel CVE coverage, when applicable.] |
| 105 | + |
| 106 | +### Base distro updates |
| 107 | + |
| 108 | +#### Removed packages ([COUNT]) |
| 109 | + |
| 110 | +- [package]: version [VERSION] removed |
| 111 | + |
| 112 | +#### Downgraded packages ([COUNT]) |
| 113 | + |
| 114 | +- [package]: version [OLD_VERSION] -> [NEW_VERSION] |
| 115 | + |
| 116 | +#### Added packages ([COUNT]) |
| 117 | + |
| 118 | +- [package]: version [VERSION] |
| 119 | + |
| 120 | +#### Updated packages ([COUNT]) |
| 121 | + |
| 122 | +- [package]: version [OLD_VERSION] -> [NEW_VERSION] [(CVE list, when applicable)] |
| 123 | +``` |
| 124 | + |
| 125 | +## Drafting rules |
| 126 | + |
| 127 | +- Lead with user impact. Convert engineering notes into what changed for users, administrators, or upgrade safety. |
| 128 | +- Keep bullets concise and factual. Do not include internal project names, issue IDs, branch names, commit hashes, or implementation details unless they matter to users. |
| 129 | +- Use the prefixes `New:`, `Improvement:`, `Fix:`, and `Security:` consistently in change sections. |
| 130 | +- Group related items under the most specific heading. Use `WebGUI / System` for broad UI, settings, system-service, licensing-state, and notification changes. |
| 131 | +- Include a `BREAKING CHANGES` section only when users must change behavior or when rollback, compatibility, networking, storage, data, or configuration behavior changes. |
| 132 | +- Do not invent CVEs, affected packages, package versions, rollback warnings, known issues, or upgrade recommendations. If the source material is unclear, write `[NEEDS CONFIRMATION: ...]`. |
| 133 | +- Preserve public source links when they help users verify details, such as upstream release notes, user reports, or related docs. |
| 134 | +- Prefer docs links in this format: `/unraid-os/release-notes/[VERSION]/`. |
| 135 | +- Use **bold** for UI labels and **_bold italics_** for navigation paths, such as **_Settings → Disk Settings_**. |
| 136 | +- Use inline code for package names, commands, config keys, paths, versions, kernel config symbols, and error strings. |
| 137 | +- Remove unused optional sections before publishing. |
| 138 | + |
| 139 | +## Release-note checklist |
| 140 | + |
| 141 | +Before publishing, confirm that: |
| 142 | + |
| 143 | +- The heading is `# Version [VERSION] [YYYY-MM-DD]`. |
| 144 | +- The summary mentions the most important changes without repeating every section. |
| 145 | +- Upgrade, known issue, and rollback notes are accurate for this release. |
| 146 | +- Security claims match confirmed advisories or package changelogs. |
| 147 | +- Package counts match the package lists. |
| 148 | +- Previous-release links point to the correct version. |
| 149 | +- Optional sections with placeholders have been removed. |
0 commit comments