メインコンテンツへスキップ

Linear リリースノート テンプレート

このテンプレートは、Linear エージェントにリリース プロジェクト、マイルストーン、または issue 一覧から 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: の接頭辞を一貫して使用してください。
  • 関連する項目は、最も具体的な見出しの下にまとめてください。広範な UI、設定、システムサービス、ライセンス状態、通知の変更には WebGUI / System を使用してください。
  • BREAKING CHANGES セクションは、ユーザーが動作を変更する必要がある場合、またはロールバック、互換性、ネットワーク、ストレージ、データ、設定の動作が変わる場合にのみ含めてください。
  • CVE、影響を受けるパッケージ、パッケージのバージョン、ロールバック警告、既知の問題、またはアップグレード推奨事項を作り出さないでください。ソース資料が不明確な場合は、[NEEDS CONFIRMATION: ...] と記載してください。
  • 公開されているソースリンクは、上流のリリースノート、ユーザー報告、関連ドキュメントなど、詳細の検証に役立つ場合は保持してください。
  • ドキュメントリンクは、次の形式を優先してください: /unraid-os/release-notes/[VERSION]/。
  • UI ラベルには 太字 を、Settings → Disk Settings のようなナビゲーションパスには 太字斜体 を使用してください。
  • パッケージ名、コマンド、設定キー、パス、バージョン、カーネル設定シンボル、エラー文字列にはインラインコードを使用してください。
  • 公開前に、未使用の任意セクションを削除してください。

リリースノートのチェックリスト​

公開前に、次の点を確認してください:

  • 見出しは # Version [VERSION] [YYYY-MM-DD] です。
  • 概要には、各セクションを繰り返さずに最も重要な変更が記載されています。
  • アップグレード、既知の問題、およびロールバックに関する注記は、このリリースについて正確です。
  • セキュリティに関する記述は、確認済みのアドバイザリまたはパッケージの変更履歴と一致しています。
  • パッケージ数はパッケージ一覧と一致しています。
  • 前回リリースへのリンクは正しいバージョンを指しています。
  • プレースホルダー付きの任意セクションは削除されています。