trigger help xfer only on change to help

Author: briantoby

.github/workflows/builddocsite.yml

@@ -1,12 +1,10 @@
 # create a documentation web site for GSAS-II from four sources
-#  * HTML tutorials are simply copied
-#  * markdown tutorials (in ./MDtutorials) are formatted with pandoc and are copied over
-#  * sphinx is used to generate HTML from files in ./webdocs
-#  * the tutorials.html file and the */data/index.html files are
-#        created by running scripts/makeGitTutorial
-#  * the help pages are created from the .md file in the MDhelp directory
-#  * this triggers a process that also creates the help files and places
-#        the .html files into the GSAS-II sources
+#  1. HTML tutorials are simply copied
+#  2. markdown tutorials (in ./MDtutorials) are formatted with pandoc and are copied over
+#     * the tutorials.html file and the */data/index.html files are
+#        created by running scripts/makeGitTutorial.py
+#  3. sphinx is used to generate HTML from files in ./webdocs
+#  4. the help pages are created from the .md file in the MDhelp directory
 
 name: build GSAS-II web site w/MD Help
 
@@ -26,21 +24,6 @@ jobs:
   build:       # Build web pages
     runs-on: ubuntu-latest
     steps:
-
-      - name: Trigger remote workflow to update help files in GSAS-II repo
-        # see below for info on setting this up
-        run: |
-          # config var follows
-          repo_owner="AdvancedPhotonSource" 
-  
-          curl -L \
-            -X POST \
-            -H "Accept: application/vnd.github+json" \
-            -H "Authorization: Bearer ${{ secrets.G2TUT_2_G2_4HELP }}" \
-            -H "X-GitHub-Api-Version: 2022-11-28" \
-            https://api.github.com/repos/$repo_owner/GSAS-II/dispatches \
-            -d '{"event_type": "remote build", "client_payload": {"service": "remote build", "unit": false, "integration": true}}'
-
       - name: Python setup
         uses: actions/setup-python@v3
       - name: Sphinx setup

.github/workflows/helpxfer.yml

@@ -0,0 +1,31 @@
+#  this triggers a process that will creates the help .HTML files and places
+#        them into the GSAS-II sources
+
+name: xfer MD Help to GSAS-II repo
+
+on:
+  workflow_dispatch:   # nice for debugging
+  
+  push:
+    branches: [ "main" ]
+    paths:                  # want this to run only when help contents changes
+      - MDhelp
+
+jobs:
+  build:       # Build web pages
+    runs-on: ubuntu-latest
+    steps:
+      - name: Trigger remote workflow to update help files in GSAS-II repo
+        # see below for info on setting this up
+        run: |
+          # config var follows
+          repo_owner="AdvancedPhotonSource" 
+  
+          curl -L \
+            -X POST \
+            -H "Accept: application/vnd.github+json" \
+            -H "Authorization: Bearer ${{ secrets.G2TUT_2_G2_4HELP }}" \
+            -H "X-GitHub-Api-Version: 2022-11-28" \
+            https://api.github.com/repos/$repo_owner/GSAS-II/dispatches \
+            -d '{"event_type": "remote build", "client_payload": {"service": "remote build", "unit": false, "integration": true}}'
+

webdocs/documentation.rst

@@ -33,8 +33,9 @@ works. The help information can also be viewed `as a PDF document
 
 Note that the help documentation was recently reformatted and updated
 as MarkDown (simple text) input files found
-`in GitHub, here<https://github.com/AdvancedPhotonSource/GSAS-II-tutorials/tree/main/MDhelp>`_.
-Comments, corrections, additions and issue reports on Help are most welcome. 
+in GitHub in the MDhelp directory of the
+AdvancedPhotonSource/GSAS-II-tutorials repo (https://github.com/AdvancedPhotonSource/GSAS-II-tutorials/tree/main/MDhelp).
+Comments, corrections, additions and issue reports on Help content are most welcome. 
 
 .. index:: Source code documentation