C library: add script to update version, update instructions #12

Author: greenrobot-team

dev-doc/updating-c-library.md

@@ -5,30 +5,23 @@ Dart won't error on C function signature mismatch, leading to obscure memory bug
 
 ## C libraries
 
-For Dart Native and unit tests:
+For Dart Native and unit tests and for Flutter (`flutter_libs` and `sync_flutter_libs` plugins) 
+on Linux and Windows:  
+```
+./tool/set-c-version.sh 0.20.0
+```
 
-- Update [install.sh](../install.sh).
+For the Flutter plugins on Android ([view releases](https://github.com/objectbox/objectbox-java/releases)):
+```
+./tool/set-android-version.sh 3.7.1
+```
 
-For Flutter (`flutter_libs` and `sync_flutter_libs` plugins):  
+For the Flutter plugins on iOS/macOS ([view releases](https://github.com/objectbox/objectbox-swift/releases))
+```
+./tool/set-swift-version.sh 1.9.1
+```
 
-- Linux and Windows
-  - Shortcut: search and replace e.g. `set(OBJECTBOX_VERSION 0.20.0)` in `CMakeLists.txt`.
-  - [flutter_libs Linux](../flutter_libs/linux/CMakeLists.txt)
-  - [flutter_libs Windows](../flutter_libs/windows/CMakeLists.txt)
-  - [sync_flutter_libs Linux](../sync_flutter_libs/linux/CMakeLists.txt)
-  - [sync_flutter_libs Windows](../sync_flutter_libs/windows/CMakeLists.txt)
-- Android ([view releases](https://github.com/objectbox/objectbox-java/releases))
-  ```
-  ./tool/set-android-version.sh 3.7.1
-  ```
-- Swift (iOS/macOS) ([view releases](https://github.com/objectbox/objectbox-swift/releases))
-  ```
-  ./tool/set-swift-version.sh 1.9.1
-  ```
-
-Note: the embedded C library and core version can be looked up 
-for Android from the relevant core repository release tag and 
-for Swift from its repos release tag and the core commit it points to.
+For each, add an entry (see previous releases) to the [CHANGELOG](../objectbox/CHANGELOG.md).
 
 ## Dart C API bindings
 Download source code of an [objectbox-c release version](https://github.com/objectbox/objectbox-c/releases).
@@ -40,7 +33,11 @@ Download source code of an [objectbox-c release version](https://github.com/obje
 - Execute `dart run ffigen` in the `objectbox` directory. This requires LLVM libraries 
   (see [ffigen docs](https://pub.dev/packages/ffigen#installing-llvm) 
   and the ffigen section in [pubspec.yaml](../objectbox/pubspec.yaml)).
-- Copy/update enums from [objectbox_c.dart](../objectbox/lib/src/native/bindings/objectbox_c.dart) 
-  in [enums.dart](../objectbox/lib/src/modelinfo/enums.dart) that need to be exposed to users.
+- Copy/update enums that need to be exposed to users from [objectbox_c.dart](../objectbox/lib/src/native/bindings/objectbox_c.dart) 
+  to [enums.dart](../objectbox/lib/src/modelinfo/enums.dart).
 - Have a look at the changed files to see if some call sites need to be updated.
-- Update minimum C library and core version and notes in [bindings.dart](../objectbox/lib/src/native/bindings/bindings.dart).
+- ⚠️ Update minimum C library and core version and notes as needed in [bindings.dart](../objectbox/lib/src/native/bindings/bindings.dart).
+  
+  Note: the embedded C library and core version can be looked up
+  for Android from the relevant core repository release tag and
+  for Swift from its repos release tag and the core commit it points to.

tool/set-c-version.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+. "$(dirname "$0")"/common.sh
+
+# Changes the C library version used in
+# - the install script (for Dart Native and unit tests) and
+# - both Flutter plugins (for Flutter on Linux, Windows).
+
+if [[ "$#" -ne "1" ]]; then
+  echo "usage: $0 <version>"
+  echo "e.g. $0 0.20.0"
+  exit 1
+fi
+
+version=$1
+
+echo "Setting cLibVersion and OBJECTBOX_VERSION version: $version"
+
+versionExpr="s/cLibVersion=[0-9]\+\.[0-9]\+\.[0-9]\+/cLibVersion=${version}/g"
+update install.sh "${versionExpr}"
+
+versionExpr="s/OBJECTBOX_VERSION [0-9]\+\.[0-9]\+\.[0-9]\+/OBJECTBOX_VERSION ${version}/g"
+update flutter_libs/linux/CMakeLists.txt "${versionExpr}"
+update flutter_libs/windows/CMakeLists.txt "${versionExpr}"
+update sync_flutter_libs/linux/CMakeLists.txt "${versionExpr}"
+update sync_flutter_libs/windows/CMakeLists.txt "${versionExpr}"