You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-7Lines changed: 28 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -214,23 +214,44 @@ Having done this setup, this is what the development cycle looks like moving for
214
214
215
215
If changes are made to `packages/wasm` see [here](./packages/wasm/README.md) for info on building from source.
216
216
217
+
## Package Versioning
218
+
219
+
Starting from version 7.x.x, this monorepo uses independent versioning for packages. This means:
220
+
- Each package maintains its own version number
221
+
- Only modified packages have their versions incremented during releases
222
+
- Internal package dependencies use semver ranges (e.g., ^1.2.3) instead of exact versions
223
+
- Package versions are no longer synchronized across all packages
224
+
225
+
This change improves developer experience by:
226
+
- Avoiding unnecessary version bumps for unchanged packages
227
+
- Making package version history more meaningful
228
+
- Allowing packages to evolve at their own pace
229
+
- Providing clearer dependency relationships between packages
230
+
231
+
### Breaking Changes
232
+
If you're upgrading from a previous version, note that this is a breaking change in how versions are managed. You may need to update your dependency management practices to:
233
+
- Use appropriate semver ranges for internal dependencies
234
+
- Track individual package versions instead of a single SDK version
235
+
- Handle potentially different versions of related packages
236
+
217
237
## Publishing
218
238
219
239
You must have at least nodejs v18 to do this.
220
240
221
241
1. Install the latest packages with `yarn install`
222
242
223
-
2. Run `yarn bump` to bump the version
224
-
225
-
3. Build all the packages with `yarn build`
243
+
2. Build all the packages with `yarn build`
226
244
227
-
4. Run the unit tests with `yarn test:unit` & e2e node tests `yarn test:local` locally & ensure that they pass
245
+
3. Run the unit tests with `yarn test:unit` & e2e node tests `yarn test:local` locally & ensure that they pass
228
246
229
-
5. Update the docs with `yarn gen:docs --push`
247
+
4. Update the docs with `yarn gen:docs --push`
230
248
231
-
6. Finally, publish with `yarn publish:packages`
249
+
5. Publish packages with `yarn publish:packages`. This will:
250
+
- Prompt for version increments for modified packages
251
+
- Update internal dependencies automatically
252
+
- Publish only the packages that have changed
232
253
233
-
7. Commit these changes "Published version X.X.X"
254
+
6. Commit these changes with a message describing the published updates
0 commit comments