Add migration guide

griptape-ai · Aug 26, 2024 · 1ea6e00 · 1ea6e00
1 parent e18db16
commit 1ea6e00
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 - Parsing streaming response with some OpenAi compatible services.
 
+**Note**: This release includes breaking changes. Please refer to the [Migration Guide](MIGRATION.md#0.31.0) for details.
+
 ## [0.30.1] - 2024-08-21
 
 ### Fixed

diff --git a/MIGRATION.md b/MIGRATION.md
@@ -0,0 +1,5 @@
+# Migration Guide
+
+This document provides instructions for migrating your codebase to accommodate breaking changes introduced in new versions of Griptape.
+
+## 0.30.X -> 0.31.X