Changelog Block
Document version releases with categorised changes. Group changes by type: added, changed, fixed, removed, deprecated, or security, following Keep a Changelog conventions.
The Changelog block structures release information following the Keep a Changelog format. Each entry documents a version with optional date and categorised list of changes.
When to Use
Block Properties
| Property | Required | Description |
|---|---|---|
| Version | Yes | Semantic version number (e.g., 1.2.0) |
| Date | No | Release date |
| Changes | Yes | Array of categorised change entries |
Change Entry Properties
| Property | Required | Description |
|---|---|---|
| Type | Yes | Category: Added, Changed, Fixed, Removed, Deprecated, or Security |
| Description | Yes | What changed in this entry |
Change Types
Example: Feature Release
A typical release with multiple change types.
Example: Security Patch
A patch release addressing security issues.
Editing Changelogs
| Action | How To |
|---|---|
| Set Version | Enter the semantic version number in the version field |
| Set Date | Use the date picker to select the release date |
| Add Change | Click Add Change and select the change type from dropdown |
| Enter Description | Describe what changed in the description field |
| Preview | View the live preview grouped by change type |