From 74629da59e1a1c95d89032c05d9228c82d678c96 Mon Sep 17 00:00:00 2001 From: cameronvoell Date: Tue, 14 Jan 2025 14:49:14 -0800 Subject: [PATCH] clarify steps --- library/src/main/java/README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/library/src/main/java/README.md b/library/src/main/java/README.md index c681a603..0062c501 100644 --- a/library/src/main/java/README.md +++ b/library/src/main/java/README.md @@ -5,9 +5,8 @@ Kotlin code emitted by the `bindings_ffi` crate in [libxmtp](https://github.com/ ## Process for updating from a [libxmtp](https://github.com/xmtp/libxmtp) Kotlin Binding Release 1. From repo [libxmtp](https://github.com/xmtp/libxmtp) run the [kotlin release action](https://github.com/xmtp/libxmtp/actions/workflows/release-kotlin-bindings.yml) for the branch you desire (this should take about 4 minutes) -2. Create a new branch in the `xmtp-android` repo -3. Once you see the [kotlin bindings GitHub action](https://github.com/xmtp/libxmtp/actions/workflows/release-kotlin-bindings.yml) is finished, with `libxmtp` repo and `xmtp-android` (this repo) cloned locally in sibling directories, and `libxmtp` checked out to the correct release commit, run the script: +2. Once you see the [kotlin bindings GitHub action](https://github.com/xmtp/libxmtp/actions/workflows/release-kotlin-bindings.yml) is finished, with `libxmtp` repo and `xmtp-android` (this repo) cloned locally in sibling directories, and `libxmtp` checked out to the correct release commit, run the script: `./gen_kotlin.sh` within the `bindings_ffi` folder. -3. Run format (cmd + opt + l) function to keep the code format consistent and diff small for `xmtp-android/library/src/main/java/xmtpv3.kt` +3. **(If only testing, you can skip this step**)Run format (cmd + opt + l) function to keep the code format consistent and diff small for `xmtp-android/library/src/main/java/xmtpv3.kt` You should now be on the latest libxmtp. Tests will fail if the jniLibs do not match the version of xmtpv3.