Breaking changes
- custom commands no longer get a JSON result file (
-rf) from Jackson annotations (@JsonSerialize,@JsonProperty) on their result classes. Jackson stays relocated and invisible to commands, so the annotations have no effect; the CLI logs a warning naming the class. Result files of the built-in commands are unchanged. - Airline is no longer relocated: the CLI and custom commands share it again, as in 4.8.8. A plugin's own copy of Airline is ignored (parent-first classloader), so commands must be built against the Airline version of the CLI. Workaround service files named
com.espirit.moddev.cli.shaded.airline...in extension JARs are no longer used and can be deleted. - custom command JARs belong into
lib/;plugins/is only scanned for script engines.
Fixes
- fixed
fs-cli help <command>printing no EXAMPLES section since 4.8.9 (GitHub issue #64), and option restrictions (required, allowed values, ranges, paths) and custom commands not working. Airline'sMETA-INF/servicesfiles were not renamed with the relocated classes. - the
META-INF/servicesfiles of the libraries that stay relocated (Jackson) are now renamed and rewritten with them.
- added the
downloadmode tofs-cli.shandfs-cli.cmd:fs-cli download [<url>] [<user>] [<password>] [--force]fetches the matchingfs-isolated-runtime.jarfrom a FirstSpirit server intolib/(saved asfs-isolated-runtime-<version>.jar). Url, user and password fall back to the environment variablesfsurl(http://is prepended if it has no scheme),fsuserandfspwd. It requirescurland does not needJAVA_HOME. A different runtime version inlib/is replaced automatically;--forcedownloads even if the jar of the server version is already present.
- upgraded bundled Jackson from 2.18.3 to 3.2.0 (
tools.jackson.core:jackson-databind) - all CLI-bundled third-party libraries are now package-relocated in the uber JAR under
com.espirit.moddev.cli.shaded.*— this eliminatesNoSuchFieldError/NoSuchMethodErrorclassloading conflicts that occurred when client-side module UploadHooks (e.g. image-recognition) bundled their own newer version ofjackson-annotationsalongside the CLI
- added new global parameters "--conn-encryption" and "--conn-compression" to configure the encryption and compression of the FirstSpirit connection
For more information about the new parameters, please use "fs-cli help" or open the included documentation under docs/index.html.
- updated Gradle to 8.13
- fixed logging with newer FirstSpirit versions
- provide more context for script parsing errors
- fixed log level configuration
- updated Gradle to 8.7
- build-scripts migrated from Groovy to Kotlin, use version catalogues for dependencies
- artifacts now generated with Java 17
- handle missing configuration file in FirstSpirit server install (used for external integration scenarios)
- added new parameters "--permissionMode" and "--updateExistingPermissions" to "feature download" command
For more information about the new parameters, please use "fs-cli help feature download" or open the included documentation under docs/index.html.
- new commands for executing external scripts (beanshell by default):
- "script run": executes an external script
- "script parse": parses an external script, but does not execute it
For more information about the new commands, please use "fs-cli help script" or open the included documentation under docs/index.html.
- added new parameter "--include-feature-model" to "feature install" command
For more information about the new parameter, please use "fs-cli help feature install" or open the included documentation under docs/index.html.
- fixed java.lang.Error not getting handled in general
- commands "module install" & "module installBulk":
- fixed java.lang.Error aborting the complete process
- updated FirstSpirit compile dependency to 5.2.230409 (was 5.2.220907)
- implemented missing methods in FsLoggingBridge
- added new parameter "--run-level/-rl" to "server start" command
- new command for Content Transport:
- "feature revision": updates the revision of the specified feature
For more information about the new command, please use "fs-cli help feature revision" or open the included documentation under docs/index.html.
- updated default log4J2.xml to reduce the default logging for some packages, this was a regression of v4.0.0
- fixed exceptions being logged twice under some circumstances
- commands "module install" & "module installBulk":
- project app components will now be updated by the CLI instead of the FirstSpirit server
- web app components will now be updated by the CLI instead of the FirstSpirit server
- fixed parameter "--deployWebApps/-dwa" not working properly
- new commands for Content Transport:
- "feature list": lists all features for the specified project
- "feature download": downloads the specified feature
- "feature analyze": analyzes the specified feature in the project and logs the result
- "feature install": analyzes & installs the specified feature in the project
For more information about the new commands, please use "fs-cli help feature" or open the included documentation under docs/index.html.
- fixed logging for MultiExceptions in "module installBulk" command
- added missing add-opens for JDK 17
- updated Gradle to 7.5.1 (was 7.1.1)
- updated minimal required FirstSpirit version to 5.2.220907 (was 5.2.210710)
- fixed error in start script (WIN only)
- moved to Log4J 2.17.2
- moved to JUnit 5
- updated used libraries to latest versions
- updated Gradle to 7.1.1 (was 5.5.1)
- updated dependent gradle plugins to latest versions
- updated used libraries to latest versions
- command "import": clarified error messages if project exists and is deactivated or maximum projects on server are exceeded
- switched to semantic versioning 2.0.0
- updated minimal required FirstSpirit version to 5.2.210710 (was 5.2.200807)
- command "export": added support for permission transport (new parameter: --permissionMode)
- command "import": added support for permission transport (new parameters: --permissionMode, --updateExistingPermissions)
- added RELEASENOTES.md
- fixed compatibility for JDK16
- WIN only: fixed whitespaces in execution path not working
- added link to ExternalSync documentation in README
- enhanced logging for module installation
- UNIX only: fixed file permissions (regression in 2.6.7)
- added support for new FirstSpirit wrapper scripts
- inactive web apps or web apps without an active webserver will no longer get re-deployed
- fixed and enhanced logging for web app deployment process
- added option to disable wrapper restarts
- NEW command: "module configure"
- refactoring of internal project structure
- please see the commit history for details