Ghost Release: 2.5.0

TL;DR

Ghost 2.5.0 introduces significant updates to the Content API v2, including new endpoints, improved date formatting, and removal of unused features. This release also includes Node.js version pinning to v10.13.0+ and UI improvements in the admin interface. These changes primarily affect developers working with the Ghost API while preparing the platform for a more robust Content API v2 release.

Highlight of the Release

• Content API v2 improvements including new endpoints and better date formatting
• Node.js version pinned to ^10.13.0 or higher for improved security and stability
• New API controllers for oEmbed and Slack in v2 API
• Renamed /users to /authors endpoint in Content API v2
• UI improvements in admin interface with alphabetical sorting of tags and filters

Migration Guide

for Content API v2 Changes

If you're using the Content API v2, be aware of these breaking changes:

1. Mobiledoc format removed: The mobiledoc format option has been removed from post responses in the v2 Content API.

2. Users endpoint renamed: The /users endpoint is now /authors in Content API v2.

3. Configuration endpoint removed: The configuration endpoint has been removed from Content API v2.

4. Date format changes: Dates now include UTC offset in the Content API v2 responses.

5. Relative paths by default: HTML content now contains relative paths by default. If you need absolute URLs, use the ?absolute_urls=true query parameter.

Node.js Version Requirements

Ghost now requires Node.js version 10.13.0 or higher. If you're running an older version, you'll need to upgrade before updating to Ghost 2.5.0.

Upgrade Recommendations

For self-hosted Ghost users: This is a recommended upgrade if you're using the Content API v2 or if you need the bug fixes in the admin interface. Ensure you're running Node.js 10.13.0 or higher before upgrading.

For developers using the Content API v2: This is a significant update with breaking changes. Review the migration guide carefully before upgrading your integrations.

For regular Ghost users: This update contains minor UI improvements and bug fixes in the admin interface, making it a worthwhile but not critical upgrade.

The upgrade process follows the standard Ghost update procedure. Remember to back up your database before upgrading.

Bug Fixes

• Fixed editor undo states for card contents in the admin interface
• Fixed frame context being empty

New Features

Content API v2 Enhancements

• New oEmbed controller added to v2 API
• New Slack controller added to v2 admin API
• Authors endpoint now available in Content API v2 (renamed from /users)
• Date formatting improvements with UTC offset added to dates returned by Content API
• Relative paths in HTML returned by default in Content API V2 (with optional absolute URLs via ?absolute_urls=true parameter)
• New helper to check if API called is content API
• Extended resource lookup in {{get}} helper to support authors

Admin UI Improvements

• Alphabetical sorting for tags list, filter dropdown, and select inputs

Security Updates

No specific security fixes were mentioned in this release. However, pinning Node.js to version ^10.13.0 or higher may include security improvements as this was an LTS release with security updates.

Performance Improvements

No specific performance improvements were mentioned in this release.

Impact Summary

Ghost 2.5.0 represents a significant step in the evolution of the Content API v2, introducing several breaking changes that prepare the platform for a more robust API experience. The renaming of endpoints, removal of unused features, and improved date formatting all contribute to a more consistent and developer-friendly API.

The pinning of Node.js to version 10.13.0 or higher ensures better security and stability for self-hosted installations, while the UI improvements in the admin interface enhance the content editing experience with better organization of tags and filters.

This release primarily impacts developers working with the Ghost API, particularly those using the Content API v2. The breaking changes are substantial but necessary for the platform's evolution. Content editors will benefit from bug fixes and UI improvements, making their workflow more efficient.

Overall, Ghost 2.5.0 balances platform improvements with developer experience, setting the stage for the official announcement of Content API v2 in the future.

Full Release Notes