From 022b232bf8ef3edb15efe273e280eeea9e6f20c5 Mon Sep 17 00:00:00 2001 From: martinpucik Date: Fri, 4 Mar 2022 12:59:38 +0100 Subject: [PATCH] docs: CHANGELOG and MIGRATION_GUIDE update --- CHANGELOG.md | 5 ++++- .../CHANGELOG_GUIDELINES.md | 0 Documentation/MIGRATION_GUIDE.md | 8 ++++++++ 3 files changed, 12 insertions(+), 1 deletion(-) rename CHANGELOG_GUIDELINES.md => Documentation/CHANGELOG_GUIDELINES.md (100%) create mode 100644 Documentation/MIGRATION_GUIDE.md diff --git a/CHANGELOG.md b/CHANGELOG.md index ae669947..7be32963 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ The changelog for `MessageKit`. Also see the [releases](https://github.com/MessageKit/MessageKit/releases) on GitHub. -## Future release +## 4.0.0 ### Fixed @@ -12,6 +12,9 @@ The changelog for `MessageKit`. Also see the [releases](https://github.com/Messa ### Changed +- BREAKING CHANGE: `MessageSizeCalculator.messageContainerMaxWidth(for message: MessageType) -> CGFloat` now has IndexPath argument `MessageSizeCalculator.messageContainerMaxWidth(for message: MessageType, at indexPath: IndexPath) -> CGFloat` [cd4f75b](https://github.com/MessageKit/MessageKit/commit/cd4f75b561129fc25e6c4576000e5a92ccd81cad) by [@martinpucik](https://github.com/martinpucik) +- BREAKING CHANGE: `MessageSizeCalculator.messageContainerSize(for message: MessageType) -> CGSize` now has IndexPath argument `MessageSizeCalculator.messageContainerSize(for message: MessageType, at indexPath: IndexPath) -> CGSize` [cd4f75b](https://github.com/MessageKit/MessageKit/commit/cd4f75b561129fc25e6c4576000e5a92ccd81cad) by [@martinpucik](https://github.com/martinpucik) + ### Removed - Not used workspace files in example project [#1671](https://github.com/MessageKit/MessageKit/pull/1671) by [@martinpucik](https://github.com/martinpucik) diff --git a/CHANGELOG_GUIDELINES.md b/Documentation/CHANGELOG_GUIDELINES.md similarity index 100% rename from CHANGELOG_GUIDELINES.md rename to Documentation/CHANGELOG_GUIDELINES.md diff --git a/Documentation/MIGRATION_GUIDE.md b/Documentation/MIGRATION_GUIDE.md new file mode 100644 index 00000000..044e524a --- /dev/null +++ b/Documentation/MIGRATION_GUIDE.md @@ -0,0 +1,8 @@ +## MessageKit 4.0 Migration Guide + +Version 4.0 contains some breaking changes if you want to upgrade from the previous version. In this documentation, we will cover most of the noticeable API changes. + +### Migration + +- BREAKING CHANGE: `MessageSizeCalculator.messageContainerMaxWidth(for message: MessageType) -> CGFloat` now has IndexPath argument `MessageSizeCalculator.messageContainerMaxWidth(for message: MessageType, at indexPath: IndexPath) -> CGFloat` +- BREAKING CHANGE: `MessageSizeCalculator.messageContainerSize(for message: MessageType) -> CGSize` now has IndexPath argument `MessageSizeCalculator.messageContainerSize(for message: MessageType, at indexPath: IndexPath) -> CGSize`