Skip to content

Commit 6c145cb

Browse files
committed
refactor(web): move web engine help to app repo
Note: build.sh updated to make sure that test:help build action:target doesn't also call test.sh by adding `:_all` meta-target. Note: CI will need a new help-keyman-com.sh build step to deploy web engine help. Fixes: #12347
1 parent 81673c6 commit 6c145cb

File tree

306 files changed

+7838
-5
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

306 files changed

+7838
-5
lines changed

resources/build/help-keyman-com.sh

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,9 @@ function upload_keyman_help {
9090
mac)
9191
upload mac/docs/help products/mac/$VERSION_RELEASE
9292
;;
93+
web)
94+
upload web/docs/engine developer/engine/web/$VERSION_RELEASE
95+
;;
9396
windows)
9497
# Note: `/windows/src/desktop/help/build.sh web` must be run first
9598
upload windows/bin/help/md/desktop products/windows/$VERSION_RELEASE
@@ -120,7 +123,7 @@ while [[ $# -gt 0 ]] ; do
120123
display_usage
121124
exit 0
122125
;;
123-
android | ios | linux | mac | windows | developer)
126+
android | ios | linux | mac | windows | developer | web)
124127
platform=$key
125128
;;
126129
*)

web/build.sh

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
1414

1515
builder_set_child_base src
1616
builder_describe "Builds engine modules for Keyman Engine for Web (KMW)." \
17+
\
18+
"@/resources/tools/check-markdown test:help" \
19+
\
1720
"clean" \
1821
"configure" \
1922
"build" \
@@ -33,9 +36,11 @@ builder_describe "Builds engine modules for Keyman Engine for Web (KMW)." \
3336
":engine/main Builds all common code used by KMW's app/-level targets" \
3437
":engine/osk Builds the Web OSK module" \
3538
":engine/predictive-text=src/engine/predictive-text/worker-main Builds KMW's predictive text module" \
39+
":help Online documentation" \
3640
":samples Builds all needed resources for the KMW sample-page set" \
3741
":tools Builds engine-related development resources" \
3842
":test-pages=src/test/manual Builds resources needed for the KMW manual testing pages" \
43+
":_all (Meta build target used when targets are not specified)" \
3944
"--ci+ Set to utilize CI-based test configurations & reporting."
4045

4146
# Possible TODO?
@@ -182,11 +187,17 @@ builder_run_child_actions build:tools
182187
builder_run_child_actions build:test-pages
183188

184189
# Build tests
185-
builder_run_action build build_action
190+
builder_run_action build:_all build_action
186191

187192
# Run tests
188-
builder_run_child_actions test
189-
builder_run_action test test_action
193+
# builder_run_child_actions test
194+
builder_run_action test:_all test_action
195+
196+
function do_test_help() {
197+
check-markdown "$KEYMAN_ROOT/web/docs/engine"
198+
}
199+
200+
builder_run_action test:help do_test_help
190201

191202
# Create coverage report
192-
builder_run_action coverage coverage_action
203+
builder_run_action coverage:_all coverage_action
12.2 KB
Loading
650 Bytes
Loading
413 Bytes
Loading
7.01 KB
Loading
931 Bytes
Loading
2.63 KB
Loading
3.33 KB
Loading
6.95 KB
Loading

0 commit comments

Comments
 (0)