Bootstrap 2.0 migration docs for pydantic 2.0 change

Author: Kircheneer

CHANGELOG.md

@@ -1,6 +1,16 @@
 # Changelog
 
-## v1.10.0 - 2023-11-16
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## [2.0.0]
+
+### Changed
+
+- **BREAKING CHANGE** #236/240 - Upgrade to Pydantic v2. 
+
+## [1.10.0] - 2023-11-16
 
 ### Fixed
 
@@ -11,7 +21,7 @@
 
 - #247 - Deprecates Python 3.7
 
-## v1.9.0 - 2023-10-16
+## [1.9.0] - 2023-10-16
 
 ### Added
 
@@ -21,7 +31,7 @@
 
 - #219 - Type hinting overhaul 
 
-## v1.8.0 - 2023-04-18
+## [1.8.0] - 2023-04-18
 
 ### Added
 
@@ -34,7 +44,7 @@
 - #77/#188 - `sync_from()` and `sync_to()` now return the `Diff` that was applied.
 - #211 - Loosened `packaging` and `structlog` library dependency constraints for broader compatibility.
 
-## v1.7.0 - 2022-11-03
+## [1.7.0] - 2022-11-03
 
 ### Changed
 
@@ -52,15 +62,15 @@
 
 ### Fixed
 
-- #149 Limit redundant CI concurrency
+- #149 - Limit redundant CI concurrency
 
-## v1.6.0 - 2022-07-09
+## [1.6.0] - 2022-07-09
 
 ### Changed
 
 - #120 - Dropped support for Python 3.6, new minimum is Python 3.7
 
-## v1.5.1 - 2022-06-30
+## [1.5.1] - 2022-06-30
 
 ### Added
 
@@ -75,13 +85,13 @@
 - #115 - Fixed ReadTheDocs rendering pipeline
 - #118 - Fixed a regression in `DiffSync.get(modelname, identifiers)` introduced in 1.5.0
 
-## v1.5.0 - 2022-06-07
+## [1.5.0] - 2022-06-07
 
 ### Added
 
 - #106 - Add a new, optional, backend store based in Redis
 
-## v1.4.3 - 2022-03-03
+## [1.4.3] - 2022-03-03
 
 ### Fixed
 
@@ -91,25 +101,25 @@
 
 ### Changed
 
-- #103 Update development dependencies
+- #103 - Update development dependencies
 
-## v1.4.2 - 2022-02-28
+## [1.4.2] - 2022-02-28
 
 **WARNING** - #90 inadvertently introduced a breaking API change in DiffSync 1.4.0 through 1.4.2 (#101); this change was reverted in #102 for DiffSync 1.4.3 and later. We recommend not using this release, and moving to 1.4.3 instead.
 
 ### Fixed
 
 - #100 - Added explicit dependency on `packaging`.
 
-## v1.4.1 - 2022-01-26
+## [1.4.1] - 2022-01-26
 
 **WARNING** - #90 inadvertently introduced a breaking API change in DiffSync 1.4.0 through 1.4.2 (#101); this change was reverted in #102 for DiffSync 1.4.3 and later. We recommend not using this release, and moving to 1.4.3 instead.
 
 ### Fixed
 
 - #95 - Removed optional dependencies on `sphinx`, `m2r2`, `sphinx-rtd-theme`, `toml`.
 
-## v1.4.0 - 2022-01-24
+## [1.4.0] - 2022-01-24
 
 **WARNING** - #90 inadvertently introduced a breaking API change in DiffSync 1.4.0 through 1.4.2 (#101); this change was reverted in #102 for DiffSync 1.4.3 and later. We recommend not using this release, and moving to 1.4.3 instead.
 
@@ -138,19 +148,19 @@
 - #51 - Update minimum Pydantic version due to security advisory GHSA-5jqp-qgf6-3pvh
 - #63 - Fix type in Readme
 
-## v1.3.0 - 2021-04-07
+## [1.3.0] - 2021-04-07
 
 ### Added
 
 - #48 - added optional `callback` argument to `diff_from`/`diff_to`/`sync_from`/`sync_to` for use with progress reporting.
 
-## v1.2.0 - 2020-12-08
+## [1.2.0] - 2020-12-08
 
 ### Added
 
 - #45 - minimum Python version lowered from 3.7 to 3.6, also now tested against Python 3.9.
 
-## v1.1.0 - 2020-12-01
+## [1.1.0] - 2020-12-01
 
 ### Added
 
@@ -168,6 +178,6 @@
 
 - #44 - On CRUD failure, do not generate an extraneous "success" log message in addition to the "failed" message
 
-## v1.0.0 - 2020-10-23
+## [1.0.0] - 2020-10-23
 
 Initial release

docs/source/getting_started/index.rst

@@ -1,5 +1,5 @@
-###############
-Getting Started
-###############
+#########
+Upgrading
+#########
 
 .. mdinclude:: 01-getting-started.md

docs/source/index.rst

@@ -9,6 +9,7 @@ Welcome to DiffSync's documentation!
    getting_started/index
    core_engine/index
    examples/index
+   upgrading/index
    api/diffsync
    license/index
 

docs/source/upgrading/01-upgrading-to-2.0.md

@@ -0,0 +1,31 @@
+# Upgrading to 2.0
+
+With diffsync 2.0, there a couple of breaking changes. What they are and how to deal with them is described in this document.
+
+## Upgrade to Pydantic's major version 2
+
+A [migration guide](https://docs.pydantic.dev/latest/migration/) is available in the Pydantic documentation. Here are the key things that may apply to your usage of diffsync:
+
+- Any fields that are of type `Optional` now need to provide an explicit `None` default (you can use [bump-pydantic](https://github.com/pydantic/bump-pydantic) to deal with this automatically for the most part)
+
+```python
+from typing import Optional
+
+from diffsync import DiffSyncModel
+
+# Before
+class Person(DiffSyncModel):
+    _identifiers = ("name",)
+    _attributes = ("age",)
+
+    name: str
+    age: Optional[int]
+
+# After
+class BetterPerson(DiffSyncModel)
+    _identifiers = ("name",)
+    _attributes = ("age",)
+
+    name: str
+    age: Optional[int] = None
+```

docs/source/upgrading/index.rst

@@ -0,0 +1,5 @@
+#########
+Upgrading
+#########
+
+.. mdinclude:: 01-upgrading-to-2.0.md