tarantool / vshard

The new generation of sharding based on virtual buckets
Other
100 stars 31 forks source link

doc: create 0.1.22 changelog #399

Closed sergos closed 1 year ago

Serpentian commented 1 year ago

Let's add a message about service_info, move API changes to the corresponding part of the changelog and fix a typo in intorudced:

diff --git a/changelogs/0.1.22.md b/changelogs/0.1.22.md
index 5757a6d..36c053a 100644
--- a/changelogs/0.1.22.md
+++ b/changelogs/0.1.22.md
@@ -6,10 +6,16 @@ Tag: 0.1.22

 VShard 0.1.22 is fully compatible with the previous VShard versions.

+## Functionality added or changed
+
+* A new vshard.storage.on_bucket_event() event API to create a user reaction to
+  a bucket move is introduced (gh-372).
+
+* vshard.router/storage.info() now accepts options, which can be used to get
+  additional information about background services (such as discovery or
+  rebalancer) that are working on the current instance (gh-107).
+
 ## Bugs fixed

 * Fixed a bug that the rebalancing can lead to inconsistency in buckets (gh-377,
   gh-173).
-
-* A new vshard.storage.on_bucket_event() event API to create a user reaction to 
-  a bucket move is intorudced (gh-372).
Gerold103 commented 1 year ago

Please, use this:

Date: 20-02-2023

Tag: 0.1.22

## Compatibility

VShard 0.1.22 is fully compatible with the previous VShard versions.

## Functionality added or changed

* A new trigger `vshard.storage.on_bucket_event()` to react on bucket events,
  such as move or GC (gh-372).

* `vshard.router/storage.info()` now accept an option `{with_services = true}`
  to get additional info about background services (such as discovery or
  rebalancer) that are working on the current instance (gh-107).

## Bugs fixed

* Fixed a bug that the rebalancing could lead to inconsistency in buckets. In
  scope of the same bugfix all the updates in `_bucket` space are now severely
  restricted and validated (gh-377, gh-173).

* `vshard.router/storage.cfg{}` now can not be called from multiple fibers at
  the same time (gh-140).

* Fixed a bug that certain router error objects didn't have `router_name` field.

Some of the commits I listed in the review above I omitted as not documented (on_master_enable/disable triggers) or not released bugs (bucket on_rollback was introduced and fixed after 0.1.21).

sergos commented 1 year ago

Done as per your proposal.