Skip to Page NavigationSkip to Page NavigationSkip to Content
Keystone 6 is in Community Preview! For Keystone 5 docs visit v5.keystonejs.com
Keystone 6preview
Why KeystoneUpdatesDocumentation
Edit on GitHub

Release: 17th August 2021

A major milestone in the path to a General Availability status for Keystone 6, this release includes:

  • A new and improved GraphQL API 🎉 ✨
  • Enhancements to Custom Admin UI Pages
  • Better deletion notifications
  • And more…

⚠️   This release contains breaking changes, please see below!

"@keystone-ui/notice": "4.0.1",
"@keystone-ui/segmented-control": "4.0.2",
"@keystone-ui/toast": "4.0.2",
"@keystone-next/admin-ui-utils": "5.0.6",
"@keystone-next/auth": "31.0.0",
"@keystone-next/cloudinary": "6.0.6",
"@keystone-next/fields": "14.0.0",
"@keystone-next/fields-document": "8.0.0",
"@keystone-next/keystone": "24.0.0",
"@keystone-next/testing": "1.1.1",
"@keystone-next/types": "24.0.0",
"@keystone-next/utils": "1.0.4",

A new & improved GraphQL API ✨

We’ve made the experience of working with Keystone’s GraphQL API easier to program and reason about:

  • Queries: the names of top-level queries are now easier to understand. We also removed deprecated and unused legacy features.
  • Filters: the arguments used in queries have been updated to accept a filter object for each field, rather than having all the filter options available at the top level.
  • Mutations: all generated CRUD mutations have the same names and return types, but their inputs have changed.
  • Input Types: we’ve updated the input types used for relationship fields in update and create operations, removing obsolete options and making the syntax between the two operations easier to differentiate.

Upgrade guidance

We've written a complete guide to the improvements we've made, and it includes a checklist of the steps you need to take to upgrade your Keystone projects. Be sure to check it out!

💡 While there are a lot of changes to this API, we've put a lot of effort into making the upgrade process as smooth as possible. If you get stuck or have questions, reach out to us in the Keystone community slack to get the help you need.

Screen Shot 2021-08-17 at 11 28 56 am

Custom Admin UI Pages 📃

Our Custom Admin UI Pages guide has been expanded, with an example to make your custom pages look more like the Admin UI, as well as adding links to your custom pages from the Admin UI Navigation!

Screen Shot 2021-08-17 at 11 30 39 am

Improved Deletion Notifications 🗑

When items are deleted via the Admin UI, we now display all the items that were successfully deleted, and any that failed, instead of displaying multiple notifications without any context.

Screen Shot 2021-08-17 at 11 04 47 am

Deeper GraphQL Errors 🚧

A config.graphql.debug option has been added, which can be used to control whether debug information such as stack traces are included in the errors returned by the GraphQL API.

Prisma Update ⬆️

Updated Prisma dependencies from 2.27.0 to 2.29.0, check out the Prisma releases page for more details.

Credits 💫

Added option for Bearer token auth when using session, thanks to @gautamsi!

You can also view the verbose release notes on GitHub.

On this page