Skip to content

Commit 6bbb8f2

Browse files
docs: Improve migration guides (box/box-codegen#867) (#1178)
1 parent 714f7e2 commit 6bbb8f2

File tree

2 files changed

+12
-5
lines changed

2 files changed

+12
-5
lines changed

.codegen.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "fa0419f", "specHash": "fa34496", "version": "10.0.1" }
1+
{ "engineHash": "192deac", "specHash": "fa34496", "version": "10.0.1" }

migration-guides/from-v5-to-v10.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
- [Swift Package Manager](#swift-package-manager)
99
- [Carthage](#carthage)
1010
- [CocoaPods](#cocoapods)
11+
- [Supported Environments](#supported-environments)
1112
- [Highlighting the Key Differences](#highlighting-the-key-differences)
1213

1314
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -24,12 +25,12 @@ More information and benefits of using the new can be found in the
2425

2526
## Installation
2627

27-
Soon we are going to introduce v6 version of Box iOS SDK that will combine `BoxSDK` from v5
28-
and the `BoxSdkGen` from v10 of the SDK, so that code from both versions could be used in the same project.
28+
We have also introduced v6 version of Box iOS SDK that consolidates both the manually maintained `BoxSDK` module from v5
29+
and the new, auto-generated `BoxSdkGen` module from v10.
2930
If you would like to use a feature available only in the new SDK, you won't need to necessarily migrate all your code
3031
to use generated SDK at once. You will be able to use a new feature from the `BoxSdkGen` project,
31-
while keeping the rest of your code unchanged. Note that it may be required to use aliases for some of the imported types
32-
to avoid conflicts between two libraries. However, we recommend to fully migrate to the v10 of the SDK eventually.
32+
while keeping the rest of your code unchanged. However, we recommend to fully migrate to the v10 of the SDK eventually.
33+
More information about v6 version can be found in the [migration guide from v5 to v6](./from-v5-to-v6.md).
3334

3435
### Swift Package Manager
3536

@@ -80,6 +81,12 @@ Then run the following command in your project directory:
8081
$ pod install
8182
```
8283

84+
## Supported Environments
85+
86+
v10 supports: iOS 13.0+, macOS 10.15+, tvOS 13.0+, and watchOS 6.0+. (By comparison, v5 supported iOS 11.0+, macOS 10.13+, tvOS 11.0+, and watchOS 4.0+.)
87+
If your app currently targets older OS versions, update your deployment targets to meet these minimums.
88+
This update aligns the SDK with current Apple development standards and is required to adopt the new features available in the `BoxSdkGen` module. For the latest submission and SDK toolchain requirements, see Apple’s SDK minimum requirements ([Apple Developer](https://developer.apple.com/news/upcoming-requirements/?id=02212025a)).
89+
8390
## Highlighting the Key Differences
8491

8592
There are important differences between the `BoxSDK` (v5) and the generated `BoxSdkGen` (v10) modules. We have prepared a separate document that presents the main differences and provides guidance to help you migrate. For side-by-side code examples, see: [Migration guide: migrate from BoxSDK to BoxSdkGen](./from-BoxSDK-to-BoxSdkGen.md).

0 commit comments

Comments
 (0)