From 3f291aed029941aac8e562be92df94c5c6b63184 Mon Sep 17 00:00:00 2001 From: Yavor Ivanov <yavor.ivanov@sap.com> Date: Wed, 20 Sep 2023 14:24:50 +0300 Subject: [PATCH 1/8] Rewrite incorrect docs for custom tasks' execution --- docs/pages/extensibility/CustomTasks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/extensibility/CustomTasks.md b/docs/pages/extensibility/CustomTasks.md index 602ad1b104..4c751f88ed 100644 --- a/docs/pages/extensibility/CustomTasks.md +++ b/docs/pages/extensibility/CustomTasks.md @@ -10,7 +10,7 @@ Please note that custom tasks from third parties can not only modify your projec You can configure your build process with additional build task. These custom tasks are defined in the project [configuration](../Configuration.md). -To hook your custom tasks into the different build phases of a project, they need to reference other tasks to be executed before or after. This can be a [standard task](../Builder.md#standard-tasks) or another custom task. Note that a custom task will only be executed if the referenced task is executed (i.e. is not disabled). +To hook your custom tasks into the different build phases of a project, they need to reference other tasks to be executed before or after. This can be a [standard task](../Builder.md#standard-tasks) or another custom task. Disabled standard tasks, although not executed, can still be referenced by custom tasks that will be carried out on the correct position. In the below example, when building the library `my.library` the custom `babel` task will be executed before the standard task `generateComponentPreload`. Another custom task called `renderMarkdownFiles` is then executed immediately after the standard task `minify`. From c49a66653e64eebca55a1d139ca3774ca5f8e066 Mon Sep 17 00:00:00 2001 From: Yavor Ivanov <yavor.ivanov@sap.com> Date: Mon, 25 Sep 2023 14:44:43 +0300 Subject: [PATCH 2/8] Fix invalid specVersion: 3.1 names --- docs/pages/extensibility/CustomTasks.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/pages/extensibility/CustomTasks.md b/docs/pages/extensibility/CustomTasks.md index 4c751f88ed..7456628cf7 100644 --- a/docs/pages/extensibility/CustomTasks.md +++ b/docs/pages/extensibility/CustomTasks.md @@ -13,12 +13,12 @@ You can configure your build process with additional build task. These custom ta To hook your custom tasks into the different build phases of a project, they need to reference other tasks to be executed before or after. This can be a [standard task](../Builder.md#standard-tasks) or another custom task. Disabled standard tasks, although not executed, can still be referenced by custom tasks that will be carried out on the correct position. In the below example, when building the library `my.library` the custom `babel` task will be executed before the standard task `generateComponentPreload`. -Another custom task called `renderMarkdownFiles` is then executed immediately after the standard task `minify`. +Another custom task called `render-markdown-files` is then executed immediately after the standard task `minify`. ### Example: Basic configuration ```yaml -# In this example configuration two custom tasks are defined: 'babel' and 'renderMarkdownFiles'. +# In this example configuration two custom tasks are defined: 'babel' and 'render-markdown-files'. specVersion: "3.1" type: library metadata: @@ -27,7 +27,7 @@ builder: customTasks: - name: babel beforeTask: generateComponentPreload - - name: renderMarkdownFiles + - name: render-markdown-files afterTask: minify configuration: markdownStyle: @@ -39,17 +39,17 @@ builder: You can also connect multiple custom tasks with each other. The order in the configuration is important in this case. You have to make sure that a task is defined *before* you reference it via `beforeTask` or `afterTask`. ```yaml -# In this example 'myCustomTask2' gets executed after 'myCustomTask1'. +# In this example 'my-custom-task-2' gets executed after 'my-custom-task-1'. specVersion: "3.1" type: library metadata: name: my.library builder: customTasks: - - name: myCustomTask1 + - name: my-custom-task-1 beforeTask: generateComponentPreload - - name: myCustomTask2 - afterTask: myCustomTask1 + - name: my-custom-task-2 + afterTask: my-custom-task-1 ``` ## Custom Task Extension @@ -63,7 +63,7 @@ specVersion: "3.1" kind: extension type: task metadata: - name: renderMarkdownFiles + name: render-markdown-files task: path: lib/tasks/renderMarkdownFiles.js ``` @@ -86,7 +86,7 @@ metadata: name: my.library builder: customTasks: - - name: renderMarkdownFiles + - name: render-markdown-files afterTask: minify configuration: markdownStyle: @@ -97,7 +97,7 @@ specVersion: "3.1" kind: extension type: task metadata: - name: renderMarkdownFiles + name: render-markdown-files task: path: lib/tasks/renderMarkdownFiles.js ``` From 63b4e2526437c89e4f082f6b115c07203b9236ce Mon Sep 17 00:00:00 2001 From: Yavor Ivanov <yavor.ivanov@sap.com> Date: Mon, 25 Sep 2023 16:00:45 +0300 Subject: [PATCH 3/8] Correct formatting of bullets --- docs/pages/Configuration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/pages/Configuration.md b/docs/pages/Configuration.md index a866080568..d8c9d67699 100644 --- a/docs/pages/Configuration.md +++ b/docs/pages/Configuration.md @@ -706,8 +706,8 @@ A list of bundle definitions. A `bundleDefinition` contains of the following opt **bundleOptions** - `optimize`: If set to `true`, the module bundle gets minified - - Projects defining [Specification Version](#specification-versions) 3.0 and higher: Defaults to `true` - - Projects defining [Specification Version](#specification-versions) lower than 3.0: Defaults to `false` + - Projects defining [Specification Version](#specification-versions) 3.0 and higher: Defaults to `true` + - Projects defining [Specification Version](#specification-versions) lower than 3.0: Defaults to `false` - `decorateBootstrapModule`: By default set to `false`. If set to `true`, the module will be decorated with an optimization marker - `addTryCatchRestartWrapper`: By default set to `false`. If set to `true`, bootable module bundles gets wrapped with a try/catch to filter "Restart" errors - `usePredefineCalls`: If set to `true`, `sap.ui.predefine` is used for UI5 modules From 27260699e36c0da6c4eebdd140738b5024b9fd00 Mon Sep 17 00:00:00 2001 From: Yavor Ivanov <yavor.ivanov@sap.com> Date: Tue, 26 Sep 2023 10:26:29 +0300 Subject: [PATCH 4/8] Improve docs for subscription to disabled tasks --- docs/pages/extensibility/CustomTasks.md | 3 ++- docs/updates/migrate-v3.md | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/pages/extensibility/CustomTasks.md b/docs/pages/extensibility/CustomTasks.md index 7456628cf7..37828a0a52 100644 --- a/docs/pages/extensibility/CustomTasks.md +++ b/docs/pages/extensibility/CustomTasks.md @@ -10,7 +10,8 @@ Please note that custom tasks from third parties can not only modify your projec You can configure your build process with additional build task. These custom tasks are defined in the project [configuration](../Configuration.md). -To hook your custom tasks into the different build phases of a project, they need to reference other tasks to be executed before or after. This can be a [standard task](../Builder.md#standard-tasks) or another custom task. Disabled standard tasks, although not executed, can still be referenced by custom tasks that will be carried out on the correct position. +To hook your custom tasks into the different build phases of a project, they need to reference other tasks to be executed before or after. This can be a [standard task](../Builder.md#standard-tasks) or another custom task. +Standard tasks that are disabled, even though they are not executed, can still be referenced by custom tasks, which will be performed in their designated position. In the below example, when building the library `my.library` the custom `babel` task will be executed before the standard task `generateComponentPreload`. Another custom task called `render-markdown-files` is then executed immediately after the standard task `minify`. diff --git a/docs/updates/migrate-v3.md b/docs/updates/migrate-v3.md index 64900add43..db99d258a1 100644 --- a/docs/updates/migrate-v3.md +++ b/docs/updates/migrate-v3.md @@ -171,7 +171,7 @@ The following processors have been removed: | UI5 Tooling v2 | UI5 Tooling v3 | Note | | --------------------------- | --------------------------- | ------------------------- | -| createDebugFiles<br/>uglify | minify | The minify task is executed earlier, before the bundling process takes place. Any existing 'beforeTask' or 'afterTask' configuration of custom tasks might need to be adapted to cater for this change. | +| createDebugFiles<br/>uglify | minify | The minify task is executed earlier, before the bundling process takes place. Any existing `beforeTask` or `afterTask` configuration of custom tasks might need to be adapted to cater for this change. <br>To adapt, you can use the `generateResourcesJson` for subscription before or after the last standard task. By default, `generateResourcesJson` is disabled, but you can still subscribe to it, ensuring your custom task executes in the correct order. | | generateVersionInfo | generateVersionInfo | The task is no longer executed by default for application projects. It can be re-enabled by using the `--include-task` parameter. | | generateManifestBundle | *None* | This task was only needed for the HTML5 repository in Cloud Foundry. Meanwhile, the HTML5 repository implemented its own mechanism, so the task is no longer needed | From 98c8996eb8b273e1d980718e998d5f6db741a887 Mon Sep 17 00:00:00 2001 From: Yavor Ivanov <d3xter666@users.noreply.github.com> Date: Thu, 28 Sep 2023 09:39:24 +0300 Subject: [PATCH 5/8] Update docs/pages/extensibility/CustomTasks.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com> --- docs/pages/extensibility/CustomTasks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/extensibility/CustomTasks.md b/docs/pages/extensibility/CustomTasks.md index 37828a0a52..753af181b5 100644 --- a/docs/pages/extensibility/CustomTasks.md +++ b/docs/pages/extensibility/CustomTasks.md @@ -40,7 +40,7 @@ builder: You can also connect multiple custom tasks with each other. The order in the configuration is important in this case. You have to make sure that a task is defined *before* you reference it via `beforeTask` or `afterTask`. ```yaml -# In this example 'my-custom-task-2' gets executed after 'my-custom-task-1'. +# In this example, 'my-custom-task-2' gets executed after 'my-custom-task-1'. specVersion: "3.1" type: library metadata: From 15702ef2b35fde6818c2d1ba877529ce57cfbb26 Mon Sep 17 00:00:00 2001 From: Yavor Ivanov <d3xter666@users.noreply.github.com> Date: Thu, 28 Sep 2023 09:39:32 +0300 Subject: [PATCH 6/8] Update docs/pages/extensibility/CustomTasks.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com> --- docs/pages/extensibility/CustomTasks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/extensibility/CustomTasks.md b/docs/pages/extensibility/CustomTasks.md index 753af181b5..5957e8720a 100644 --- a/docs/pages/extensibility/CustomTasks.md +++ b/docs/pages/extensibility/CustomTasks.md @@ -19,7 +19,7 @@ Another custom task called `render-markdown-files` is then executed immediately ### Example: Basic configuration ```yaml -# In this example configuration two custom tasks are defined: 'babel' and 'render-markdown-files'. +# In this example configuration, two custom tasks are defined: 'babel' and 'render-markdown-files'. specVersion: "3.1" type: library metadata: From 384ba8c3ab15a8897e849b2f1fef427b44eb0687 Mon Sep 17 00:00:00 2001 From: Yavor Ivanov <yavor.ivanov@sap.com> Date: Thu, 28 Sep 2023 09:43:25 +0300 Subject: [PATCH 7/8] Update minify migration note --- docs/updates/migrate-v3.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/updates/migrate-v3.md b/docs/updates/migrate-v3.md index db99d258a1..0c340aa44e 100644 --- a/docs/updates/migrate-v3.md +++ b/docs/updates/migrate-v3.md @@ -171,7 +171,7 @@ The following processors have been removed: | UI5 Tooling v2 | UI5 Tooling v3 | Note | | --------------------------- | --------------------------- | ------------------------- | -| createDebugFiles<br/>uglify | minify | The minify task is executed earlier, before the bundling process takes place. Any existing `beforeTask` or `afterTask` configuration of custom tasks might need to be adapted to cater for this change. <br>To adapt, you can use the `generateResourcesJson` for subscription before or after the last standard task. By default, `generateResourcesJson` is disabled, but you can still subscribe to it, ensuring your custom task executes in the correct order. | +| createDebugFiles<br/>uglify | minify | The minify task is executed earlier, before the bundling process takes place. Any existing `beforeTask` or `afterTask` configuration of custom tasks might need to be adapted to cater for this change. <br>To adapt, you can use the `generateResourcesJson` for subscription before or after the last standard task. By default, `generateResourcesJson` is disabled, but you can still subscribe to it, ensuring your custom tasks execute in the correct order. | | generateVersionInfo | generateVersionInfo | The task is no longer executed by default for application projects. It can be re-enabled by using the `--include-task` parameter. | | generateManifestBundle | *None* | This task was only needed for the HTML5 repository in Cloud Foundry. Meanwhile, the HTML5 repository implemented its own mechanism, so the task is no longer needed | From 8b8f5740ed78b00414009196cc8b7b4f2363f823 Mon Sep 17 00:00:00 2001 From: Yavor Ivanov <yavor.ivanov@sap.com> Date: Fri, 29 Sep 2023 15:40:53 +0300 Subject: [PATCH 8/8] Update docs --- docs/updates/migrate-v3.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/updates/migrate-v3.md b/docs/updates/migrate-v3.md index 0c340aa44e..7fa5f00a81 100644 --- a/docs/updates/migrate-v3.md +++ b/docs/updates/migrate-v3.md @@ -171,7 +171,7 @@ The following processors have been removed: | UI5 Tooling v2 | UI5 Tooling v3 | Note | | --------------------------- | --------------------------- | ------------------------- | -| createDebugFiles<br/>uglify | minify | The minify task is executed earlier, before the bundling process takes place. Any existing `beforeTask` or `afterTask` configuration of custom tasks might need to be adapted to cater for this change. <br>To adapt, you can use the `generateResourcesJson` for subscription before or after the last standard task. By default, `generateResourcesJson` is disabled, but you can still subscribe to it, ensuring your custom tasks execute in the correct order. | +| createDebugFiles<br/>uglify | minify | The minify task is executed earlier, before the bundling process takes place. Any existing `beforeTask` or `afterTask` configuration of custom tasks might need to be adapted to cater for this change. <br>To adapt, you can use the `generateResourcesJson` task for subscription before or after the last standard task. By default, `generateResourcesJson` is disabled, but you can still subscribe to it, ensuring your custom tasks execute in the correct order. | | generateVersionInfo | generateVersionInfo | The task is no longer executed by default for application projects. It can be re-enabled by using the `--include-task` parameter. | | generateManifestBundle | *None* | This task was only needed for the HTML5 repository in Cloud Foundry. Meanwhile, the HTML5 repository implemented its own mechanism, so the task is no longer needed |