跳到主要内容

Linear 发布说明模板

在向 Linear 代理请求根据发布项目、里程碑或问题列表起草 Unraid OS 发布说明时，请使用此模板。

Linear 代理提示词​

将此提示词复制到 Linear 中，然后在运行前替换方括号中的值。

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

起草规则​

  • 以用户影响为导向。将工程笔记转化为对用户、管理员或升级安全性有何变化。
  • 保持要点简洁且客观。除非与用户有关，否则不要包含内部项目名称、问题 ID、分支名称、提交哈希或实现细节。
  • 在变更部分中一致使用前缀 New:、Improvement:、Fix: 和 Security:。
  • 将相关条目归类到最具体的标题下。对于广泛的界面、设置、系统服务、许可状态和通知更改，使用 WebGUI / System。
  • 仅当用户必须更改行为，或回滚、兼容性、网络、存储、数据或配置行为发生变化时，才包含 BREAKING CHANGES 部分。
  • 不要编造 CVE、受影响的软件包、软件包版本、回滚警告、已知问题或升级建议。如果源材料不清楚，请写入 [NEEDS CONFIRMATION: ...]。
  • 当公开来源链接有助于用户验证细节时，请保留它们，例如上游发行说明、用户报告或相关文档。
  • 文档链接优先使用此格式：/unraid-os/release-notes/[VERSION]/。
  • UI 标签使用 加粗，导航路径使用 加粗斜体，例如 Settings → Disk Settings。
  • 软件包名称、命令、配置键、路径、版本、内核配置符号和错误字符串使用行内代码。
  • 在发布前移除未使用的可选部分。

发行说明检查清单​

在发布前，请确认：

  • 标题为 # Version [VERSION] [YYYY-MM-DD]。
  • 摘要提及最重要的变更，但不会重复每个部分的内容。
  • 本次发布的升级、已知问题和回滚说明均准确无误。
  • 安全声明与已确认的安全公告或软件包变更日志一致。
  • 软件包数量与软件包列表一致。
  • 上一版本链接指向正确的版本。
  • 已移除带有占位符的可选部分。