house-keeping: jsdoc reduce GitHub workload: run only when docs change
authorPaul Donald <newtwen@gmail.com>
Tue, 30 Jan 2024 16:00:02 +0000 (17:00 +0100)
committerPaul Donald <newtwen@gmail.com>
Tue, 30 Jan 2024 16:09:09 +0000 (17:09 +0100)
this will prevent a large amount of

deploy: <sha>

to openwrt/gh-pages branches when nothing there has changed

Note: it may not be a bad idea to have docs compile at every commit,
since docs do not change *that* often, and some action or process that
breaks is likely noticed sooner if docs that compile continuously
trigger any broken processes or workflows.

.github/workflows/jsdoc.yml

index 254e3e6c38b46a953c63439fed121db1c978e32e..5a180bbd8e3df85c367f401e90ae7a9211e04177 100644 (file)
@@ -4,6 +4,12 @@ on:
   push:
     branches:
       - master
+    paths:
+      # One day we might include all htdocs folders:
+      # - '**/htdocs/**'
+      # Until then, follow jsdoc.conf.json:source directive
+      - 'modules/luci-base/htdocs/luci-static/resources/**'
+      - 'docs/**'
 
 jobs:
   deploy: