Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
72 lines (37 loc) · 2.77 KB

DEVELOPMENT.md

File metadata and controls

72 lines (37 loc) · 2.77 KB

Contributing

To bump the holochain version you will need to update all holochain dependencies in the top-level Cargo.toml file, and then publish all the components listed in the following order:

Publish runtime-types-ffi crate release

  1. Bump crate version in crates/runtime-types-ffi/Cargo.toml

  2. Create and push a git tag with a matching format to trigger the release CI.

    The git tag format is: runtime-types-ffi-vX.Y.Z, where "X.Y.Z" is replaced with the version number.

Publish tauri-plugin-client crate release

  1. Bump crate version in crates/tauri-plugin-client/Cargo.toml

  2. Create and push a git tag with a matching format to trigger the release CI.

    The git tag format is: tauri-plugin-client-vX.Y.Z, where "X.Y.Z" is replaced with the version number.

Publish tauri-plugin-service crate release

  1. Bump crate version in crates/tauri-plugin-service/Cargo.toml

  2. Create and push a git tag with a matching format to trigger the release CI.

    The git tag format is: tauri-plugin-service-vX.Y.Z, where "X.Y.Z" is replaced with the version number.

Publish client library release

  1. Bump versions of kotlin libraries.

    The are specified in libraries/client/build.gradle.kts under mavenPublishing.coordinates.

  2. Create and push a git tag with a matching format to trigger the release CI.

    The git tag format is: client-vX.Y.Z, where "X.Y.Z" is replaced with the version number.

Publish service library release

  1. Bump versions of kotlin libraries.

    The are specified in libraries/service/build.gradle.kts under mavenPublishing.coordinates.

  2. Create and push a git tag with a matching format to trigger the release CI.

    The git tag format is: service-vX.Y.Z, where "X.Y.Z" is replaced with the version number.

Publish app releases (android-service-runtime & example-client-app)

  1. Bump versions of tauri apps.

    These are specified in multiple files (although only the tauri.conf.json file actually alters the built android app version):

    • apps/*/src-tauri/tauri.conf.json
    • apps/*/src-tauri/Cargo.toml
    • apps/*/package.json

  2. Create and push a git tag with a matching format to trigger the release CI.

    The git tag format is: android-service-runtime-vX.Y.Z. Where "X.Y.Z" is replaced with the version number.

  3. Wait for the release CI to complete. It will create a draft release, build both apps, and upload them to the draft release.

  4. Visit the github releases page, and publish the draft release.

CI

Note that the CI jobs build-tauri-plugins do not publish the kotlin client and service libraries to the local Maven repository.

If your PR makes changes to the client or service library, it will need to be published to Maven Central, before the CI jobs build-tauri-plugins will pass.