From 2add9506153a10f54b5fd29b6daad6018b96da21 Mon Sep 17 00:00:00 2001 From: Antoine Jeannot Date: Mon, 15 Jan 2024 16:37:32 +0100 Subject: [PATCH] docs: update docs relative to the new stable release --- docs/migration.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/migration.md b/docs/migration.md index 3f79d1d7..36878029 100644 --- a/docs/migration.md +++ b/docs/migration.md @@ -7,14 +7,14 @@ Modelkit 0.1 and onwards will be shipped with `pydantic 2`, which comes with __s Details on how to migrate to `pydantic 2` are available in the corresponding migration guide: https://docs.pydantic.dev/latest/migration/ ### Installation -To install and try out the `modelkit 0.1.0.bX` beta before its stable release: +To install the brand new stable release of modelkit: ``` -pip install --pre modelkit +pip install modelkit --upgrade ``` ### Known breaking changes -Some breaking changes are arising while upgrading to `pydantic 2` and the new `modelkit 0.1 beta`. Here is a brief, rather exhaustive, list of the encountered issues or dropped features. +Some breaking changes are arising while upgrading to `pydantic 2` and the new `modelkit 0.1`. Here is a brief, rather exhaustive, list of the encountered issues or dropped features. #### Drop: implicit pydantic model conversion @@ -57,7 +57,7 @@ Fixes: None, just prepare to have your inputs / outputs validated :) ### Development Workflows -The beta release, along with subsequent patches, will be pushed to the main branch. Prior to the stable release, tags will adopt the format `0.1.0.bX` +`modelkit 0.1` (and forward) changes will be pushed to the main branch. For projects that have not migrated, `modelkit 0.0` will continue to receive maintenance on the `v0.0-maintenance` branch. Releases on PyPI and manual tags will adhere to the usual process.