Payload CMS Release: 3.15.0

TL;DR

Payload CMS v3.15.0 brings significant improvements with new features like sub-task support in workflows, query parameter pass-through for document views, and preference reset functionality. This release includes important bug fixes for PostgreSQL migrations, UI improvements, and enhanced TypeScript support. It also addresses issues with the rich text editor, relationship fields, and storage adapters, making the CMS more robust and developer-friendly.

Highlight of the Release

• Added support for running sub-tasks from within tasks for more complex workflow automation
• Improved UI with preference reset functionality and better handling of relationship fields
• Fixed PostgreSQL migration issues with proper schema name handling
• Enhanced TypeScript support with better type definitions and strict mode compatibility
• Added warning when deploying to Vercel without proper storage adapters configured

Migration Guide

Upgrading from v3.14.0 to v3.15.0

This release doesn't contain breaking changes, so upgrading should be straightforward:

1. Update your Payload dependencies:

   npm install @payloadcms/[email protected]
   # Update any other Payload packages you're using
   npm install @payloadcms/[email protected] @payloadcms/[email protected]
   

2. If you're using PostgreSQL:

   • The release includes fixes for PostgreSQL migrations, particularly for non-default schemas
   • If you experienced issues with migrations in previous versions, this update should resolve them

3. If you're deploying to Vercel:

   • Be aware that the CMS now warns if you have upload collections without storage adapters
   • Consider implementing a proper storage adapter like @payloadcms/plugin-cloud-storage

4. For TypeScript users:

   • The release includes improved type definitions, particularly for strict mode
   • If you were using workarounds for type issues, you may be able to remove them now

Upgrade Recommendations

This release is recommended for all users as it contains numerous bug fixes and quality-of-life improvements without introducing breaking changes.

Priority: Medium

• For PostgreSQL users: High priority if you've experienced migration issues
• For Vercel deployments: Medium-high priority for the improved storage adapter warnings
• For TypeScript developers: Medium priority for improved type definitions

The upgrade process should be straightforward with minimal risk, as this is primarily a maintenance and enhancement release.

Bug Fixes

Database Fixes

• Fixed PostgreSQL migration issues by adding missing schema name and quotes to SQL statements
• Improved handling of undefined schema name fallbacks in relationships migration
• Fixed issues with localized arrays and blocks by generating new IDs to prevent errors in PostgreSQL

UI Improvements

• Fixed relationship fields not updating correctly when collection is changed in drawer dropdown
• Ensured list drawer does not change underlying step navigation
• Fixed issue where sorting would reset column preferences
• Properly reflects hook changes in UI after document updates
• Fixed drawer component styling with missing closing bracket

Rich Text Editor Fixes

• Fixed formatted inline code resulting in incorrect markdown export
• Made rich text div container optional for better component reuse
• Fixed issue with opening inline block drawer on mount
• Improved JSX converter function type to support block types in strict mode

Other Fixes

• Fixed handling of withoutEnlargement for undefined height or width in image resizing
• Added proper handling of path in server field component prop types
• Fixed Vercel Blob storage adapter to return 404 when file is not found instead of 500
• Ensured .env and .env.example file modifications occur before git initialization in CPA
• Extended type all to the locale type definition in request objects
• Improved safety of findConfig to handle undefined paths

New Features

Task Enhancements

• Added support for running sub-tasks from within tasks, allowing for more complex workflow automation
• Sub-tasks are properly tracked in job logs with parent-child relationships

Query Parameter Support

• Document view now passes through query parameters to find operations
• Makes query parameters accessible in hooks, enabling features like custom branch selectors

Preference Management

• Added support for resetting user preferences via the admin UI
• New button in the account view allows users to reset preferences without database access

Vercel Deployment Warning

• Added warning when deploying to Vercel with upload collections missing storage adapters
• Helps prevent common deployment issues with file uploads

Security Updates

No significant security fixes were included in this release.

Performance Improvements

Type System Improvements

• Enhanced TypeScript support with better type definitions
• Added support for strict mode in JSX converter functions
• Exported RunInlineTaskFunction type for better developer experience

UI Performance

• Improved handling of column preferences and sorting to prevent unnecessary resets
• Better management of form state to properly reflect server-side changes

React Compatibility

• Loosened React peer dependencies in live-preview-react package to support React v16.8.0 or later
• Removed instances of React.forwardRef in templates and examples, simplifying component types

Impact Summary

Payload CMS v3.15.0 is a feature-rich maintenance release that enhances developer experience and fixes numerous bugs. The addition of sub-tasks in workflows enables more complex automation scenarios, while improvements to the UI address several pain points for content editors, particularly around relationship fields and preference management.

PostgreSQL users will benefit from critical fixes to migration scripts, especially those using non-default schemas. The improved TypeScript support enhances developer productivity with better type definitions and strict mode compatibility.

The warning system for Vercel deployments without proper storage adapters will help prevent a common deployment issue, saving developers troubleshooting time. React compatibility improvements in the live-preview package make it more versatile across different React versions.

Overall, this release represents a solid improvement to Payload's stability, usability, and developer experience without introducing breaking changes.

Full Release Notes