Skip to content

Commit

Permalink
clarify steps
Browse files Browse the repository at this point in the history
  • Loading branch information
cameronvoell committed Jan 14, 2025
1 parent c24bc49 commit 74629da
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions library/src/main/java/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 74629da

Please sign in to comment.