Skip to content

Commit

Permalink
Release notes for 2021-08-17 release (#6345)
Browse files Browse the repository at this point in the history
* New release notes.

* Update index.tsx

* Update 2021-08-17.mdx

* Update next-env.d.ts

* Update index.mdx

* Update 2021-08-17.mdx
  • Loading branch information
bladey authored Aug 17, 2021
1 parent 14861b4 commit 712bea2
Show file tree
Hide file tree
Showing 4 changed files with 120 additions and 19 deletions.
3 changes: 3 additions & 0 deletions docs/next-env.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,6 @@
/// <reference types="next" />
/// <reference types="next/types/global" />
/// <reference types="next/image-types/global" />

// NOTE: This file should not be edited
// see https://nextjs.org/docs/basic-features/typescript for more information.
74 changes: 74 additions & 0 deletions docs/pages/releases/2021-08-17.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
import { Markdown, getStaticProps } from '../../components/Markdown';
import { Emoji } from '../../components/primitives/Emoji';

# 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** <Emoji symbol="🎉" alt="Celebration" /> <Emoji symbol="" alt="Sparkles" />
- Enhancements to Custom Admin UI Pages
- Better deletion notifications
- And more…

**⚠️ &nbsp; This release contains breaking changes, please see below!**

```json
"@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 <Emoji symbol="" alt="Sparkles" />

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](https://keystonejs.com/updates/new-graphql-api) to the improvements we've made, and it includes [a checklist of the steps you need to take to upgrade your Keystone projects](https://keystonejs.com/updates/new-graphql-api#upgrade-checklist). Be sure to check it out!

!> <Emoji symbol="💡" alt="Lightbulb" /> While there are a lot of changes to this API, if you approach the upgrade process systematically your experience should be pretty smooth. If you get stuck or have questions, reach out to us in the [Keystone community slack](https://community.keystonejs.com) to get the help you need.

<img width="1091" alt="Screen Shot 2021-08-17 at 11 28 56 am" src="https://user-images.githubusercontent.com/737821/129649252-ababdd69-2649-4027-9189-c8f908e59946.png" />

## Custom Admin UI Pages <Emoji symbol="📃" alt="Paper" />

Our [Custom Admin UI Pages](https://keystonejs.com/docs/guides/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!

<img width="1091" alt="Screen Shot 2021-08-17 at 11 30 39 am" src="https://user-images.githubusercontent.com/737821/129649357-c292252a-f202-449d-a7e1-b0f765738b0b.png" />

## Improved Deletion Notifications <Emoji symbol="🗑" alt="Trashcan" />

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.

<img width="1091" alt="Screen Shot 2021-08-17 at 11 04 47 am" src="https://user-images.githubusercontent.com/737821/129647660-32d421f4-a060-4b65-b17d-c446149906ee.png" />

## Deeper GraphQL Errors <Emoji symbol="🚧" alt="Roadblock" />

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 <Emoji symbol="⬆️" alt="Arrow up" />

Updated Prisma dependencies from `2.27.0` to `2.29.0`, check out the [Prisma releases page](https://github.com/prisma/prisma/releases/tag/2.29.0) for more details.

## Credits <Emoji symbol="💫" alt="Swirling star" />

Added option for `Bearer` token auth when using session, thanks to [@gautamsi](https://github.com/gautamsi)!

You can also view the [verbose release notes](https://github.com/keystonejs/keystone/releases/tag/2021-08-17) on GitHub.

export default ({ children, ...props }) => <Markdown description="A major milestone in the path to a General Availability status for Keystone 6." {...props}>{children}</Markdown>;
export { getStaticProps }
40 changes: 22 additions & 18 deletions docs/pages/releases/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,75 +4,79 @@ import { Status } from '../../components/primitives/Status';

# Release Notes

## 29th July 2021
## 17th August 2021

<Status look="latestRelease" />

Custom **navigation**, **pages** and **logo** in this big **Admin UI** themed release! <Emoji symbol="🎛️" alt="Control knobs" /> — [read more](/releases/2021-07-29)
A **major milestone** in the path to a General Availability status for Keystone 6 this release includes ** new and improved GraphQL API** and more. <Emoji symbol="" alt="Sparkles" /> — [Read more](/releases/2021-08-17)

## 29th July 2021

Custom **navigation**, **pages** and **logo** in this big **Admin UI** themed release! <Emoji symbol="🎛️" alt="Control knobs" /> — [Read more](/releases/2021-07-29)

## 13th July 2021

More examples, types, and UI rendering tweaks as we push forward towards a general availability release! <Emoji symbol="🚀" alt="Rocket" /> — [read more](/releases/2021-07-13)
More examples, types, and UI rendering tweaks as we push forward towards a general availability release! <Emoji symbol="🚀" alt="Rocket" /> — [Read more](/releases/2021-07-13)

## 30th June 2021

We fixed an issue with `cloudinaryImage` and `relationship` fields. <Emoji symbol="🔥" alt="Fire" /> — [read more](/releases/2021-06-30)
We fixed an issue with `cloudinaryImage` and `relationship` fields. <Emoji symbol="🔥" alt="Fire" /> — [Read more](/releases/2021-06-30)

## 29th June 2021

The ID Field option has been revamped with `cuid`, `uuid` and `autoincrement` options! <Emoji symbol="🤹" alt="Juggler" /> — [read more](/releases/2021-06-29)
The ID Field option has been revamped with `cuid`, `uuid` and `autoincrement` options! <Emoji symbol="🤹" alt="Juggler" /> — [Read more](/releases/2021-06-29)

## 28th June 2021

A new package to help test the behaviour of your GraphQL API, a document field example, better error messages, accessibility updates and another Prisma update! <Emoji symbol="🍱" alt="Bento box" /> — [read more](/releases/2021-06-28)
A new package to help test the behaviour of your GraphQL API, a document field example, better error messages, accessibility updates and another Prisma update! <Emoji symbol="🍱" alt="Bento box" /> — [Read more](/releases/2021-06-28)

## 15th June 2021

Keystone Next now has a new core <Emoji symbol="🤖" alt="Robot" />, unblocking many of the features you’ve been waiting for! — [read more](/releases/2021-06-15)
Keystone Next now has a new core <Emoji symbol="🤖" alt="Robot" />, unblocking many of the features you’ve been waiting for! — [Read more](/releases/2021-06-15)

## 2nd June 2021

We have a new JSON field <Emoji symbol="" alt="Sparkle"/>, a bunch of new learning resources, and plenty of under the hood optimisations in this big release. <Emoji symbol="💪" alt="Strong"/> — [read more](/releases/2021-06-02)
We have a new JSON field <Emoji symbol="" alt="Sparkle"/>, a bunch of new learning resources, and plenty of under the hood optimisations in this big release. <Emoji symbol="💪" alt="Strong"/> — [Read more](/releases/2021-06-02)

## 19th May 2021

Node updates and Admin UI has moved! <Emoji symbol="🚚" alt="Truck"/> — [read more](/releases/2021-05-19)
Node updates and Admin UI has moved! <Emoji symbol="🚚" alt="Truck"/> — [Read more](/releases/2021-05-19)

## 17th May 2021

Apollo caching can now be configured for performance <Emoji symbol="🔥" alt="fire"/> and a basic authentication example to get your started <Emoji symbol="🔒" alt="Lock"/> — [read more](/releases/2021-05-17)
Apollo caching can now be configured for performance <Emoji symbol="🔥" alt="fire"/> and a basic authentication example to get your started <Emoji symbol="🔒" alt="Lock"/> — [Read more](/releases/2021-05-17)

## 11th May 2021

A bunch of admin UI tweaks in this release <Emoji symbol="🖥️" alt="Monitor" />, among other minor fixes — [read more](/releases/2021-05-11)
A bunch of admin UI tweaks in this release <Emoji symbol="🖥️" alt="Monitor" />, among other minor fixes — [Read more](/releases/2021-05-11)

## 5th May 2021

Aside from dependency updates <Emoji symbol="😴" alt="Sleepy"/>, we added an `isIndexed` config option to the `text`, `integer`, `float`, `select`, and `timestamp` field types — [read more](/releases/2021-05-05)
Aside from dependency updates <Emoji symbol="😴" alt="Sleepy"/>, we added an `isIndexed` config option to the `text`, `integer`, `float`, `select`, and `timestamp` field types — [Read more](/releases/2021-05-05)

## 3rd May 2021

Files in Keystone Next <Emoji symbol="📁" alt="Folder"/>! This release involved a bunch of busywork behind the scenes in Keystone Next <Emoji symbol="🔧" alt="Tool"/> — [read more](/releases/2021-05-03)
Files in Keystone Next <Emoji symbol="📁" alt="Folder"/>! This release involved a bunch of busywork behind the scenes in Keystone Next <Emoji symbol="🔧" alt="Tool"/> — [Read more](/releases/2021-05-03)

## 20th April 2021

Improvements to the Lists API, deprecating `resolveFields` <Emoji symbol="🔧" alt="Tool"/> — [read more](/releases/2021-04-20)
Improvements to the Lists API, deprecating `resolveFields` <Emoji symbol="🔧" alt="Tool"/> — [Read more](/releases/2021-04-20)

## 6th April 2021

Controlled code demolition <Emoji symbol="🏗️" alt="Construction"/> <Emoji symbol="👷‍♀️" alt="Worker"/>, Better pagination in Admin UI <Emoji symbol="⏭️" alt="Skip" /> — [read more](/releases/2021-04-06)
Controlled code demolition <Emoji symbol="🏗️" alt="Construction"/> <Emoji symbol="👷‍♀️" alt="Worker"/>, Better pagination in Admin UI <Emoji symbol="⏭️" alt="Skip" /> — [Read more](/releases/2021-04-06)

## 30th March 2021

Goodbye legacy code <Emoji symbol="👋" alt="Wave"/> <Emoji symbol="🌇" alt="Picture"/>, Improved `select` field type <Emoji symbol="🔽" alt="Dropdown"/>, Squashed bugs <Emoji symbol="🐛" alt="Bug"/> — [read more](/releases/2021-03-30)
Goodbye legacy code <Emoji symbol="👋" alt="Wave"/> <Emoji symbol="🌇" alt="Picture"/>, Improved `select` field type <Emoji symbol="🔽" alt="Dropdown"/>, Squashed bugs <Emoji symbol="🐛" alt="Bug"/> — [Read more](/releases/2021-03-30)

## 23rd March 2021

Added support for SQLite with Prisma <Emoji symbol="🎉" alt="Celebration"/>, Noteworthy bug-squashing <Emoji symbol="🐛" alt="Bug"/> — [read more](/releases/2021-03-23)
Added support for SQLite with Prisma <Emoji symbol="🎉" alt="Celebration"/>, Noteworthy bug-squashing <Emoji symbol="🐛" alt="Bug"/> — [Read more](/releases/2021-03-23)

## 22nd March 2021

Prisma migrations <Emoji symbol="🚚" alt="Truck"/>, Noteworthy bug-squashing <Emoji symbol="🐛" alt="Bug"/> — [read more](/releases/2021-03-22)
Prisma migrations <Emoji symbol="🚚" alt="Truck"/>, Noteworthy bug-squashing <Emoji symbol="🐛" alt="Bug"/> — [Read more](/releases/2021-03-22)

<br/>

Expand Down
22 changes: 21 additions & 1 deletion docs/pages/updates/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { Alert } from '../../components/primitives/Alert';
import { Type } from '../../components/primitives/Type';
import { DocsPage } from '../../components/Page';
import { ArrowR } from '../../components/icons/ArrowR';
import { Emoji } from '../../components/primitives/Emoji';
import { useMediaQuery } from '../../lib/media';

type TimelineProps = {
Expand Down Expand Up @@ -165,7 +166,26 @@ export default function WhatsNew() {
gap: 0,
})}
>
<Timeline date="29th July 2021" isLatest />
<Timeline date="17th August 2021" isLatest />
<Box heading="A new and improved GraphQL API">
A major milestone in the path to a <InlineCode>General Availability</InlineCode> status
for <strong>Keystone 6</strong>, we've just released a new and improved GraphQL API.{' '}
<Emoji symbol="🎉" alt="Celebration" />
<br />
<br />
We’ve made the experience of working with Keystone’s GraphQL API easier to program and
reason about: We've{' '}
<a href="https://keystonejs.com/updates/new-graphql-api">written a complete guide</a> to
the improvements we've made, and it includes a{' '}
<a href="https://keystonejs.com/updates/new-graphql-api#upgrade-checklist">
checklist of the steps you need to take to upgrade your Keystone projects
</a>
.
<br />
<br />
Be sure to check it out!
</Box>
<Timeline date="29th July 2021" />
<Box heading="Admin UI Customizations">
We're opening Admin UI up to support a more personal content experience. Now you can:
<ul>
Expand Down

1 comment on commit 712bea2

@vercel
Copy link

@vercel vercel bot commented on 712bea2 Aug 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.