From 03c9b426a1d50a3fc4fafce82f8ea6af1cdba2bd Mon Sep 17 00:00:00 2001 From: Ivan Porto Date: Mon, 10 Nov 2025 20:20:19 +0100 Subject: [PATCH 1/6] docs: add clarification around path resolution --- .../app_builder_guides/architecture_overview/app-hooks.md | 4 ++++ .../guides/app_builder_guides/configuration/configuration.md | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/src/pages/guides/app_builder_guides/architecture_overview/app-hooks.md b/src/pages/guides/app_builder_guides/architecture_overview/app-hooks.md index 65262f6d5..def806589 100644 --- a/src/pages/guides/app_builder_guides/architecture_overview/app-hooks.md +++ b/src/pages/guides/app_builder_guides/architecture_overview/app-hooks.md @@ -100,6 +100,10 @@ hooks: ## Using JavaScript files +> [!NOTE] +> +> When using JavaScript files, be aware that if your `hooks` definitions are in a file other than `app.config.yaml` (and then used via the `$include` directive), the paths to the hook JS scripts must be relative to the root `app.config.yaml` file. + You can specify a JavaScript file that contains your hook code. The file must export a function. **app.config.yaml** diff --git a/src/pages/guides/app_builder_guides/configuration/configuration.md b/src/pages/guides/app_builder_guides/configuration/configuration.md index 301354cfe..e2f4af281 100644 --- a/src/pages/guides/app_builder_guides/configuration/configuration.md +++ b/src/pages/guides/app_builder_guides/configuration/configuration.md @@ -301,7 +301,7 @@ extensions: $include: ./src/dx-excshell-1/ext.config.yaml ``` -Configuration paths defined in `./src/dx-excshell-1/ext.config.yaml` must be relative to that file. +Except for `hooks` definitions (which will be always resolved relative to the root `app.config.yaml` file), any configuration paths defined in other files (like `./src/dx-excshell-1/ext.config.yaml`) must be relative to that file. ### Public distribution configuration From ccaa2ffb369bc9c1584b8a3e585f29b1f5b12cc3 Mon Sep 17 00:00:00 2001 From: Ivan Porto Date: Tue, 11 Nov 2025 10:42:06 +0100 Subject: [PATCH 2/6] docs: mention hooks pointing to JS files --- .../guides/app_builder_guides/configuration/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/guides/app_builder_guides/configuration/configuration.md b/src/pages/guides/app_builder_guides/configuration/configuration.md index e2f4af281..e6d001fad 100644 --- a/src/pages/guides/app_builder_guides/configuration/configuration.md +++ b/src/pages/guides/app_builder_guides/configuration/configuration.md @@ -301,7 +301,7 @@ extensions: $include: ./src/dx-excshell-1/ext.config.yaml ``` -Except for `hooks` definitions (which will be always resolved relative to the root `app.config.yaml` file), any configuration paths defined in other files (like `./src/dx-excshell-1/ext.config.yaml`) must be relative to that file. +Except for `hooks` definitions that point to JavaScript files (which will always be resolved relative to the root `app.config.yaml` file), any configuration paths defined in other files (like `./src/dx-excshell-1/ext.config.yaml`) must be relative to that file. ### Public distribution configuration From fdf787d6ccdf30487b13de9e56371839940c0360 Mon Sep 17 00:00:00 2001 From: Ivan Porto Date: Tue, 11 Nov 2025 10:53:27 +0100 Subject: [PATCH 3/6] docs: remove note --- .../app_builder_guides/architecture_overview/app-hooks.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/src/pages/guides/app_builder_guides/architecture_overview/app-hooks.md b/src/pages/guides/app_builder_guides/architecture_overview/app-hooks.md index def806589..d621be187 100644 --- a/src/pages/guides/app_builder_guides/architecture_overview/app-hooks.md +++ b/src/pages/guides/app_builder_guides/architecture_overview/app-hooks.md @@ -100,11 +100,7 @@ hooks: ## Using JavaScript files -> [!NOTE] -> -> When using JavaScript files, be aware that if your `hooks` definitions are in a file other than `app.config.yaml` (and then used via the `$include` directive), the paths to the hook JS scripts must be relative to the root `app.config.yaml` file. - -You can specify a JavaScript file that contains your hook code. The file must export a function. +You can specify a JavaScript file that contains your hook code. The file must export a function. Be aware that if your `hooks` definitions are in a file other than `app.config.yaml` (and then used via the `$include` directive), the paths to the hook scripts must be relative to the root `app.config.yaml` file. **app.config.yaml** From c4ac0907b5754b8091c910ef87aeedd8e025ddbb Mon Sep 17 00:00:00 2001 From: Ivan Porto Date: Wed, 12 Nov 2025 17:46:12 +0100 Subject: [PATCH 4/6] docs: suggested rewording --- .../app_builder_guides/architecture_overview/app-hooks.md | 2 +- .../guides/app_builder_guides/configuration/configuration.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/pages/guides/app_builder_guides/architecture_overview/app-hooks.md b/src/pages/guides/app_builder_guides/architecture_overview/app-hooks.md index d621be187..38bbffafb 100644 --- a/src/pages/guides/app_builder_guides/architecture_overview/app-hooks.md +++ b/src/pages/guides/app_builder_guides/architecture_overview/app-hooks.md @@ -100,7 +100,7 @@ hooks: ## Using JavaScript files -You can specify a JavaScript file that contains your hook code. The file must export a function. Be aware that if your `hooks` definitions are in a file other than `app.config.yaml` (and then used via the `$include` directive), the paths to the hook scripts must be relative to the root `app.config.yaml` file. +If your `hooks` definitions are in a separate file that is included using the `$include` directive, the paths to the hook scripts must be relative to the root `app.config.yaml` file, not the included file. **app.config.yaml** diff --git a/src/pages/guides/app_builder_guides/configuration/configuration.md b/src/pages/guides/app_builder_guides/configuration/configuration.md index e6d001fad..4856e7aee 100644 --- a/src/pages/guides/app_builder_guides/configuration/configuration.md +++ b/src/pages/guides/app_builder_guides/configuration/configuration.md @@ -301,7 +301,7 @@ extensions: $include: ./src/dx-excshell-1/ext.config.yaml ``` -Except for `hooks` definitions that point to JavaScript files (which will always be resolved relative to the root `app.config.yaml` file), any configuration paths defined in other files (like `./src/dx-excshell-1/ext.config.yaml`) must be relative to that file. +Configuration paths defined in other files (such as `./src/dx-excshell-1/ext.config.yaml`) must be relative to that file. The exception is `hooks` definitions that point to JavaScript files, which are always resolved relative to the root `app.config.yaml` file. ### Public distribution configuration From 7d7ff279aa77a553b64d98960c87b6e433edceaa Mon Sep 17 00:00:00 2001 From: Ivan Porto Date: Wed, 12 Nov 2025 18:04:26 +0100 Subject: [PATCH 5/6] chore: empty commit to trigger cla bot From 7094074e5d1ba5d395e90e152db206085a6199c3 Mon Sep 17 00:00:00 2001 From: Ivan Porto Date: Thu, 13 Nov 2025 10:01:42 +0100 Subject: [PATCH 6/6] docs: rephrase statement --- .../app_builder_guides/architecture_overview/app-hooks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/guides/app_builder_guides/architecture_overview/app-hooks.md b/src/pages/guides/app_builder_guides/architecture_overview/app-hooks.md index 38bbffafb..015cf81cc 100644 --- a/src/pages/guides/app_builder_guides/architecture_overview/app-hooks.md +++ b/src/pages/guides/app_builder_guides/architecture_overview/app-hooks.md @@ -100,7 +100,7 @@ hooks: ## Using JavaScript files -If your `hooks` definitions are in a separate file that is included using the `$include` directive, the paths to the hook scripts must be relative to the root `app.config.yaml` file, not the included file. +You can specify a JavaScript file that contains your hook code. The file must export a function. If you are defining a hook in a separate config file (e.g. `ext.config.yaml`), that later is included in the root `app.config.yaml` file (via the `$include` directive), the hook path must be relative to the root. **app.config.yaml**