From 8a80030429cde796582a0e381788c5299ccce693 Mon Sep 17 00:00:00 2001 From: Eberhard Beilharz Date: Wed, 7 Oct 2026 15:09:28 +0200 Subject: [PATCH] docs(common): add `sentry-cli` version and update documentation Build-bot: skip Test-bot: skip --- docs/build/linux-ubuntu.md | 9 +++++++++ docs/build/macos.md | 14 ++++++++------ docs/build/sentry-cli.md | 7 +++++-- docs/build/windows.md | 8 +++----- docs/minimum-versions.md | 1 + resources/build/minimum-versions.inc.sh | 3 ++- 6 files changed, 28 insertions(+), 14 deletions(-) diff --git a/docs/build/linux-ubuntu.md b/docs/build/linux-ubuntu.md index 82537b1b79..8f3e879801 100644 --- a/docs/build/linux-ubuntu.md +++ b/docs/build/linux-ubuntu.md @@ -245,6 +245,15 @@ from command line. But note that you do need to update your `JAVA_HOME` env var to the associated version before opening Android Studio and loading any Android projects. `JAVA_HOME_11` is mostly used by CI. +## Optional Tools + +- sentry-cli (optional) + - Uploading symbols for Sentry-based error reporting + + See for the installation, and + check [minimum-versions.md](../minimum-versions.md) for the required version of + `sentry-cli`. + ## Docker Builder The Docker builder allows you to perform a build from anywhere Docker is supported. diff --git a/docs/build/macos.md b/docs/build/macos.md index 92203ddb6d..b8030c7292 100644 --- a/docs/build/macos.md +++ b/docs/build/macos.md @@ -41,7 +41,7 @@ Rosetta 2 installed. Many dependencies are only required for specific projects. -* XCode (iOS, macOS) 26.2 or 26.3 (not higher at this time, see #16416) +* XCode (iOS, macOS) 26.2 or 26.3 (not higher at this time, see #16416) is needed only for Keyman for macOS and Keyman for iOS (). * Install from App Store @@ -206,8 +206,10 @@ components such as emulator images and SDK updates. * node.js, emscripten -```shell -brew install node emscripten + ```shell + brew install node emscripten + ``` + * node.js 20.0, emscripten 3.1.64 See section KeymanWeb Dependencies for installation @@ -216,6 +218,6 @@ See section KeymanWeb Dependencies for installation * sentry-cli: Uploading symbols for Sentry-based error reporting - ```shell - brew install getsentry/tools/sentry-cli - ``` + See for the installation, and + check [minimum-versions.md](../minimum-versions.md) for the required version of + `sentry-cli`. diff --git a/docs/build/sentry-cli.md b/docs/build/sentry-cli.md index 42095d38eb..e9955082e6 100644 --- a/docs/build/sentry-cli.md +++ b/docs/build/sentry-cli.md @@ -1,8 +1,11 @@ # Setting up sentry-cli -Contact the Keyman team if you need access to sentry.keyman.com for development. +Contact the Keyman team if you need access to keyman.sentry.io for development. You will also need to install [sentry-cli](https://docs.sentry.io/cli/installation/) for uploading Debug symbols. -After setting up your personal [Auth token](http://keyman.sentry.io/settings/account/api/auth-tokens/), add the following to **~/.bashrc** +Check [minimum-versions.md](../minimum-versions.md) for the required version of `sentry-cli`. + +After setting up your personal [Auth token](http://keyman.sentry.io/settings/account/api/auth-tokens/), +add the following to `~/.bashrc`: ```bash export SENTRY_AUTH_TOKEN={your Sentry auth token} diff --git a/docs/build/windows.md b/docs/build/windows.md index edc756340f..180b099fc5 100644 --- a/docs/build/windows.md +++ b/docs/build/windows.md @@ -412,8 +412,6 @@ certificates for the build. * sentry-cli (optional) - Uploading symbols for Sentry-based error reporting - bash: - ```bash - # bash - curl -sL https://sentry.io/get-cli/ | bash - ``` + See for the installation, and + check [minimum-versions.md](../minimum-versions.md) for the required version of + `sentry-cli`. diff --git a/docs/minimum-versions.md b/docs/minimum-versions.md index b9c08e1e71..3a68aeaad3 100644 --- a/docs/minimum-versions.md +++ b/docs/minimum-versions.md @@ -74,6 +74,7 @@ https://help.keyman.com/developer/engine/android/latest-version/ | KEYMAN_VERSION_LANGTAGS | 2026-06-09 | | KEYMAN_VERSION_LANGTAGS_API | 1.4 | | KEYMAN_VERSION_LANGUAGE_SUBTAG_REGISTRY | 2026-08-08 | +| KEYMAN_VERSION_SENTRY_CLI | 1.70.0 | | KEYMAN_VERSION_UNICODE | 17.0.0 | | KEYMAN_VERSION_XCODE | 26.2 | diff --git a/resources/build/minimum-versions.inc.sh b/resources/build/minimum-versions.inc.sh index 539c66554a..7ae71a21c8 100644 --- a/resources/build/minimum-versions.inc.sh +++ b/resources/build/minimum-versions.inc.sh @@ -32,6 +32,7 @@ KEYMAN_MIN_VERSION_EMSCRIPTEN=3.1.64 # Use KEYMAN_USE_EMSDK to automati KEYMAN_MIN_VERSION_VISUAL_STUDIO=2022 # Visual Studio 2022, see /docs/build/windows.md for workloads and components KEYMAN_MIN_VERSION_MESON=1.0.0 # TODO: rename meson_options.txt to meson.options when updating to >= 1.1, see #15127. KEYMAN_VERSION_XCODE=26.2 # XCode 26.2 is the current supported version; download from https://developer.apple.com/download/all/ +KEYMAN_VERSION_SENTRY_CLI=1.70.0 # sentry-cli used to upload debug information to Sentry during CI KEYMAN_VERSION_GRADLE=8.12 # See /android/KMEA/gradle/wrapper/gradle-wrapper.properties @@ -52,4 +53,4 @@ KEYMAN_VERSION_ISO639_3=2026-08-17 # Date of last import KEYMAN_VERSION_LANGTAGS=2026-06-09 # _version value KEYMAN_VERSION_LANGTAGS_API=1.4 # Langtags API version supported KEYMAN_VERSION_LANGUAGE_SUBTAG_REGISTRY=2026-08-08 # Date from first line of language-subtag-registry -KEYMAN_VERSION_UNICODE=17.0.0 # UCD + related data \ No newline at end of file +KEYMAN_VERSION_UNICODE=17.0.0 # UCD + related data