search

iTwin / imodels-clients

Monorepo for iModels API clients
MIT License
6 stars 1 forks source link

Major version bump to 5.0.0 #224

Closed arminasbrazenas closed 3 months ago

arminasbrazenas commented 3 months ago

Bumped package versions to 5.0.0 for breaking changes in #223

austeja-bentley commented 3 months ago

Could you add a note to root repository README.md outlining what major versions of @itwin/imodels-access-backend and @itwin/imodels-access-frontend support which major versions of iTwin.js?I think something like this would work (numbers are fake)

iTwin.js version @itwin/imodels-access-* version
>=a.b.c <x.y.z 0.1.2
>=x.y.z < ... 0.3.4

I don't think there should be too many rows in this table, if there appears to be, let's discuss, maybe we can think of something more granular.

One way to determine the ranges would be to go through the file history of imodels-access-backend package.json file. The lowest version of iTwin.js we should mention is 3.0.0.

arminasbrazenas commented 3 months ago

Could you add a note to root repository README.md outlining what major versions of @itwin/imodels-access-backend and @itwin/imodels-access-frontend support which major versions of iTwin.js?I think something like this would work (numbers are fake) iTwin.js version @itwin/imodels-access-* version

=a.b.c <x.y.z 0.1.2 =x.y.z < ... 0.3.4

I don't think there should be too many rows in this table, if there appears to be, let's discuss, maybe we can think of something more granular.

One way to determine the ranges would be to go through the file history of imodels-access-backend package.json file. The lowest version of iTwin.js we should mention is 3.0.0.

Added the table; here are corresponding PRs: ^3.0.0: https://github.com/iTwin/imodels-clients/commit/5924c5c5de830d22263e53cbaeded087a5769758 ^3.3.0: https://github.com/iTwin/imodels-clients/commit/4afad2b5690ccb942edbf66a15eca0be181180aa and https://github.com/iTwin/imodels-clients/commit/e4a925fe5fd48c00a5e8161da30272af79873070 ^3.6.0: https://github.com/iTwin/imodels-clients/commit/93a74d62504c59045f990fd0025c0422c241b35e and https://github.com/iTwin/imodels-clients/commit/52206238a863cb3ddad9e9abdec5700f8bf7ede6 ^4.0.0: https://github.com/iTwin/imodels-clients/commit/a0017b1b697cd03d23cf73d3a4301fb07e4a4887 and https://github.com/iTwin/imodels-clients/commit/fb39c5afce0ac1f93eb69fa999a8cfdc9b7e6881

I thought about using another table format (screenshot below), but I think the proposed one is more convenient for consumers. Code_oBvTwmhQAv