Skip to content

Commit af0b542

Browse files
authored
docs: Update README with versioning strategy (#1486)
1 parent 831df77 commit af0b542

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,27 @@
22
<img src="https://github.com/box/sdks/blob/master/images/box-dev-logo.png" alt= “box-dev-logo” width="30%" height="50%">
33
</p>
44

5-
# Migration to v10
5+
# Versioning Strategy
66

7-
The [sdk-gen](https://github.com/box/box-java-sdk/tree/sdk-gen) branch contains the generated code for the `v10` version of the Box Java SDK. This is intended primarily for developers migrating from [Box Java SDK Gen](https://github.com/box/box-java-sdk-gen) to the v10 version.
8-
As part of our upcoming major release, we will be introducing a combined SDK that consolidates the previously separate generated SDK into one unified SDK package for improved usability and maintenance.
7+
Starting with v10 of the SDK, we’ve introduced a new generated codebase designed to enhance your experience with the Box API.
8+
It is currently available on the [sdk-gen](https://github.com/box/box-java-sdk/tree/sdk-gen) branch and uses the new `com.box.sdkgen` package instead of the old `com.box.sdk`.
99

10-
You can find the migration guide [here](https://github.com/box/box-java-sdk/blob/sdk-gen/migration-guides/from-box-java-sdk-gen-v0-to-box-java-sdk-v10.md) for transitioning from Box Java SDK Gen to Box Java SDK v10. If you have any questions, please create an issue in the repository or reach out to [Box Developer Support](https://developer.box.com/support/).
10+
v10 is targeted at new users of Box Java SDK and users already working with the generated Box Java SDK previously available under the [Box Java SDK Gen repository](https://github.com/box/box-java-sdk-gen).
11+
12+
For users of v4 of the Box Java SDK, no action is required at this time — we’ll be providing an upcoming v5 release that will include both `com.box.sdk` and `com.box.sdkgen` packages for a smooth migration path. To avoid unintentional upgrades, pin your version to `com.box:box-java-sdk:4.16.4`.
13+
14+
For full guidance on SDK versioning, see the [Box SDK Versioning Guide](https://developer.box.com/guides/tooling/sdks/sdk-versioning/).
15+
16+
---
17+
18+
## Which Version Should I Use?
19+
20+
| Scenario | Recommended Version | Example Dependency |
21+
|-------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|-----------------------------------|
22+
| Creating a new application | Use [v10](https://github.com/box/box-java-sdk/tree/sdk-gen) | `com.box:box-sdkgen:10.0.0` |
23+
| Existing app using [box-java-sdk-gen](https://mvnrepository.com/artifact/com.box/box-java-sdk-gen) artifact | Upgrade to [v10](https://github.com/box/box-java-sdk/tree/sdk-gen) | `com.box:box-sdkgen:10.0.0` |
24+
| Existing app using [box-java-sdk](https://mvnrepository.com/artifact/com.box/box-java-sdk) and planning to use new features | Wait for v5 to start migration process | TBD |
25+
| Existing app using [box-java-sdk](https://mvnrepository.com/artifact/com.box/box-java-sdk) and not planning changes | Stay on your current version | `com.box:box-java-sdk:4.16.4` |
1126

1227
# Box Java SDK
1328

0 commit comments

Comments
 (0)