Skip to content

Commit 3d30852

Browse files
docs: Update README with versioning strategy (box/box-codegen#857) (#1488)
1 parent 6896386 commit 3d30852

File tree

2 files changed

+27
-5
lines changed

2 files changed

+27
-5
lines changed

.codegen.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "9334953", "specHash": "c7acada", "version": "10.0.0" }
1+
{ "engineHash": "7523fdd", "specHash": "fa34496", "version": "10.0.0" }

README.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,28 @@
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+
# Versioning Strategy
6+
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`.
9+
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` |
26+
527
# Box Java SDK
628

729
[![Project Status](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges)
@@ -149,11 +171,11 @@ The Java SDK uses third-party libraries that are required for usage. Their licen
149171
6. [jose4j v0.9.6](https://mvnrepository.com/artifact/org.bitbucket.b_c/jose4j/0.9.6)
150172
Maven: `org.bitbucket.b_c:jose4j:0.9.6`
151173
Licence: [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0)
152-
7. [bcprov-jdk18on v1.78.1](https://mvnrepository.com/artifact/org.bouncycastle/bcprov-jdk18on/1.78.1)
153-
Maven: `org.bouncycastle:bcprov-jdk18on:1.78.1`
174+
7. [bcprov-jdk18on v1.82](https://mvnrepository.com/artifact/org.bouncycastle/bcprov-jdk18on/1.82)
175+
Maven: `org.bouncycastle:bcprov-jdk18on:1.82`
154176
Licence: [MIT](https://opensource.org/licenses/MIT)
155-
8. [bcpkix-jdk18on v1.78.1](https://mvnrepository.com/artifact/org.bouncycastle/bcpkix-jdk18on/1.78.1)
156-
Maven: `org.bouncycastle:bcpkix-jdk18on:1.78.1`
177+
8. [bcpkix-jdk18on v1.82](https://mvnrepository.com/artifact/org.bouncycastle/bcpkix-jdk18on/1.82)
178+
Maven: `org.bouncycastle:bcpkix-jdk18on:1.82`
157179
Licence: [MIT](https://opensource.org/licenses/MIT)
158180

159181
The following libraries are required for running tests:

0 commit comments

Comments
 (0)