spiegel-keyman/common/web/keyman-version/build.sh
Eberhard Beilharz 4d81589f48
maint(common): use unique names for Keyman version variables
Previously the builder scripts defined a readonly `VERSION` environment
variable for the Keyman version. That caused problems when another
(external) script tried to define a `VERSION` variable. We encountered
this problem when trying to move the TC build steps of a configuration
into a single script (#13399) when we tried to source `~/.nvm/nvm.sh`.

This change uses a Keyman specific prefix for the version variables and
renames `VERSION` → `KEYMAN_VERSION` etc. Unfortunately these variables
are used in a lot of places, so this turned out to be a bit of a yak
shave.

Test-bot: skip
2025-05-07 18:46:51 +02:00

58 lines
2.1 KiB
Bash
Executable file

#!/usr/bin/env bash
## START STANDARD BUILD SCRIPT INCLUDE
# adjust relative paths as necessary
THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
. "${THIS_SCRIPT%/*}/../../../resources/build/builder.inc.sh"
## END STANDARD BUILD SCRIPT INCLUDE
. "$KEYMAN_ROOT/resources/shellHelperFunctions.sh"
. "$KEYMAN_ROOT/resources/build/build-utils-ci.inc.sh"
################################ Main script ################################
builder_describe "Build the include script for current Keyman version" \
configure \
clean \
build \
test \
"publish publish to npm" \
"--npm-publish+ For publish, do a npm publish, not npm pack (only for CI)" \
"--dry-run,-n don't actually publish, just dry run"
builder_describe_outputs \
configure "/node_modules" \
build "/common/web/keyman-version/build/version.inc.js"
builder_parse "$@"
function do_build() {
# Generate version.inc.ts
echo "
// Generated by common/web/keyman-version/build.sh
//
// Note: does not use the 'default' keyword so that the export name is
// correct when converted to a CommonJS module with \`esbuild\`.
export class KEYMAN_VERSION {
static readonly VERSION = \"$KEYMAN_VERSION\";
static readonly VERSION_RELEASE =\"$KEYMAN_VERSION_RELEASE\";
static readonly VERSION_MAJOR = \"$KEYMAN_VERSION_MAJOR\";
static readonly VERSION_MINOR = \"$KEYMAN_VERSION_MINOR\";
static readonly VERSION_PATCH = \"$KEYMAN_VERSION_PATCH\";
static readonly TIER =\"$KEYMAN_TIER\";
static readonly VERSION_TAG = \"$KEYMAN_VERSION_TAG\";
static readonly VERSION_WITH_TAG = \"$KEYMAN_VERSION_WITH_TAG\";
static readonly VERSION_ENVIRONMENT = \"$KEYMAN_VERSION_ENVIRONMENT\";
static readonly VERSION_GIT_TAG = \"$KEYMAN_VERSION_GIT_TAG\";
}
// Also provides it as a 'default' export.
export default KEYMAN_VERSION;
" > ./version.inc.ts
tsc --build $builder_verbose
}
builder_run_action clean rm -rf version.inc.ts keyman-version.mts build/
builder_run_action configure verify_npm_setup
builder_run_action build do_build
builder_run_action publish builder_publish_npm