UNOMI-887: Introduce consolidated build.sh; remove legacy build scripts #737
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add build.sh: unified build/deploy/run script with robust error handling, colorized/structured output, and preflight checks (tools, system resources, Maven settings, ports). Support rich CLI options: tests/integration, OpenSearch, debug/ports/suspend, offline/cache control, migration-test skip, single-test, deploy to Karaf. Replace legacy scripts: remove buildAndRun.sh, buildAndRunNoTests.sh, compileDeploy.sh, generate-package.sh. Improve DX: clearer failures, consistent workflows across environments, NO_COLOR adherence, macOS/Linux friendly (incl. Apple Silicon hints). Notes: deployment expects UNOMI_VERSION for KAR/package paths; optional Geo databases copied when present. No code changes to modules; build behavior is unchanged unless new flags are used.
Contributor
|
Thanks for the PR! |
jsinovassin
requested changes
Nov 20, 2025
- Fix color readability in build.sh examples section: replace GRAY with NC
(no color) for better terminal readability. Use NC once at the start
instead of wrapping each line with color codes.
- Add comprehensive documentation for build.sh script in Building section:
* Add brief mention at the start of Building section with cross-reference
* Add new "Using the build.sh script" subsection with:
- Overview of script features and benefits
- Step-by-step usage instructions
- Complete set of examples matching build.sh --help output
- All examples use plain commands without prompt markers
- Minor formatting: align help output option descriptions for consistency
The documentation examples now exactly match those displayed by build.sh --help,
ensuring consistency between the script and its documentation.
Contributor
Author
|
Hello @jsinovassin thanks for the review. I have addressed your change request and also added documentation about the script in the building documentation. |
jsinovassin
approved these changes
Nov 27, 2025
Contributor
jsinovassin
left a comment
jsinovassin
left a comment
There was a problem hiding this comment.
Seems good! Thank you for the update.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR implements UNOMI-887 by introducing a single, enhanced build.sh for Unomi 3.x that standardizes build, deploy, and optional Karaf run. It replaces multiple ad‑hoc scripts and adds strong error handling, readable output, and comprehensive environment validation.
What’s changed
Rationale
How to use
Testing done
Backwards compatibility
Documentation