No description
  • Kotlin 99.3%
  • Shell 0.4%
  • Python 0.3%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Jorge Martín aff2b6459d Fix wrong SECRETS being used for the sentry token.
Make the sentry upload print debug info so we don't just get an HTTP status code as a possible upload error.
2026-11-10 12:19:41 +01:00
.github Fix wrong SECRETS being used for the sentry token. 2026-11-10 12:19:41 +01:00
buildSrc Bump SDK version to 26.11.05 (matrix-rust-sdk to 3ff03638028fd9abf58203153722b94b4293a87a) 2026-11-05 15:20:58 +00:00
crypto Add missing annotations dependency 2026-05-18 12:43:55 +02:00
gradle/wrapper Revert "Update Gradle to v9" 2026-01-22 11:35:23 +01:00
scripts Fix regex to change the bindings version in the EXA PRs 2026-10-29 16:26:25 +01:00
sdk Bump SDK version to 26.11.05 (matrix-rust-sdk to 3ff03638028fd9abf58203153722b94b4293a87a) 2026-11-05 15:20:58 +00:00
.gitignore Remove mistake in .gitignore. 2024-01-23 09:55:43 +01:00
build.gradle.kts Fix deprecation warning. 2024-01-22 14:57:59 +01:00
CONTRIBUTING.md add DCO 2024-07-25 14:27:34 -07:00
gradle.properties Revert "Remove old code migrated to matrix-rust-sdk repo" 2023-02-16 16:46:23 +01:00
gradlew Revert "Update Gradle to v9" 2026-01-22 11:35:23 +01:00
gradlew.bat Revert "Update Gradle to v9" 2026-01-22 11:35:23 +01:00
README.md Update README 2025-05-30 13:51:51 +02:00
renovate.json Revert "Remove unworking config, and let's wait a day instead." 2024-01-19 11:50:19 +01:00
SECURITY.md Initial commit 2022-02-28 17:47:51 +01:00
settings.gradle Improve scripts 2023-02-23 15:11:30 +01:00

Matrix rust components kotlin

This repository is used for distributing kotlin releases of the Matrix Rust SDK. It'll provide the corresponding aar and also publish them on maven.

Releasing

There is a 'Release SDK Library (parallel)' Github Actions workflow you can run with a parameter for the SDK branch or SHA - tags don't work correctly at the moment - and the new version name to release. There is also a 'Release Crypto Library' one that does the same for the crypto library.

If you want to do it manually instead:

You need to set GITHUB_API_TOKEN in your env to let the script be able to commit and push, with this configuration:

  • Content: Read and Write;
  • Metadata: Read only.

Make sure to also have setup the maven credentials and gpg key in your env

Whenever a new release of the underlying components is available, we need to tag a new release in this repo to make them available. This is done with the release script found in the scripts directory. It'll also push the release to the maven repository.

Usage :

# To build the SDK/crypto library binaries from the matrix-rust-sdk repo:
./scripts/build.sh -p <matrix-rust-sdk-path> -m <sdk/crypto> -r
# To release the built SDK/crypto library binaries to maven:
python3 ./scripts/publish_release.py --version <version> --linkable-ref <sdk-branch/SHA> --module <SDK/CRYPTO>

Testing locally

As the package vendors a pre-built binary of the SDK, all local development is done via the SDK's repo instead of this one. You can use the build script to generate the AAR file for testing. Be sure to have checked out the matrix-rust-sdk first.

The -t argument needs a valid architecture to build. For Android, these are:

  • aarch64-linux-android
  • armv7-linux-androideabi
  • i686-linux-android
  • x86_64-linux-android

Alternatively, to build only the host's architecture, you can use the -l argument.

Usage:

To build the main crate (eg, for Element-X):

./scripts/build.sh -p <matrix-rust-sdk-path> -m sdk -l

Or:

./scripts/build.sh -p <matrix-rust-sdk-path> -m sdk -t <arch>

To build just the crypto crate (eg, for Element Android classic), use this instead:

./scripts/build.sh -p <matrix-rust-sdk-path> -m crypto -l

Other useful flags:

  • -o OUTPUT_DIR: Moves the generated AAR file to the dir OUTPUT_DIR.
  • -r: Produces a release build instead of a development one.

You should then import this AAR in your project.

Prerequisites

  • Android NDK
  • the Rust toolchain
  • cargo-ndk cargo install cargo-ndk
  • protoc brew install protobuf or downloading here
  • android targets (e.g. rustup target add aarch64-linux-android armv7-linux-androideabi x86_64-linux-android i686-linux-android)

License

Apache-2.0