diff --git a/RELEASING.md b/RELEASING.md index 696cad3af..29c3f1f3f 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -9,6 +9,10 @@ (Note we exclude benchmarks, but you can check those too!) ```bash ./gradlew build && ./gradlew connectedCheck -x :benchmarks:dungeon-benchmark:connectedCheck -x :benchmarks:performance-poetry:complex-benchmark:connectedCheck -x :benchmarks:performance-poetry:complex-poetry:connectedDebugAndroidTest -x :samples:todo-android:app:connectedDebugAndroidTest + ``` + NOTE: If you have any unexpected errors in the build or tests and they are related to non-jvm + targets you may need to update your XCode or other iOS tools. See note in the workflow-core and + workflow-runtime modules. 1. Update your tags. ```bash diff --git a/workflow-core/README.md b/workflow-core/README.md index 67cd1bfe1..617305bd2 100644 --- a/workflow-core/README.md +++ b/workflow-core/README.md @@ -2,6 +2,13 @@ This module contains the core workflow APIs. +## Kotlin Multiplatform + +This module is a Kotlin Multiplatform module. The targets currently included for build and test +are `jvm`, `ios`, and `iosSimulatorSimulatorArm64`. If you are having issues with the tests, +ensure you have the correct version of XCode installed and can launch a simulator as it's specified +in the gradle build file (Currently iPhone 14). + ## Notes on Dispatchers _Dispatchers control what threads/pools coroutines are run on. [See here for more information.][1]_ diff --git a/workflow-runtime/README.md b/workflow-runtime/README.md index 7636e1764..75c2f63a1 100644 --- a/workflow-runtime/README.md +++ b/workflow-runtime/README.md @@ -1,3 +1,10 @@ # Module workflow-runtime This module contains the core APIs and logic for running workflows. + +## Kotlin Multiplatform + +This module is a Kotlin Multiplatform module. The targets currently included for build and test +are `jvm`, `ios`, and `iosSimulatorSimulatorArm64`. If you are having issues with the tests, +ensure you have the correct version of XCode installed and can launch a simulator as it's specified +in the gradle build file (Currently iPhone 14).