Merge pull request #32757 from sid200727/docs-actionservice-examples

docs: add examples for filtering Actions Service actions
2026-02-14 12:36:52 +01:00
parent 6ada8bcf5d 722546afae
commit b81097c0b4
1 changed files with 27 additions and 1 deletions
@@ -30,7 +30,9 @@ This naming convention ensures that action names are globally unique across all

 ## Configuration

-The Actions Service can be configured to control which plugins' actions are available:
+### Restricting action sources by plugin
+
+The `pluginSources` configuration limits which plugins are allowed to register actions.

 ```yaml
 backend:
@@ -39,6 +41,30 @@ backend:
      - catalog
 ```

+### Filtering actions
+
+In addition to plugin-level restrictions, the Actions Service supports filtering actions using include and exclude rules. This allows fine-grained control over which actions are exposed or runnable in a Backstage instance.
+
+#### Include specific actions
+
+```yaml
+backend:
+  actions:
+    filter:
+      include:
+        - 'catalog.*'
+```
+
+#### Exclude specific actions
+
+```yaml
+backend:
+  actions:
+    filter:
+      exclude:
+        - 'scaffolder.internal.*'
+```
+
 ## Using the Service

 ### Listing Available Actions