maint(common): consolidate builder scripts 🐸 by mcdurdin · Pull Request #14449 · keymanapp/keyman

mcdurdin · 2025-08-01T21:59:18Z

Clarifies the confusing builder.inc.sh / build-utils.sh distinction by giving the scripts more appropriate names. Most build scripts should use builder-full.inc.sh; some helper scripts can use builder-basic.inc.sh. Documented in resources/build/README.md.

Renames:

resources/build/builder.inc.sh to resources/build/builder-full.inc.sh
resources/build/build-utils.sh to resources/build/builder-basic.inc.sh

Other changes:

Moves Android-specific functions out of builder-basic.inc.sh and into android/build.sh.
Renames functions in builder-basic.inc.sh

More functions may be moved from builder-basic.inc.sh into utils.inc.sh or other scripts in the future.

Note: deb-packaging.yml currently depends on build-utils.sh, and is sourced from master branch -- while its imports come from the current branch for the build. So a temporary copy of build-utils.sh is retained in order for this branch's builds (and child branches) to pass, but should be removed in a follow-up PR once this branch lands.

Fixes: #14065
Build-bot: build all
Test-bot: skip

keymanapp-test-bot · 2025-08-01T21:59:21Z

User Test Results

Test specification and instructions

User tests are not required

Test Artifacts

Android
Developer
iOS
- TestFlight internal PR build version - 19.0.95 (0.14449.14093)
Keyboards
macOS
Web
Windows

mcdurdin · 2025-08-01T22:12:36Z

android/build.sh

+
+# For CI compatibility of building Keyman for Android 18.0 with OpenJDK 11,
+# this overrides JAVA_HOME for the builder script to use OpenJDK 21.
+android_set_java_home() {
+  if [[ ! -z ${JAVA_HOME_21+x} ]]; then
+    builder_echo "Setting JAVA_HOME to JAVA_HOME_21 (${JAVA_HOME_21})"
+    export JAVA_HOME="${JAVA_HOME_21}"
+  fi
+}
+
+# Override JAVA_HOME
+android_set_java_home


I wonder if we should move this to the TC script wrappers?

I think I prefer a general location since it's used in local dev builds

mcdurdin · 2025-08-01T22:18:34Z

resources/build/builder-basic.inc.sh

-# For CI compatibility of building Keyman for Android 18.0 with OpenJDK 11,
-# this overrides JAVA_HOME for the builder script to use OpenJDK 21.
-set_java_home() {
-  set_java_home_21
-}
-
-set_java_home_21() {
-  if [[ ! -z ${JAVA_HOME_21+x} ]]; then
-    builder_echo "Setting JAVA_HOME to JAVA_HOME_21 (${JAVA_HOME_21})"
-    export JAVA_HOME="${JAVA_HOME_21}"
-  fi
-}
-
-set_java_home_11() {
-  if [[ ! -z ${JAVA_HOME_11+x} ]]; then
-    builder_echo "Setting JAVA_HOME to JAVA_HOME_11 (${JAVA_HOME_11})"
-    export JAVA_HOME="${JAVA_HOME_11}"
-  fi
-}
-


Moved to android/build.sh

…ackaging.yml deb-packaging.yml runs from master, so we need to continue to source build-utils.sh until v19 release, so that we can build v18 branches. Note that deb-packaging.yml will not successfully build on the #14449 branch until this change is merged to master. Fixes: #14065

Fixes: #14065

The file build-utils.sh can be deleted in a follow-up PR once #14449 hits master.

darcywong00 · 2025-08-11T06:38:18Z

docs/builder.md

@@ -1,4 +1,4 @@
-# Using the build-utils.sh builder functions
+# Using the builder-basic.inc.sh builder functions


Most build scripts should use builder-full.inc.sh; some helper scripts can use builder-basic.inc.sh. Documented in resources/build/README.md.

Should this doc also have a brief clarification?

Can do in a follow-up PR

darcywong00

lgtm

Relates-to: #14449 (comment) Build-bot: skip Test-bot: skip

keyman-server · 2025-08-13T03:00:22Z

Changes in this pull request will be available for download in Keyman version 19.0.95-alpha

keyman-server · 2025-08-13T18:03:34Z

Changes in this pull request will be available for download in Keyman version 19.0.95-alpha

ermshiperete · 2025-08-18T15:09:04Z

Do we have a v20 maintenance issue for removing the temporary copy of build-utils.sh?

mcdurdin · 2025-08-19T07:09:11Z

Do we have a v20 maintenance issue for removing the temporary copy of build-utils.sh?

We do now, see #14549.

github-project-automation bot added this to Keyman Aug 1, 2025

github-project-automation bot moved this to Todo in Keyman Aug 1, 2025

keymanapp-test-bot bot added this to the A19S8 milestone Aug 1, 2025

