Changelog Management

Document your releases, updates, and improvements. Keep users informed about what’s new in your product.

What is the Changelog?

The changelog feature lets you create release notes that:

Document version releases
List new features, fixes, and improvements
Link to related roadmap items
Show your product’s evolution over time

Creating Changelog Entries

Add a New Entry

Go to Roadmap > Changelog > Add New
Enter a title (typically the version number)
Write the release notes

Entry Fields

Field	Purpose	Example
Title	Version or release name	“Version 2.1.0”
Content	Full release notes	New features, fixes, changes
Release Date	When this version shipped	Custom meta field
Version Number	Semantic version	“2.1.0”
Release Type	Major, minor, patch	“Minor Release”

Change Types

Categorize your changelog entries by type: New Feature, Enhancement, Fix, Breaking Change, Security, Deprecated, or Update.

Writing Good Release Notes

Structure your content:

## New Features
- Added dark mode toggle in settings
- New export to PDF option for reports

## Improvements
- Faster dashboard loading (40% improvement)
- Better mobile navigation

## Bug Fixes
- Fixed login timeout on slow connections
- Resolved email notification delays

## Notes
- Requires PHP 7.4 or higher

Tips:

Lead with the most impactful changes
Group by type (features, fixes, improvements)
Be specific about what changed
Mention any breaking changes prominently

Displaying Your Changelog {#display}

Changelog Shortcode

Add to any page:

[roadmap_changelog]

Display Options

&#91;roadmap_changelog
    limit="10"
    orderby="date"
    order="desc"
&#93;

Parameter	Options	Default
`limit`	Number of entries	10
`orderby`	date, title	date
`order`	asc, desc	desc

Changelog Archive

Entries are also available at: yoursite.com/roadmap-changelog/

Each entry has its own page: yoursite.com/roadmap-changelog/version-2-1-0/

Linking Items to Releases {#linking}

Connect roadmap items to changelog entries.

Why Link Items?

Show what features shipped in which version
Create a paper trail from idea to release
Help users find when features were added

How to Link

Edit a roadmap item
Find the “Related Changelog” or “Released In” field
Select the relevant changelog entry
Update the item

The item now shows which version it shipped in.

On the Changelog Side

Edit a changelog entry
Find “Related Items” section
Select roadmap items included in this release
Update the entry

The changelog now lists what shipped.

Changelog Templates

Default Template

Clean list of releases with expandable content.

Compact Template

[roadmap_changelog template="compact"]

Shows version, date, and summary only.

Timeline Template

[roadmap_changelog template="timeline"]

Visual timeline of releases.

Best Practices

Consistency

Use the same format for all releases
Maintain semantic versioning (MAJOR.MINOR.PATCH)
Always include a date
Link to documentation for major features

Timing

Publish changelog when release is live
Draft entries while building features
Schedule posts to coincide with deployments

Audience

Write for users, not developers
Explain benefits, not just technical changes
Highlight what users asked for

Pro: Multi-Product Changelogs

Pro Feature – Requires the Pro addon.

Product-Specific Changelogs

With Pro, assign changelog entries to products:

[roadmap_changelog product="mobile-app"]

Shows only entries for the mobile app product.

Multiple Products

[roadmap_changelog product="mobile-app,web-platform"]

Shows entries from both products.

Admin Filtering

Go to Roadmap > Changelog
Use the Product dropdown filter
Select a product to see its releases
Bulk assign products to multiple entries

REST API Access

Get changelogs programmatically:

GET /wp-json/roadmap/v1/changelog/by-product/mobile-app

Returns paginated results with product context.

Learn about Multi-Product →

API Integration

REST Endpoints

List all changelogs:

GET /wp-json/roadmap/v1/changelog

Get single entry:

GET /wp-json/roadmap/v1/changelog/{id}

Parameters:

per_page – Items per page (default: 10)
page – Page number
orderby – Sort field
order – asc or desc

Response Example

{
  "id": 123,
  "title": "Version 2.1.0",
  "content": "<p>Release notes...</p>",
  "date": "2024-03-15T10:30:00",
  "version": "2.1.0",
  "release_type": "minor",
  "related_items": [45, 67, 89]
}

Plugin Changelog {#plugin-changelog}

What’s New in Product Roadmap

Version 1.3.1 (January 2026)

Security: Fixed vote protection improvements
Performance: Faster API responses with batch loading
Performance: Dashboard stats now cached

Version 1.3.0 (December 2025)

New: Changelog feature for release notes
New: Idea Box template for feedback collection
New: Single item voting UI improvements
Improved: Better mobile responsiveness

Version 1.2.0

New: REST API endpoints
New: Category and tag filtering
Improved: Shortcode parameter handling

Troubleshooting

Changelog not appearing

Verify entries are published (not drafts)
Check shortcode syntax: [roadmap_changelog]
Clear caching plugins

Dates showing incorrectly

Check WordPress timezone settings
Verify date format in Settings > General
Ensure release date field is populated

Links between items and changelog broken

Re-save the items and changelog entries
Check that related fields are properly selected
Verify items haven’t been trashed

Next Steps

Goal	Guide
Display your roadmap	Display Options
Track engagement	Analytics	Pro
Manage multiple products	Multi-Product	Pro