From 4c6aa6dc002863b3646d9b21c0fe4c74596f3b9f Mon Sep 17 00:00:00 2001 From: Trevor Crawford Date: Fri, 30 Sep 2022 15:33:47 -0400 Subject: [PATCH 1/6] Add binary scanner license to README --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f3830513..30210972 100644 --- a/README.md +++ b/README.md @@ -94,13 +94,13 @@ The Liberty plugin provides the following tasks for your project: | [cleanDirs](docs/clean.md#clean-task) | Cleans the Liberty server logs, workarea, and applications folders.| | [compileJsp](docs/compileJsp.md) | Compiles the JSP files from the src/main/webapp directory into the build/classes directory. | | [deploy](docs/deploy.md#deploy-task) | Deploys one or more applications to a Liberty server. | -| [generateFeatures](docs/generateFeatures.md#generateFeatures-task) | Scan the class files of an application and create a Liberty configuration file in the source configuration directory containing the Liberty features the application requires. | +| [generateFeatures](docs/generateFeatures.md#generateFeatures-task) | Scan the class files of an application and create a Liberty configuration file in the source configuration directory that contains the Liberty features the application requires.* | | [installFeature](docs/installFeature.md#installfeature-task) | Installs an additional feature to the Liberty runtime. | | [installLiberty](docs/installLiberty.md#installliberty-task) | Installs the Liberty runtime from a repository. | | [libertyCreate](docs/libertyCreate.md#libertycreate-task) | Creates a Liberty server. | | [libertyDebug](docs/libertyDebug.md) | Runs the Liberty server in the console foreground after a debugger connects to the debug port (default: 7777). | -| [libertyDev](docs/libertyDev.md) | Start a Liberty server in dev mode. | -| [libertyDevc](docs/libertyDev.md#libertydevc-task-container-mode) | Start a Liberty server in dev mode in a container. | +| [libertyDev](docs/libertyDev.md) | Start a Liberty server in dev mode.* | +| [libertyDevc](docs/libertyDev.md#libertydevc-task-container-mode) | Start a Liberty server in dev mode in a container.* | | [libertyDump](docs/libertyDump.md#libertydump-task) | Dumps diagnostic information from the Liberty server into an archive. | | [libertyJavaDump](docs/libertyJavaDump.md#libertyjavadump-task) | Dumps diagnostic information from the Liberty server JVM. | | [libertyPackage](docs/libertyPackage.md#libertypackage-task) | Packages a Liberty server. | @@ -112,6 +112,9 @@ The Liberty plugin provides the following tasks for your project: | [undeploy](docs/undeploy.md#undeploy-task) | Removes applications from the Liberty server. | | [uninstallFeature](docs/uninstallFeature.md#uninstallfeature-task) | Remove a feature from the Liberty runtime. | +*The `libertyDev`, `libertyDevc`, and `generateFeatures` tasks have a runtime dependency on IBM WebSphere Application Server Migration Toolkit for Application Binaries, which is separately licensed under IBM License Agreement for Non-Warranted Programs. See license [here](https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/wasdev/license/wamt). +Note: The `libertyDev` and `libertyDevc` tasks have this dependency only when auto-generation of features is turned on. By default, auto-generation of features is turned off. + ### Task ordering The Liberty Gradle plugin defines a built-in task order to allow a user to call an end task without worrying about calling the necessary tasks in between. By having the plugin manage tasks and their order of execution we can easily avoid some simple human errors. For example, in order to have a majority of the tasks function, the principal task `installLiberty` must be called, which our plugin would do for you. From d60072ced83d500bceb084e85e3c51dfdeb14c9a Mon Sep 17 00:00:00 2001 From: Trevor Crawford Date: Fri, 30 Sep 2022 15:38:51 -0400 Subject: [PATCH 2/6] Add binary scanner license to libertyDev.md --- docs/libertyDev.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/libertyDev.md b/docs/libertyDev.md index 1c74637c..106ea943 100644 --- a/docs/libertyDev.md +++ b/docs/libertyDev.md @@ -3,7 +3,7 @@ Start a Liberty instance in dev mode. This task also invokes the `libertyCreate`, `installFeature`, and `deploy` tasks before starting the runtime. **Note:** This task is designed to be executed directly from the Gradle command line. -N.B. starting in 3.4.1, dev mode invokes `generateFeatures` if the `generateFeatures` configuration parameter is set to `true` (default is `false`). **This task will modify the source configuration directory of your application.** See [generateFeatures](generateFeatures.md) for details. +Starting in version 3.4.1, dev mode invokes the `generateFeatures` task when the `generateFeatures` configuration parameter is set to `true`. **This task modifies the source configuration directory of your application.** See [generateFeatures](generateFeatures.md) for details. The default value for the `generateFeatures` parameter is `false`. When auto-generation of features is turned on, dev mode has a runtime dependency on IBM WebSphere Application Server Migration Toolkit for Application Binaries, which is separately licensed under IBM License Agreement for Non-Warranted Programs. See license [here](https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/wasdev/license/wamt). **Limitations:** This task is not supported with Spring Boot applications. From 4da1da332f48ab63d0b59805a5e68004531fa599 Mon Sep 17 00:00:00 2001 From: Trevor Crawford Date: Fri, 30 Sep 2022 15:42:58 -0400 Subject: [PATCH 3/6] Add binary scanner license to generateFeatures.md --- docs/generateFeatures.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/generateFeatures.md b/docs/generateFeatures.md index 5961f899..038e55af 100644 --- a/docs/generateFeatures.md +++ b/docs/generateFeatures.md @@ -1,9 +1,9 @@ ## generateFeatures task --- -**This task will modify the source configuration directory of your application.** +**This task modifies the source configuration directory of your application.** This task has a runtime dependency on IBM WebSphere Application Server Migration Toolkit for Application Binaries, which is separately licensed under IBM License Agreement for Non-Warranted Programs. See license [here](https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/wasdev/license/wamt). -Scan the class files of an application and create a new `generated-features.xml` Liberty configuration file within the source directory containing the features the application requires. +Scan the class files of an application and create a new `generated-features.xml` Liberty configuration file in the source configuration directory that contains the Liberty features the application requires. This feature is best accessed through [dev mode](libertyDev.md). When you start `libertyDev` your application will be compiled and the class files will be scanned to verify that all the required Liberty features are included in your server configuration. Then as you work, dev mode will continue to monitor the project to confirm the Liberty features configured are up to date. If you implement a new interface in Java, the scanner will determine if that API is connected to a Liberty feature, then update the configuration and install the feature. If you remove a feature from `server.xml`, dev mode will determine if that feature is actually necessary, and if so, add it to the generated configuration file as described below. From 51fec7077c0895372db3050c7c93ab99283c2547 Mon Sep 17 00:00:00 2001 From: Trevor Crawford Date: Fri, 30 Sep 2022 16:00:56 -0400 Subject: [PATCH 4/6] Update README.md Co-authored-by: David Mueller <48686014+dmuelle@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 30210972..add3fba7 100644 --- a/README.md +++ b/README.md @@ -112,7 +112,7 @@ The Liberty plugin provides the following tasks for your project: | [undeploy](docs/undeploy.md#undeploy-task) | Removes applications from the Liberty server. | | [uninstallFeature](docs/uninstallFeature.md#uninstallfeature-task) | Remove a feature from the Liberty runtime. | -*The `libertyDev`, `libertyDevc`, and `generateFeatures` tasks have a runtime dependency on IBM WebSphere Application Server Migration Toolkit for Application Binaries, which is separately licensed under IBM License Agreement for Non-Warranted Programs. See license [here](https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/wasdev/license/wamt). +*The `libertyDev`, `libertyDevc`, and `generateFeatures` tasks have a runtime dependency on IBM WebSphere Application Server Migration Toolkit for Application Binaries, which is separately licensed under IBM License Agreement for Non-Warranted Programs. For more information, see the [license](https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/wasdev/license/wamt). Note: The `libertyDev` and `libertyDevc` tasks have this dependency only when auto-generation of features is turned on. By default, auto-generation of features is turned off. ### Task ordering From 1991069a9c9a1e0d9283a7cd6820e8f696e0cb0a Mon Sep 17 00:00:00 2001 From: Trevor Crawford Date: Fri, 30 Sep 2022 16:02:51 -0400 Subject: [PATCH 5/6] Update libertyDev.md --- docs/libertyDev.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/libertyDev.md b/docs/libertyDev.md index 106ea943..a3cbf7c9 100644 --- a/docs/libertyDev.md +++ b/docs/libertyDev.md @@ -3,7 +3,7 @@ Start a Liberty instance in dev mode. This task also invokes the `libertyCreate`, `installFeature`, and `deploy` tasks before starting the runtime. **Note:** This task is designed to be executed directly from the Gradle command line. -Starting in version 3.4.1, dev mode invokes the `generateFeatures` task when the `generateFeatures` configuration parameter is set to `true`. **This task modifies the source configuration directory of your application.** See [generateFeatures](generateFeatures.md) for details. The default value for the `generateFeatures` parameter is `false`. When auto-generation of features is turned on, dev mode has a runtime dependency on IBM WebSphere Application Server Migration Toolkit for Application Binaries, which is separately licensed under IBM License Agreement for Non-Warranted Programs. See license [here](https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/wasdev/license/wamt). +Starting in version 3.4.1, dev mode invokes the `generateFeatures` task when the `generateFeatures` configuration parameter is set to `true`. **This task modifies the source configuration directory of your application.** See [generateFeatures](generateFeatures.md) for details. The default value for the `generateFeatures` parameter is `false`. When auto-generation of features is turned on, dev mode has a runtime dependency on IBM WebSphere Application Server Migration Toolkit for Application Binaries, which is separately licensed under IBM License Agreement for Non-Warranted Programs. For more information, see the [license](https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/wasdev/license/wamt). **Limitations:** This task is not supported with Spring Boot applications. From 7341fb3ed80e96d1aa442db211e147ef275a8ea5 Mon Sep 17 00:00:00 2001 From: Trevor Crawford Date: Fri, 30 Sep 2022 16:03:45 -0400 Subject: [PATCH 6/6] Update generateFeatures.md --- docs/generateFeatures.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/generateFeatures.md b/docs/generateFeatures.md index 038e55af..d79a5ea2 100644 --- a/docs/generateFeatures.md +++ b/docs/generateFeatures.md @@ -1,7 +1,7 @@ ## generateFeatures task --- -**This task modifies the source configuration directory of your application.** This task has a runtime dependency on IBM WebSphere Application Server Migration Toolkit for Application Binaries, which is separately licensed under IBM License Agreement for Non-Warranted Programs. See license [here](https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/wasdev/license/wamt). +**This task modifies the source configuration directory of your application.** This task has a runtime dependency on IBM WebSphere Application Server Migration Toolkit for Application Binaries, which is separately licensed under IBM License Agreement for Non-Warranted Programs. For more information, see the [license](https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/wasdev/license/wamt). Scan the class files of an application and create a new `generated-features.xml` Liberty configuration file in the source configuration directory that contains the Liberty features the application requires.