Skip to content

Commit f66dd61

Browse files
chore: directs attention to breaking changes headings
1 parent 3c70a15 commit f66dd61

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

CHANGELOG.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ If you are not using TypeScript, this will be a breaking change. There are many
2626

2727
For instructions regarding how to migrate to TS, [review the PR here](https://github.com/payloadcms/payload/pull/1847).
2828

29-
#### Payload `init` is now always async, and `payload.initAsync` has been removed
29+
#### Payload `init` is now always async, and `payload.initAsync` has been removed
3030

3131
We are pulling off a bandaid here and enforcing that `payload.init` is now asynchronous across the board. This will help prevent issues in the future and allow us to do more advanced things within `init` down the road. But this will be a breaking change if your project uses `payload.init` right now.
3232

@@ -78,7 +78,7 @@ start();
7878

7979
Notice that all we've done is wrapped the `payload.init` and `app.listen` calls with a `start` function that is asynchronous.
8080

81-
#### All Local API methods are no longer typed as generics, and instead will infer types for you automatically
81+
#### All Local API methods are no longer typed as generics, and instead will infer types for you automatically
8282

8383
Before this release, the Local API methods were configured as generics. For example, here is an example of the `findByID` method prior to this release:
8484

@@ -119,7 +119,7 @@ But there's one more thing to do before Payload can automatically type your Loca
119119

120120
Then go regenerate your types. We've extended the `payload generate:types` method a bit to be more complete. Upon regenerating types, you'll see a new `Config` export at the top of the file which contains a key - value pair of all your collection and global types, which Payload will automatically import.
121121

122-
#### Versions may need to be migrated
122+
#### Versions may need to be migrated
123123

124124
This release includes a substantial simplification / optimization of how Versions work within Payload. They are now significantly more performant and easier to understand behind-the-scenes. We've removed ~600 lines of code and have ensured that Payload can be compatible with all flavors of Mongo - including versions earlier than 4.0, Azure Cosmos MongoDB, AWS' DocumentDB and more.
125125

@@ -210,7 +210,7 @@ Make sure your environment variables match the script's values above and then ru
210210

211211
This migration script will ensure that there is at least one corresponding version for each of your draft-enabled documents. It won't modify or delete any of your existing documents at all.
212212

213-
### Example of a properly migrated project
213+
### 👀 Example of a properly migrated project
214214

215215
For an example of how everything works with this update, go ahead and run `npx create-payload-app`. We've updated `create-payload-app` to reflect all the necessary changes here and you can use a new project to compare / contrast what you have in your current project with what Payload needs now in this release.
216216

0 commit comments

Comments
 (0)