Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add migration guide #1108

Merged
merged 1 commit into from
Aug 26, 2024
Merged

Add migration guide #1108

merged 1 commit into from
Aug 26, 2024

Conversation

collindutter
Copy link
Member

Describe your changes

Add migration to help users navigate breaking changes.

Issue ticket number and link

#1106

MIGRATION.md Outdated

This document provides instructions for migrating your codebase to accommodate breaking changes introduced in new versions of Griptape.

## 0.31.0
Copy link
Member

Choose a reason for hiding this comment

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

should the heading be something like 0.30 -> 0.31? i know this is the first one but it needs to delta off of something.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

CHANGELOG.md Outdated
@@ -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.
Copy link
Member

Choose a reason for hiding this comment

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

udpate markdown link

Copy link

codecov bot commented Aug 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

@collindutter collindutter merged commit f2b529a into dev Aug 26, 2024
13 checks passed
@collindutter collindutter deleted the feature/migration branch August 26, 2024 21:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants