Merge pull request #24726 from abpframework/auto-merge/rel-10-0/4312

Merge branch rel-10.1 with rel-10.0

docs/en/docs-nav.json

@@ -347,6 +347,10 @@
                 {
                   "text": "Working with ABP Suite",
                   "path": "studio/working-with-suite.md"
+                },
+                {
+                  "text": "Custom Commands",
+                  "path": "studio/custom-commands.md"
                 }
               ]
             },

docs/en/studio/custom-commands.md

@@ -0,0 +1,128 @@
+```json
+//[doc-seo]
+{
+    "Description": "Learn how to create and manage custom commands in ABP Studio to automate build, deployment, and other workflows."
+}
+```
+
+# Custom Commands
+
+````json
+//[doc-nav]
+{
+  "Next": {
+    "Name": "Working with ABP Suite",
+    "Path": "studio/working-with-suite"
+  }
+}
+````
+
+Custom commands allow you to define reusable terminal commands that appear in context menus throughout ABP Studio. You can use them to automate repetitive tasks such as building Docker images, installing Helm charts, running deployment scripts, or executing any custom workflow.
+
+> **Note:** This is an advanced feature primarily intended for teams working with Kubernetes deployments or complex build/deployment workflows. If you're developing a standard application without custom DevOps requirements, you may not need this feature.
+
+## Opening the Management Window
+
+To manage custom commands, right-click on the solution root in *Solution Explorer* and select *Manage Custom Commands*.
+
+![Custom Commands Management Window](images/custom-commands/management-window.png)
+
+The management window displays all defined commands with options to add, edit, or delete them.
+
+## Creating a New Command
+
+Click the *Add New Command* button to open the command editor dialog.
+
+![Create/Edit Custom Command](images/custom-commands/create-edit-command.png)
+
+## Command Properties
+
+| Property | Description |
+|----------|-------------|
+| **Command Name** | A unique identifier for the command (used internally) |
+| **Display Name** | The text shown in context menus |
+| **Terminal Command** | The PowerShell command to execute. Use `&&&` to chain multiple commands |
+| **Working Directory** | Optional. The directory where the command runs (relative to solution path) |
+| **Condition** | Optional. A [Scriban](https://github.com/scriban/scriban/blob/master/doc/language.md) expression that determines when the command is visible |
+| **Require Confirmation** | When enabled, shows a confirmation dialog before execution |
+| **Confirmation Text** | The message shown in the confirmation dialog |
+
+## Trigger Targets
+
+Trigger targets determine where your command appears in context menus. You can select multiple targets for a single command.
+
+| Target | Location |
+|--------|----------|
+| **Helm Charts Root** | *Kubernetes* panel > *Helm* tab > root node |
+| **Helm Main Chart** | *Kubernetes* panel > *Helm* tab > main chart |
+| **Helm Sub Chart** | *Kubernetes* panel > *Helm* tab > sub chart |
+| **Kubernetes Service** | *Kubernetes* panel > *Kubernetes* tab > service |
+| **Solution Runner Root** | *Solution Runner* panel > profile root |
+| **Solution Runner Folder** | *Solution Runner* panel > folder |
+| **Solution Runner Application** | *Solution Runner* panel > application |
+
+## Execution Targets
+
+Execution targets define where the command actually runs. This enables cascading execution:
+
+- When you trigger a command from a **root or parent item**, it can recursively execute on all matching children
+- For example: trigger from *Helm Charts Root* with execution target *Helm Sub Chart* → the command runs on each sub chart
+
+## Template Variables
+
+Commands support [Scriban](https://github.com/scriban/scriban/blob/master/doc/language.md) template syntax for dynamic values. Use `{{variable}}` to insert context-specific data.
+
+### Available Variables by Context
+
+**Helm Charts:**
+
+| Variable | Description |
+|----------|-------------|
+| `profile.name` | Kubernetes profile name |
+| `profile.namespace` | Kubernetes namespace |
+| `chart.name` | Current chart name |
+| `chart.path` | Chart directory path |
+| `metadata.*` | Hierarchical metadata values (e.g., `metadata.imageName`) |
+| `secrets.*` | Secret values (e.g., `secrets.registryPassword`) |
+
+**Kubernetes Service:**
+
+| Variable | Description |
+|----------|-------------|
+| `name` | Service name |
+| `profile.name` | Kubernetes profile name |
+| `profile.namespace` | Kubernetes namespace |
+| `mainChart.name` | Parent main chart name |
+| `chart.name` | Related sub chart name |
+| `chart.metadata.*` | Chart-specific metadata |
+
+**Solution Runner (Root, Folder, Application):**
+
+| Variable | Description |
+|----------|-------------|
+| `profile.name` | Run profile name |
+| `profile.path` | Profile file path |
+| `application.name` | Application name (Application context only) |
+| `application.baseUrl` | Application URL (Application context only) |
+| `folder.name` | Folder name (Folder/Application context) |
+| `metadata.*` | Profile metadata values |
+| `secrets.*` | Profile secret values |
+
+## Example: Build Docker Image
+
+Here's an example command that builds a Docker image for Helm charts:
+
+**Command Properties:**
+- **Command Name:** `buildDockerImage`
+- **Display Name:** `Build Docker Image`
+- **Terminal Command:** `./build-image.ps1 -ProjectPath {{metadata.projectPath}} -ImageName {{metadata.imageName}}`
+- **Working Directory:** `etc/helm`
+- **Trigger Targets:** Helm Charts Root, Helm Main Chart, Helm Sub Chart
+- **Execution Targets:** Helm Main Chart, Helm Sub Chart
+- **Condition:** `{{metadata.projectPath}}`
+
+This command:
+1. Appears in the context menu of Helm charts root and all chart nodes
+2. Executes on main charts and sub charts (cascading from root if triggered there)
+3. Only shows for charts that have `projectPath` metadata defined
+4. Runs the `build-image.ps1` script with dynamic parameters from metadata

docs/en/studio/kubernetes.md

@@ -11,8 +11,8 @@
 //[doc-nav]
 {
   "Next": {
-    "Name": "Working with ABP Suite",
-    "Path": "studio/working-with-suite"
+    "Name": "Custom Commands",
+    "Path": "studio/custom-commands"
   }
 }
 ````
@@ -210,46 +210,12 @@ When you connect to a Kubernetes cluster, it uses the selected profile for Kuber
 
 ## Advanced Topics
 
-### Adding a Custom Command
-
-Custom commands can be added to both the *Helm* and *Kubernetes* tabs within the *Kubernetes* panel. For instance, when [redeploy](#redeploy-a-chart) a chart, it involves building the Docker image and reinstalling it. However, if you are working with a different Kubernetes cluster than Docker Desktop, you'll need to push the Docker image to the registry before the installation process. This can be achieved by incorporating a custom command into the *Kubernetes services*. Custom commands can be added to the *Chart Root*, *Main Chart*, and *Subchart* in the *Helm* tab, as well as to the *Service* in the *Kubernetes* tab.
-
-To do that, open the ABP Solution (*.abpsln*) file with *Visual Studio Code* it's a JSON file and you'll see the existing commands in the `commands` section. Before adding a new command, create a powershell script in the `abp-solution-path/etc/helm` folder. For example, we create a `push-image.ps1` script to push the docker image to the registry. Then, add the following command to the `commands` section.
-
-```JSON
-    "kubernetesRedeployWithPushImage": { 
-      "triggerTargets": [
-        "KUBERNETES_SERVICE"
-      ],
-      "executionTargets": [
-        "KUBERNETES_SERVICE"
-      ],
-      "displayName": " Redeploy with Push Image",
-      "workingDirectory": "etc/helm",
-      "terminalCommand": "./build-image.ps1 -ProjectPath {%{{{chart.metadata.projectPath}}}%} -ImageName {%{{{chart.metadata.imageName}}}%} -ProjectType {%{{{chart.metadata.projectType}}}%} &&& ./push-image.ps1 -ImageName {%{{{chart.metadata.imageName}}}%} &&& ./install.ps1 -ChartName {%{{{mainChart.name}}}%} -Namespace {%{{{profile.namespace}}}%} -ReleaseName {%{{{mainChart.name}}}%}-{%{{{profile.name}}}%} -DotnetEnvironment {%{{{mainChart.metadata.dotnetEnvironment}}}%}",
-      "requireConfirmation": "true",
-      "confirmationText": "Are you sure to redeploy with push image the related chart '{%{{{chart.name}}}%}' for the service '{%{{{name}}}%}'?",
-      "condition": "{%{{{chart != null && chart.metadata.projectPath != null && chart.metadata.imageName != null && chart.metadata.projectType != null}}}%}"
-    }
-```
+### Custom Commands
+
+You can add custom commands to context menus in both the *Helm* and *Kubernetes* tabs. This is useful for automating workflows like pushing Docker images to a registry before installation, or running custom deployment scripts.
 
-Once the command is added, reload the solution from *File* -> *Reload Solution* in the toolbar. After reloading, you will find the *Redeploy with Push Image* command in the context-menu of the service.
+Custom commands can be added to the *Chart Root*, *Main Chart*, and *Sub Chart* in the *Helm* tab, as well as to the *Service* in the *Kubernetes* tab.
 
 ![redeploy-push-image](./images/kubernetes/redeploy-push-image.png)
 
-The JSON object has the following properties:
-
-- `triggerTargets`: Specifies the trigger targets for the command. The added command will appear in these targets. You can add one or more trigger targets, accepting values such as *HELM_CHARTS_ROOT*, *HELM_MAIN_CHART*, *HELM_SUB_CHART* and *KUBERNETES_SERVICE*.
-- `executionTargets`: Specifies the execution targets for the command. When executing the command on a root item, it will recursively execute the command for all children. Acceptable values include *HELM_CHARTS_ROOT*, *HELM_MAIN_CHART*, *HELM_SUB_CHART*, and *KUBERNETES_SERVICE*.
-- `displayName`: Specifies the display name of the command.
-- `workingDirectory`: Specifies the working directory of the command. It's relative to the solution path.
-- `terminalCommand`: Specifies the terminal command for the custom command. The `&&&` operator can be used to run multiple commands in the terminal. Utilize the [Scriban](https://github.com/scriban/scriban/blob/master/doc/language.md) syntax to access input data, which varies based on the execution target.
-- `requireConfirmation`: Specifies whether the command requires confirmation message before execution. Acceptable values include *true* and *false*.
-- `confirmationText`: Specifies the confirmation text for the command. Utilize the [Scriban](https://github.com/scriban/scriban/blob/master/doc/language.md) syntax to access input data, which varies based on the execution target.
-- `condition`: Specifies the condition for the command. If the condition returns *false*, it skips the current item and attempts to execute the command for the next item or child item. Utilize the [Scriban](https://github.com/scriban/scriban/blob/master/doc/language.md) syntax to access input data, which varies based on the execution target.
-
-You can use the following variables in the scriban syntax based on the execution target:
-  - `HELM_CHARTS_ROOT`: *profile*, *metadata*, *secrets*
-  - `HELM_MAIN_CHART`: *profile*, *chart*, *metadata*, *secret*
-  - `HELM_SUB_CHART`: *profile*, *chart*, *metadata*, *secret*
-  - `KUBERNETES_SERVICE`: *name*, *profile*, *mainChart*, *chart*, *metadata*, *secret*
+For detailed information on creating and managing custom commands, see the [Custom Commands](custom-commands.md) documentation.

docs/en/studio/running-applications.md

@@ -244,6 +244,10 @@ The *Open with* submenu provides options to open the application project in exte
 - **Terminal**: Opens a terminal window in the project directory.
 - **Explorer / Finder**: Opens the project folder in the system file explorer.
 
+### Custom Commands
+
+You can add custom commands that appear in the context menu of Solution Runner items (root, folders, and applications). These commands allow you to automate custom workflows and scripts. For details on creating and managing custom commands, see the [Custom Commands](custom-commands.md) documentation.
+
 ### Miscellaneous
 
 - We can copy the selected application *Browse* URL with *Copy URL*. It copies the *Browse* URL instead of *Launch URL* since we could be connected to a *Kubernetes* service.