Move testing.sh to its own workflow.

Author: samsrabin

.github/workflows/docs-common.yml

@@ -76,13 +76,3 @@ jobs:
           else
             cd doc && ./build_docs -b ${PWD}/_build -c
           fi
-
-      # TODO: Split testing.sh tests into their own steps in this job
-      - name: Text Sphinx builds with omnibus script
-        if: success() || failure()
-        run: |
-          if ${{ inputs.use_conda }}; then
-            cd doc && conda run -n ${{ inputs.conda_env_name }} ./testing.sh
-          else
-            cd doc && ./testing.sh
-          fi

.github/workflows/docs-omnibus.yml

@@ -0,0 +1,49 @@
+name: Run an omnibus test script for the docs
+
+on:
+  push:
+    # Run when a change to these files is pushed to any branch. Without the "branches:" line, for some reason this will be run whenever a tag is pushed, even if the listed files aren't changed.
+    branches: ['*']
+    paths:
+      - 'doc/**'
+      - '!doc/*ChangeLog*'
+      - '!doc/*ChangeSum*'
+      - '!doc/UpdateChangelog.pl'
+
+  pull_request:
+    # Run on pull requests that change the listed files
+    paths:
+      - 'doc/**'
+      - '!doc/*ChangeLog*'
+      - '!doc/*ChangeSum*'
+      - '!doc/UpdateChangelog.pl'
+
+  workflow_dispatch:
+
+jobs:
+  build-docs-omnibus-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          lfs: true
+
+      - name: Checkout doc-builder external
+        run: |
+          bin/git-fleximod update doc-builder
+
+      # Set up conda
+      - name: Set up conda environment
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          activate-environment: ctsm_pylib
+          environment-file: python/conda_env_ctsm_py.yml
+          channels: conda-forge
+          auto-activate-base: false
+
+      # TODO: Split testing.sh tests into their own steps in this job
+      - name: Text Sphinx builds with omnibus script
+        if: success() || failure()
+        run: |
+          cd doc && conda run -n ctsm_pylib ./testing.sh

doc/testing.sh

@@ -5,6 +5,7 @@ set -x
 rm -rf _publish*
 
 # Build all docs using container
+echo "~~~~~ Build all docs using container"
 # Also do a custom --conf-py-path
 rm -rf _build _publish
 d1="$PWD/_publish_container"
@@ -13,29 +14,35 @@ d1="$PWD/_publish_container"
 cp -a _publish "${d1}"
 
 # Build all docs using ctsm_pylib
+echo "~~~~~ Build all docs using ctsm_pylib"
 rm -rf _build _publish
 d2="$PWD/_publish_nocontainer"
 conda run -n ctsm_pylib ./build_docs_to_publish -r _build --site-root "$PWD/_publish"
 # VERSION LINKS WILL NOT RESOLVE IN _publish_nocontainer
 cp -a _publish "${d2}"
 
 # Make sure container version is identical to no-container version
+echo "~~~~~ Make sure container version is identical to no-container version"
 diff -qr "${d1}" "${d2}"
 
 # Check that -r -v works
+echo "~~~~~ Check that -r -v works"
 # Also do a custom --conf-py-path
 rm -rf _build_docker
 ./build_docs -r _build_docker -v latest -d -c --conf-py-path doc-builder/test/conf.py --static-path ../_static --templates-path ../_templates
 
 # Check that Makefile method works
+echo "~~~~~ Check that Makefile method works"
 rm -rf _build
 make SPHINXOPTS="-W --keep-going" BUILDDIR=${PWD}/_build html
 
 # Check that -b works
+echo "~~~~~ Check that -b works"
 rm -rf _build_docker
 ./build_docs -b _build_docker -d -c
 
 # Check that doc-builder tests pass
+echo "~~~~~ Check that doc-builder tests pass"
 cd doc-builder/test
 conda run -n ctsm_pylib make test