mcdurdin force-pushed the maint/common/14065-consolidate-builder-scripts branch from 4495a4a to f394245 Compare August 1, 2025 22:11

mcdurdin commented Aug 1, 2025

View reviewed changes

darcywong00 modified the milestones: A19S8, A19S9 Aug 2, 2025

mcdurdin added 2 commits August 2, 2025 13:16

maint(common): additional builder.inc.sh script renames

47e2133

Fixes: #14065

maint(common): fixup jedi build.sh builder-basic.inc.sh include

ebe7a13

Fixes: #14065

mcdurdin linked an issue Aug 2, 2025 that may be closed by this pull request

maint(common): consolidate builder and related scripts #14065

Closed

mcdurdin added a commit that referenced this pull request Aug 5, 2025

maint(common): re-add build-utils.sh in order to pass all builds

eb9ce59

The file build-utils.sh can be deleted in a follow-up PR once #14449 hits master.

maint(common): re-add build-utils.sh in order to pass all builds

0bcce97

The file build-utils.sh can be deleted in a follow-up PR once #14449 hits master.

mcdurdin force-pushed the maint/common/14065-consolidate-builder-scripts branch from eb9ce59 to 0bcce97 Compare August 5, 2025 00:56

mcdurdin marked this pull request as ready for review August 5, 2025 02:58

mcdurdin changed the title ~~maint(common): consolidate builder scripts~~ maint(common): consolidate builder scripts 🐸 Aug 5, 2025

darcywong00 reviewed Aug 11, 2025

View reviewed changes

darcywong00 approved these changes Aug 11, 2025

View reviewed changes

Base automatically changed from maint/common/14275-rename-and-cleanup-shellHelperFunctions.sh to master August 12, 2025 03:41

mcdurdin merged commit a81138c into master Aug 12, 2025
29 checks passed

mcdurdin deleted the maint/common/14065-consolidate-builder-scripts branch August 12, 2025 03:41

github-project-automation bot moved this from Todo to Done in Keyman Aug 12, 2025

mcdurdin added a commit that referenced this pull request Aug 12, 2025

docs(resources): note on builder-basic vs builder-full

40253fd

Relates-to: #14449 (comment) Build-bot: skip Test-bot: skip

mcdurdin mentioned this pull request Aug 12, 2025

docs(resources): add note on builder-basic vs builder-full #14507

Merged

mcdurdin mentioned this pull request Aug 13, 2025

bug(linux): Ubuntu packaging build fails because it imports both builder-basic and build-utils #14512

Closed

keymanapp deleted a comment from keyman-server Aug 13, 2025

mcdurdin mentioned this pull request Aug 19, 2025

maint(resources): remove the temporary copy of build-utils.sh #14549

Open

darcywong00 mentioned this pull request Aug 27, 2025

maint: add latest version of builder.inc.sh from keymanapp/keyman keymanapp/shared-sites#75

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

maint(common): consolidate builder scripts 🐸#14449

maint(common): consolidate builder scripts 🐸#14449
mcdurdin merged 5 commits intomasterfrom
maint/common/14065-consolidate-builder-scripts

mcdurdin commented Aug 1, 2025 •

edited

Loading

Uh oh!

keymanapp-test-bot bot commented Aug 1, 2025 •

edited

Loading

Uh oh!

mcdurdin Aug 1, 2025

Uh oh!

darcywong00 Aug 11, 2025

Uh oh!

mcdurdin Aug 1, 2025

Uh oh!

darcywong00 Aug 11, 2025

Uh oh!

mcdurdin Aug 12, 2025

Uh oh!

darcywong00 left a comment

Uh oh!

Uh oh!

keyman-server commented Aug 13, 2025

Uh oh!

keyman-server commented Aug 13, 2025

Uh oh!

ermshiperete commented Aug 18, 2025

Uh oh!

mcdurdin commented Aug 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		@@ -1,4 +1,4 @@
		# Using the build-utils.sh builder functions
		# Using the builder-basic.inc.sh builder functions

Uh oh!

Conversation

mcdurdin commented Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

keymanapp-test-bot bot commented Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

User Test Results

Test Artifacts

Uh oh!

mcdurdin Aug 1, 2025

Choose a reason for hiding this comment

Uh oh!

darcywong00 Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

mcdurdin Aug 1, 2025

Choose a reason for hiding this comment

Uh oh!

darcywong00 Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

mcdurdin Aug 12, 2025

Choose a reason for hiding this comment

Uh oh!

darcywong00 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

keyman-server commented Aug 13, 2025

Uh oh!

keyman-server commented Aug 13, 2025

Uh oh!

ermshiperete commented Aug 18, 2025

Uh oh!

mcdurdin commented Aug 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mcdurdin commented Aug 1, 2025 •

edited

Loading

keymanapp-test-bot bot commented Aug 1, 2025 •

edited

Loading