55The SDK is distributed primarily as a UPM package (` com.privy.unity-sdk ` ).
66Consumers can obtain it via several mechanisms:
77
8- * Clone/download ` SDK/ ` into their project's ` Assets ` folder
9- * Add as a git URL package in manifest.json (` "com.privy.unity-sdk": "https://github.com/<org>/unity-sdk.git?path=SDK" ` )
10- * Install via OpenUPM (` openupm add com.privy.unity-sdk ` )
11-
8+ - Clone/download ` SDK/ ` into their project's ` Assets ` folder
9+ - Add as a git URL package in manifest.json (` "com.privy.unity-sdk": "https://github.com/<org>/unity-sdk.git?path=SDK" ` )
10+ - Install via OpenUPM (` openupm add com.privy.unity-sdk ` )
1211
1312### What the package includes
1413
@@ -19,24 +18,25 @@ Note: the package is structured as a standard UPM package. WebGL custom
1918templates are copied via the installer script or manually placed in the
2019consumer project; the package itself does not automatically install them.
2120
22- ### Versioning and export script
21+ ### Versioning
2322
24- The [ VersionedExport] ( ../SampleApp/Assets/Editor/VersionedExport.cs ) script
25- can be used to update the ` version ` field in ` SDK/package.json ` so it matches
26- ` SdkVersion.cs ` . It is primarily used during development and is ** not required
27- for UPM distribution** .
23+ Versions are managed automatically by
24+ [ release-please] ( https://github.com/googleapis/release-please ) . The version
25+ string lives in three places and is kept in sync by release-please:
2826
29- Follow the normal tagging procedure (see below) to release a new package
30- version.
27+ | File | Updater |
28+ | --------------------------------- | -------------------------------------- |
29+ | ` version.txt ` | ` simple ` (primary version file) |
30+ | ` SDK/package.json ` | ` json ` (` $.version ` ) |
31+ | ` SDK/Runtime/Utils/SdkVersion.cs ` | ` generic ` (` x-release-please ` markers) |
3132
3233### How to release
3334
34- 1 . Make your changes to the SDK and update ` SDK/Runtime/Utils/SdkVersion.cs ` .
35- 2 . Optionally run ` tools/bump-version.* ` to sync ` package.json ` .
36- 3 . Commit your changes, tag the commit (e.g. ` git tag v0.7.2 ` ), and push to
37- ` main ` .
38- 4 . The GitHub workflow will validate the version and may perform additional
39- publishing steps.
35+ 1 . Merge conventional-commit-formatted PRs into ` main ` (e.g. ` feat: ` , ` fix: ` ).
36+ 2 . Release-please automatically opens (or updates) a release PR that bumps
37+ versions and updates ` SDK/CHANGELOG.md ` .
38+ 3 . Review the release PR and merge it when ready.
39+ 4 . On merge, release-please creates a GitHub Release and git tag.
4040
41- For UPM releases, simply pushing the tag is sufficient; OpenUPM and Package
42- Manager clients will pick up the new version automatically.
41+ For UPM releases, the tag is sufficient; OpenUPM and Package Manager clients
42+ will pick up the new version automatically.
0 commit comments