mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-13 12:19:25 +00:00
chore(ios): converts kmbuild.sh to builder format
This commit is contained in:
jahorton
parent
5485ad40f7
commit
a2cf4e03e7
1 changed files with 134 additions and 231 deletions
365
ios/kmbuild.sh
365
ios/kmbuild.sh
|
|
@ -1,12 +1,5 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
# set -e: Terminate script if a command returns an error
|
||||
set -e
|
||||
# set -u: Terminate script if an unset variable is used
|
||||
set -u
|
||||
# set -x: Debugging use, print each statement
|
||||
# set -x
|
||||
|
||||
## START STANDARD BUILD SCRIPT INCLUDE
|
||||
# adjust relative paths as necessary
|
||||
THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
|
||||
|
|
@ -24,101 +17,39 @@ cd "$(dirname "$THIS_SCRIPT")"
|
|||
# Please note that this build script (understandably) assumes that it is running on Mac OS X.
|
||||
verify_on_mac
|
||||
|
||||
display_usage ( ) {
|
||||
echo "build.sh [-clean] [-no-kmw] [-only-framework] [-no-codesign] [-no-archive] [-add-sim-artifact] [-no-build] [-upload-sentry]"
|
||||
echo
|
||||
echo " -clean Removes all previously-existing build products for KMEI and the Keyman app before building."
|
||||
echo " -no-kmw Uses existing keyman.js, doesn't try to build"
|
||||
echo " -only-framework Builds only the KeymanEngine framework; does not attempt to build the app."
|
||||
echo " -no-carthage Disables downloading and building for dependencies."
|
||||
echo " -no-codesign Disables code-signing for the Keyman application, allowing it to be performed separately later."
|
||||
echo " Will not construct the archive and .ipa. (includes -no-archive)"
|
||||
echo " -no-archive Bypasses the archive and .ipa preparation stage."
|
||||
echo " -no-build Cancels the build entirely. Useful with 'build.sh -clean -no-build'."
|
||||
echo " -upload-sentry Uploads debug symbols, etc, to Sentry"
|
||||
echo " -debug Sets the configuration to debug mode instead of release."
|
||||
echo " -download-resources Download up-to-date versions of the engine's default resources from downloads.keyman.com."
|
||||
echo " -add-sim-artifact Also produce a Simulator-installable .app build artifact"
|
||||
exit 1
|
||||
}
|
||||
builder_describe "Builds Keyman Engine and the Keyman app for use on iOS devices - iPhone and iPad." \
|
||||
"@/web/src/app/webview build:engine" \
|
||||
"@/common/web/sentry-manager build:engine" \
|
||||
"clean" \
|
||||
"configure" \
|
||||
"build" \
|
||||
":engine Builds KeymanEngine.xcframework, usable by our main app and by third-party apps" \
|
||||
":app Builds the Keyman app for iOS platforms" \
|
||||
"--debug Avoids codesigning and adds full sourcemaps for the embedded predictive-text engine" \
|
||||
"--sim-artifact Also outputs a simulator-friendly test artifact corresponding to the build"
|
||||
|
||||
do_clean ( ) {
|
||||
rm -rf $BUILD_PATH
|
||||
rm -rf Carthage
|
||||
}
|
||||
builder_parse "$@"
|
||||
|
||||
### START OF THE BUILD ###
|
||||
CONFIG="release"
|
||||
if builder_is_debug_build; then
|
||||
CONFIG="debug"
|
||||
fi
|
||||
|
||||
builder_describe_outputs \
|
||||
configure /ios/Carthage/Build \
|
||||
build:engine /ios/build/Build/Products/Release/KeymanEngine.xcframework \
|
||||
build:app /ios/build/Build/Products/Release-iphoneos/Keyman.xcarchive
|
||||
|
||||
# Base definitions (must be before do_clean call)
|
||||
DERIVED_DATA=build
|
||||
BUILD_PATH=$DERIVED_DATA/Build/Products
|
||||
|
||||
# Default is building and copying to assets
|
||||
DO_KMW_BUILD=true
|
||||
DO_KEYMANAPP=true
|
||||
DO_ARCHIVE=true
|
||||
DO_SIMULATOR_TARGET=false
|
||||
DO_CARTHAGE=true
|
||||
CLEAN_ONLY=false
|
||||
CONFIG=Release
|
||||
DO_KMP_DOWNLOADS=false
|
||||
CODE_SIGN=
|
||||
DO_CODE_SIGN=true
|
||||
|
||||
# Parse args
|
||||
while [[ $# -gt 0 ]] ; do
|
||||
key="$1"
|
||||
case $key in
|
||||
-no-kmw)
|
||||
DO_KMW_BUILD=false
|
||||
;;
|
||||
-h|-\?|-help)
|
||||
display_usage
|
||||
exit 0
|
||||
;;
|
||||
-only-framework)
|
||||
DO_KEYMANAPP=false
|
||||
;;
|
||||
-no-codesign)
|
||||
CODE_SIGN="CODE_SIGN_IDENTITY= CODE_SIGNING_REQUIRED=NO ${DEV_TEAM:-} CODE_SIGN_ENTITLEMENTS= CODE_SIGNING_ALLOWED=NO"
|
||||
DO_CODE_SIGN=false
|
||||
;;
|
||||
-no-archive)
|
||||
DO_ARCHIVE=false
|
||||
;;
|
||||
-clean)
|
||||
do_clean
|
||||
;;
|
||||
-no-build)
|
||||
CLEAN_ONLY=true
|
||||
# Overrides default set by build-utils.sh.
|
||||
UPLOAD_SENTRY=false
|
||||
;;
|
||||
-no-carthage)
|
||||
DO_CARTHAGE=false
|
||||
;;
|
||||
-upload-sentry)
|
||||
# Overrides default set by build-utils.sh.
|
||||
UPLOAD_SENTRY=true
|
||||
;;
|
||||
-debug)
|
||||
CONFIG=Debug
|
||||
;;
|
||||
-download-resources)
|
||||
DO_KMP_DOWNLOADS=true
|
||||
;;
|
||||
-add-sim-artifact)
|
||||
DO_SIMULATOR_TARGET=true
|
||||
;;
|
||||
esac
|
||||
shift # past argument
|
||||
done
|
||||
|
||||
# Extended path definitions
|
||||
KMEI_RESOURCES=engine/KMEI/KeymanEngine/resources
|
||||
BUNDLE_PATH=$KMEI_RESOURCES/Keyman.bundle/contents/resources
|
||||
BUNDLE_PATH=$KMEI_RESOURCES/Keyman.bundle/Contents/Resources
|
||||
KMW_ROOT=../web
|
||||
|
||||
# Needed before `configure` action
|
||||
DEFAULT_KBD_ID="sil_euro_latin"
|
||||
DEFAULT_LM_ID="nrc.en.mtnt"
|
||||
|
||||
|
|
@ -133,132 +64,110 @@ KEYMAN_XCFRAMEWORK=$BUILD_PATH/$CONFIG/KeymanEngine.xcframework
|
|||
XCODEFLAGS="-quiet -configuration $CONFIG"
|
||||
XCODEFLAGS_EXT="$XCODEFLAGS -derivedDataPath $DERIVED_DATA -workspace keymanios.xcworkspace"
|
||||
|
||||
if [ $CLEAN_ONLY = true ]; then
|
||||
exit 0
|
||||
CODE_SIGN=
|
||||
if builder_has_option --debug; then
|
||||
CODE_SIGN="CODE_SIGN_IDENTITY= CODE_SIGNING_REQUIRED=NO ${DEV_TEAM:-} CODE_SIGN_ENTITLEMENTS= CODE_SIGNING_ALLOWED=NO"
|
||||
fi
|
||||
|
||||
echo
|
||||
echo "KMW_ROOT: $KMW_ROOT"
|
||||
echo "DO_KMW_BUILD: $DO_KMW_BUILD"
|
||||
echo "DO_KMP_DOWNLOADS: $DO_KMP_DOWNLOADS"
|
||||
echo "CONFIGURATION: $CONFIG"
|
||||
echo
|
||||
### START OF THE BUILD ###
|
||||
|
||||
update_bundle ( ) {
|
||||
if ! [ -d "$BUNDLE_PATH" ]; then
|
||||
mkdir -p "$BUNDLE_PATH"
|
||||
fi
|
||||
|
||||
local base_dir="$(pwd)"
|
||||
|
||||
if [ $DO_KMW_BUILD = true ]; then
|
||||
echo Building KeymanWeb from $KMW_ROOT
|
||||
|
||||
KMW_PRODUCT=web/build/app/webview/
|
||||
KMW_RESOURCES=web/build/app/resources
|
||||
if [ "$CONFIG" == "Debug" ]; then
|
||||
KMWFLAGS="configure:app/webview build:app/webview --debug"
|
||||
KMW_PRODUCT="$KMW_PRODUCT/debug"
|
||||
else
|
||||
KMWFLAGS="configure:app/webview build:app/webview"
|
||||
KMW_PRODUCT="$KMW_PRODUCT/release"
|
||||
fi
|
||||
|
||||
# Local development optimization - cross-target Sentry uploading when requested
|
||||
# by developer. As it's not CI, the Web artifacts won't exist otherwise...
|
||||
# unless the developer manually runs the correct build configuration accordingly.
|
||||
if [[ $VERSION_ENVIRONMENT == "local" ]] && [[ $UPLOAD_SENTRY == true ]]; then
|
||||
# TODO: handle the -upload-sentry in its eventual new form
|
||||
KMWFLAGS="$KMWFLAGS -upload-sentry"
|
||||
fi
|
||||
|
||||
"$KEYMAN_ROOT/web/build.sh" $KMWFLAGS
|
||||
if [ $? -ne 0 ]; then
|
||||
builder_die "ERROR: KeymanWeb's build.sh failed."
|
||||
fi
|
||||
|
||||
#Copy over the relevant resources! It's easiest to do if we navigate to the resulting folder.
|
||||
cp "$KEYMAN_ROOT/$KMW_RESOURCES/osk/kmwosk.css" "$base_dir/$BUNDLE_PATH/kmwosk.css"
|
||||
cp "$KEYMAN_ROOT/$KMW_RESOURCES/osk/keymanweb-osk.ttf" "$base_dir/$BUNDLE_PATH/keymanweb-osk.ttf"
|
||||
cp "$KEYMAN_ROOT/$KMW_PRODUCT/keymanweb-webview.js" "$base_dir/$BUNDLE_PATH/keymanweb-webview.js"
|
||||
|
||||
if [ "$CONFIG" == "Debug" ]; then
|
||||
cp "$KEYMAN_ROOT/$KMW_PRODUCT/keymanweb-webview.js.map" "$base_dir/$BUNDLE_PATH/keymanweb-webview.js.map"
|
||||
elif [ -f "$base_dir/$BUNDLE_PATH/keymanweb-webview.js.map" ]; then
|
||||
rm "$base_dir/$BUNDLE_PATH/keymanweb-webview.js.map"
|
||||
fi
|
||||
|
||||
# Linked in by dependency for builder scripts... but this script isn't builder-based yet.
|
||||
"${KEYMAN_ROOT}/common/web/sentry-manager/build.sh"
|
||||
if [ $? -ne 0 ]; then
|
||||
builder_die "ERROR: Build of KMW's error reporter for Sentry failed."
|
||||
fi
|
||||
|
||||
cp "$KEYMAN_ROOT/node_modules/@sentry/browser/build/bundle.min.js" "$base_dir/$BUNDLE_PATH/sentry.min.js"
|
||||
cp "$KEYMAN_ROOT/common/web/sentry-manager/build/lib/index.js" "$base_dir/$BUNDLE_PATH/keyman-sentry.js"
|
||||
|
||||
fi
|
||||
|
||||
# Our default resources are part of the bundle, so let's check on them.
|
||||
if [ ! -f "$base_dir/$BUNDLE_PATH/$DEFAULT_KBD_ID.kmp" ]; then
|
||||
DO_KMP_DOWNLOADS=true
|
||||
builder_warn "OVERRIDE: Performing -download-resources run, as the keyboard package is missing!"
|
||||
elif [ ! -f "$base_dir/$BUNDLE_PATH/$DEFAULT_LM_ID.model.kmp" ]; then
|
||||
DO_KMP_DOWNLOADS=true
|
||||
builder_warn "OVERRIDE: Performing -download-resources run, as the lexical model package is missing!"
|
||||
fi
|
||||
|
||||
if [ $DO_KMP_DOWNLOADS = true ]; then
|
||||
builder_heading "Downloading up-to-date packages for default resources"
|
||||
|
||||
downloadKeyboardPackage "$DEFAULT_KBD_ID" "$base_dir/$BUNDLE_PATH/$DEFAULT_KBD_ID.kmp"
|
||||
downloadModelPackage "$DEFAULT_LM_ID" "$base_dir/$BUNDLE_PATH/$DEFAULT_LM_ID.model.kmp"
|
||||
|
||||
echo "${COLOR_GREEN}Packages successfully updated${COLOR_RESET}"
|
||||
|
||||
# If we aren't downloading resources, make sure copies of them already exist!
|
||||
fi
|
||||
function do_clean () {
|
||||
rm -rf $BUILD_PATH
|
||||
rm -rf Carthage
|
||||
}
|
||||
|
||||
# First things first - update our dependencies.
|
||||
update_bundle
|
||||
function carthage_die() {
|
||||
local msg="$1"
|
||||
|
||||
if [ $DO_CARTHAGE = true ]; then
|
||||
echo
|
||||
echo "Load dependencies with Carthage"
|
||||
# Don't leave a trace of the failed folder; we'd have to rebuild stuff anyway.
|
||||
# This way, a later re-run doesn't think `configure` succeeded when it did not.
|
||||
rm -rf Carthage
|
||||
builder_die "$1"
|
||||
}
|
||||
|
||||
carthage checkout || builder_die "Carthage dependency loading failed"
|
||||
function do_carthage() {
|
||||
carthage checkout || carthage_die "Carthage dependency loading failed"
|
||||
|
||||
# --no-use-binaries: due to https://github.com/Carthage/Carthage/issues/3134,
|
||||
# which affects the sentry-cocoa dependency.
|
||||
carthage build --use-xcframeworks --no-use-binaries --platform iOS || builder_die "Carthage dependency loading failed"
|
||||
fi
|
||||
carthage build --use-xcframeworks --no-use-binaries --platform iOS || carthage_die "Carthage dependency loading failed"
|
||||
}
|
||||
|
||||
echo
|
||||
echo "Build products will be set with the following version metadata:"
|
||||
echo " * VERSION=$VERSION"
|
||||
echo " * VERSION_WITH_TAG=$VERSION_WITH_TAG"
|
||||
echo " * VERSION_ENVIRONMENT=$VERSION_ENVIRONMENT"
|
||||
echo " * UPLOAD_SENTRY=$UPLOAD_SENTRY"
|
||||
echo
|
||||
echo "Building KMEI..."
|
||||
function do_packages() {
|
||||
if ! [ -d "$BUNDLE_PATH" ]; then
|
||||
mkdir -p "$BUNDLE_PATH"
|
||||
fi
|
||||
|
||||
if [ -d "$BUILD_PATH/$CONFIG-universal" ]; then
|
||||
rm -r $BUILD_PATH/$CONFIG-universal
|
||||
fi
|
||||
local base_dir="$(pwd)"
|
||||
|
||||
run_xcodebuild $XCODEFLAGS_EXT $CODE_SIGN -scheme KME-universal \
|
||||
VERSION=$VERSION \
|
||||
VERSION_WITH_TAG=$VERSION_WITH_TAG \
|
||||
VERSION_ENVIRONMENT=$VERSION_ENVIRONMENT \
|
||||
UPLOAD_SENTRY=$UPLOAD_SENTRY
|
||||
downloadKeyboardPackage "$DEFAULT_KBD_ID" "$base_dir/$BUNDLE_PATH/$DEFAULT_KBD_ID.kmp"
|
||||
downloadModelPackage "$DEFAULT_LM_ID" "$base_dir/$BUNDLE_PATH/$DEFAULT_LM_ID.model.kmp"
|
||||
}
|
||||
|
||||
assertDirExists "$KEYMAN_XCFRAMEWORK"
|
||||
function do_configure ( ) {
|
||||
do_packages
|
||||
do_carthage
|
||||
}
|
||||
|
||||
echo "KMEI build complete."
|
||||
# Manages KeymanEngine.bundle, which is included inside the :engine target.
|
||||
function update_bundle ( ) {
|
||||
if ! [ -d "$BUNDLE_PATH" ]; then
|
||||
mkdir -p "$BUNDLE_PATH"
|
||||
fi
|
||||
|
||||
if [ $DO_KEYMANAPP = true ]; then
|
||||
echo ""
|
||||
local base_dir="$(pwd)"
|
||||
|
||||
KMW_PRODUCT=web/build/app/webview/
|
||||
KMW_RESOURCES=web/build/app/resources
|
||||
if builder_has_option --debug; then
|
||||
KMW_PRODUCT="$KMW_PRODUCT/debug"
|
||||
else
|
||||
KMW_PRODUCT="$KMW_PRODUCT/release"
|
||||
fi
|
||||
|
||||
#Copy over the relevant resources! It's easiest to do if we navigate to the resulting folder.
|
||||
cp "$KEYMAN_ROOT/$KMW_RESOURCES/osk/kmwosk.css" "$base_dir/$BUNDLE_PATH/kmwosk.css"
|
||||
cp "$KEYMAN_ROOT/$KMW_RESOURCES/osk/keymanweb-osk.ttf" "$base_dir/$BUNDLE_PATH/keymanweb-osk.ttf"
|
||||
cp "$KEYMAN_ROOT/$KMW_PRODUCT/keymanweb-webview.js" "$base_dir/$BUNDLE_PATH/keymanweb-webview.js"
|
||||
|
||||
if builder_has_option --debug; then
|
||||
cp "$KEYMAN_ROOT/$KMW_PRODUCT/keymanweb-webview.js.map" "$base_dir/$BUNDLE_PATH/keymanweb-webview.js.map"
|
||||
elif [ -f "$base_dir/$BUNDLE_PATH/keymanweb-webview.js.map" ]; then
|
||||
rm "$base_dir/$BUNDLE_PATH/keymanweb-webview.js.map"
|
||||
fi
|
||||
|
||||
cp "$KEYMAN_ROOT/node_modules/@sentry/browser/build/bundle.min.js" "$base_dir/$BUNDLE_PATH/sentry.min.js"
|
||||
cp "$KEYMAN_ROOT/common/web/sentry-manager/build/lib/index.js" "$base_dir/$BUNDLE_PATH/keyman-sentry.js"
|
||||
}
|
||||
|
||||
# First things first - update our dependencies.
|
||||
function build_engine() {
|
||||
update_bundle
|
||||
|
||||
echo
|
||||
echo "Build products will be set with the following version metadata:"
|
||||
echo " * VERSION=$VERSION"
|
||||
echo " * VERSION_WITH_TAG=$VERSION_WITH_TAG"
|
||||
echo " * VERSION_ENVIRONMENT=$VERSION_ENVIRONMENT"
|
||||
echo " * UPLOAD_SENTRY=$UPLOAD_SENTRY"
|
||||
echo
|
||||
echo "Building KMEI..."
|
||||
|
||||
if [ -d "$BUILD_PATH/$CONFIG-universal" ]; then
|
||||
rm -r $BUILD_PATH/$CONFIG-universal
|
||||
fi
|
||||
|
||||
run_xcodebuild $XCODEFLAGS_EXT $CODE_SIGN -scheme KME-universal \
|
||||
VERSION=$VERSION \
|
||||
VERSION_WITH_TAG=$VERSION_WITH_TAG \
|
||||
VERSION_ENVIRONMENT=$VERSION_ENVIRONMENT \
|
||||
UPLOAD_SENTRY=$UPLOAD_SENTRY
|
||||
|
||||
assertDirExists "$KEYMAN_XCFRAMEWORK"
|
||||
}
|
||||
|
||||
# TODO: split into separate script (so it can @depend on build:engine)
|
||||
function build_app() {
|
||||
echo "Building offline help."
|
||||
build_help_html ios keyman/Keyman/Keyman/resources/OfflineHelp.bundle/Contents/Resources
|
||||
|
||||
|
|
@ -272,37 +181,29 @@ if [ $DO_KEYMANAPP = true ]; then
|
|||
DEV_TEAM=
|
||||
fi
|
||||
|
||||
if [ $DO_ARCHIVE = false ]; then
|
||||
run_xcodebuild $XCODEFLAGS_EXT $CODE_SIGN -scheme Keyman \
|
||||
VERSION=$VERSION \
|
||||
VERSION_WITH_TAG=$VERSION_WITH_TAG \
|
||||
VERSION_ENVIRONMENT=$VERSION_ENVIRONMENT \
|
||||
UPLOAD_SENTRY=$UPLOAD_SENTRY
|
||||
else
|
||||
# Time to prepare the deployment archive data.
|
||||
echo ""
|
||||
echo "Preparing .xcarchive for real devices."
|
||||
run_xcodebuild $XCODEFLAGS_EXT $CODE_SIGN -scheme Keyman \
|
||||
-archivePath $ARCHIVE_PATH \
|
||||
archive -allowProvisioningUpdates \
|
||||
VERSION=$VERSION \
|
||||
VERSION_WITH_TAG=$VERSION_WITH_TAG \
|
||||
VERSION_ENVIRONMENT=$VERSION_ENVIRONMENT \
|
||||
UPLOAD_SENTRY=$UPLOAD_SENTRY
|
||||
# Time to prepare the deployment archive data.
|
||||
echo ""
|
||||
echo "Preparing .xcarchive for real devices."
|
||||
run_xcodebuild $XCODEFLAGS_EXT $CODE_SIGN -scheme Keyman \
|
||||
-archivePath $ARCHIVE_PATH \
|
||||
archive -allowProvisioningUpdates \
|
||||
VERSION=$VERSION \
|
||||
VERSION_WITH_TAG=$VERSION_WITH_TAG \
|
||||
VERSION_ENVIRONMENT=$VERSION_ENVIRONMENT \
|
||||
UPLOAD_SENTRY=$UPLOAD_SENTRY
|
||||
|
||||
assertDirExists "$ARCHIVE_PATH"
|
||||
assertDirExists "$ARCHIVE_PATH"
|
||||
|
||||
if [ $DO_CODE_SIGN == true ]; then
|
||||
echo "Preparing .ipa file for deployment to real devices"
|
||||
# Do NOT use the _EXT variant here; there's no scheme to ref, which will lead
|
||||
# Xcode to generate a build error.
|
||||
run_xcodebuild $XCODEFLAGS -exportArchive -archivePath $ARCHIVE_PATH \
|
||||
-exportOptionsPlist exportAppStore.plist \
|
||||
-exportPath $BUILD_PATH/${CONFIG}-iphoneos -allowProvisioningUpdates
|
||||
fi
|
||||
if ! builder_has_option --debug; then
|
||||
echo "Preparing .ipa file for deployment to real devices"
|
||||
# Do NOT use the _EXT variant here; there's no scheme to ref, which will lead
|
||||
# Xcode to generate a build error.
|
||||
run_xcodebuild $XCODEFLAGS -exportArchive -archivePath $ARCHIVE_PATH \
|
||||
-exportOptionsPlist exportAppStore.plist \
|
||||
-exportPath $BUILD_PATH/${CONFIG}-iphoneos -allowProvisioningUpdates
|
||||
fi
|
||||
|
||||
if [ $DO_SIMULATOR_TARGET == true ]; then
|
||||
if builder_has_option --sim-artifact; then
|
||||
echo "Preparing .app file for simulator-targeted artifact for testing"
|
||||
run_xcodebuild $XCODEFLAGS_EXT $CODE_SIGN -scheme Keyman \
|
||||
-sdk iphonesimulator \
|
||||
|
|
@ -311,7 +212,9 @@ if [ $DO_KEYMANAPP = true ]; then
|
|||
VERSION_ENVIRONMENT=$VERSION_ENVIRONMENT \
|
||||
UPLOAD_SENTRY=$UPLOAD_SENTRY
|
||||
fi
|
||||
}
|
||||
|
||||
echo
|
||||
echo "Build succeeded."
|
||||
fi
|
||||
builder_run_action clean do_clean
|
||||
builder_run_action configure do_configure
|
||||
builder_run_action build:engine build_engine
|
||||
builder_run_action build:app build_app
|
||||
Loading…
Add table
Reference in a new issue