Payload CMS Release: 3.15.1

TL;DR

Payload CMS v3.15.1 is a maintenance release that addresses three important bug fixes: a fix for the Vercel upload adapter warning that was showing false positives, deprecation of the admin.disable property in favor of Next.js directory-based configuration, and a fix for default arguments in the normalizeMarkdown function in the rich text editor. This release improves stability and provides clearer guidance for configuring admin panel and API access.

Highlight of the Release

• Fixed false positive warnings in the Vercel upload adapter
• Deprecated admin.disable property in favor of Next.js directory-based configuration
• Fixed default argument handling in normalizeMarkdown function for the rich text editor

Migration Guide

Migrating from admin.disable Property

If you were previously using the admin.disable property to opt out of serving the Admin Panel, REST API, or GraphQL API, you should now use the Next.js directory-based approach:

1. To opt out of everything: Delete the /app/(payload) directory entirely.

2. To remove only the Admin Panel: Delete the /app/(payload)/admin directory.

3. To remove only API routes: Delete the /app/(payload)/api directory.

Note: If you've modified the default paths for these routes via admin.routes, you should delete those custom directories instead.

Upgrade Recommendations

This is a bug fix release that addresses several issues. It's recommended that all users of Payload CMS v3.15.0 upgrade to v3.15.1, especially if you:

1. Use the Vercel upload adapter
2. Have been using the deprecated admin.disable property
3. Work with markdown content in the rich text editor

The upgrade should be straightforward with no breaking changes introduced.

Bug Fixes

Fixed Vercel Upload Adapter Warning

The logic for warning messages in the Vercel upload adapter has been adjusted to prevent false positive warnings that were previously occurring. This ensures developers only receive warnings when there are actual issues to address (#10434).

Deprecated admin.disable Property

The admin.disable property has been officially deprecated as it's no longer supported in v3. This addresses issue #10284. The fix provides clear documentation on the new approach for opting out of serving the Admin Panel, REST API, or GraphQL API using Next.js directory structure.

Fixed Rich Text Markdown Normalization

A bug in the normalizeMarkdown function within the rich text Lexical editor has been fixed. The issue involved inconsistent default argument values where one function used true as the default while a nested function used false. This resolves issue #10387 and ensures consistent behavior when normalizing markdown content.

New Features

No new features were introduced in this maintenance release.

Security Updates

No security fixes were included in this release.

Performance Improvements

No specific performance improvements were included in this release.

Impact Summary

Payload CMS v3.15.1 is a maintenance release that focuses on bug fixes and compatibility improvements. The most significant change is the official deprecation of the admin.disable property, which requires developers to adopt the Next.js directory-based approach for controlling which components of Payload are served. This aligns better with the Next.js app router architecture used in Payload v3.

The fix for the Vercel upload adapter eliminates false positive warnings that may have been confusing for developers. Additionally, the fix for the normalizeMarkdown function ensures more consistent behavior when working with markdown content in the rich text editor.

While this release doesn't introduce new features or performance improvements, it enhances the stability and developer experience of Payload CMS, particularly for those working with Next.js integration, Vercel deployments, or rich text content.

Full Release Notes