Docs: mention the usage of on.<>.paths (#15)

* Docs: mention the usage of `on.<>.paths` Add this as a comment so people can see it and adapt to their needs. * Update preview/README.md
readthedocs · Jan 30, 2023 · f5b968a · f5b968a
1 parent ac3ce95
commit f5b968a
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/preview/README.md b/preview/README.md
@@ -23,6 +23,10 @@ on:
   pull_request_target:
     types:
       - opened
+    # Execute this action only on PRs that touch
+    # documentation files.
+    # paths:
+    #   - "docs/**"
 
 permissions:
   pull-requests: write