HomeContent Toolkit Logo

Content Toolkit

Home

>

Tools

>

Payload CMS

>

Releases

>

Release 1.8.3-canary.2

Payload CMS Release: Release 1.8.3-canary.2

Pre Release

Tag Name: v1.8.3-canary.2

Release Date: 5/22/2023

View Release
Payload CMS LogoPayload CMS

Payload CMS is a modern, self-hosted headless content management system built with TypeScript, Node.js, and MongoDB. It's designed specifically for developers who want full control over their content management system while maintaining a powerful admin interface for content editors.

Open SourceDeveloper-FriendlyHeadless

TL;DR

Payload CMS v1.8.3-canary.2 Release

This canary release primarily focuses on fixing a bug related to null relation validation and enhancing documentation. The key fix ensures that null relations are now safely validated, preventing potential errors when dealing with empty relationship fields. Additionally, the release includes several documentation improvements for REST API examples and configuration options.

This is a maintenance release that improves stability and documentation without introducing breaking changes.

Highlight of the Release

    • Fixed bug with null relation validation to prevent errors
    • Enhanced REST API documentation with additional examples
    • Added missing admin.group property documentation in configuration/globals
    • Improved documentation for find operation parameters in REST API

Migration Guide

No migration is required for this canary release as it contains a bug fix and documentation improvements that don't affect existing functionality.

Upgrade Recommendations

If you're currently using v1.8.3-canary.1 and experiencing issues with null relation validation, it's recommended to upgrade to this version.

For production environments, it's generally advised to wait for the stable v1.8.3 release unless you specifically need the fix for null relation validation.

To upgrade:

npm install [email protected]
# or
yarn add [email protected]

Bug Fixes

Null Relation Validation Fix

This release addresses an issue with relation field validation. Previously, there could be problems when validating null values in relationship fields, potentially causing errors or unexpected behavior. The fix ensures that null relations are now safely validated, improving the stability of the system when dealing with empty relationship fields.

fix: safely validates null relations

This change helps prevent potential errors when processing data where relationship fields might be null or undefined.

New Features

No new features were introduced in this canary release. This is primarily a bug fix and documentation improvement release.

Security Updates

No security fixes were included in this release.

Performance Improvements

No specific performance improvements were included in this release.

Impact Summary

This is a minor canary release with low impact, primarily focused on fixing a bug related to null relation validation and improving documentation. The bug fix ensures more stable behavior when dealing with empty relationship fields, which could prevent potential errors in applications that use relation fields.

The documentation improvements enhance the developer experience by providing more comprehensive REST API examples and clarifying configuration options. These changes don't affect existing functionality but make it easier for developers to understand and use Payload CMS effectively.

Overall, this release represents incremental improvements to stability and documentation without introducing any breaking changes or significant new features.

Full Release Notes

Statistics:

File Changed6
Line Additions531
Line Deletions60
Line Changes591
Total Commits9

User Affected:

  • Benefit from more stable relation field validation that properly handles null values
  • Access to improved REST API documentation with more examples
  • Better understanding of configuration options with updated documentation

Contributors:

DanRibbensjessrynkarqbeauperinjmikrut