Feature 1819 automation doc warnings (#1836)

.github/jobs/build_documentation.sh

@@ -0,0 +1,25 @@
+#! /bin/bash
+
+# path to docs directory relative to top level of repository
+# $GITHUB_WORKSPACE is set if the actions/checkout@v2 action is run first
+
+DOCS_DIR=${GITHUB_WORKSPACE}/met/docs
+
+# run Make to build the documentation and return to previous directory
+cd ${DOCS_DIR}
+make clean html
+cd -
+
+# copy HTML output into directory to create an artifact
+mkdir -p artifact/documentation
+cp -r ${DOCS_DIR}/_build/html/* artifact/documentation
+
+# check if the warnings.log file is empty
+# Copy it into the artifact and documentation directories
+# so it will be available in the artifacts
+warning_file=${DOCS_DIR}/_build/warnings.log
+if [ -s $warning_file ]; then
+    cp -r ${DOCS_DIR}/_build/warnings.log artifact/doc_warnings.log
+    cp artifact/doc_warnings.log artifact/documentation
+    exit 1
+fi

.github/workflows/main.yml → .github/workflows/documentation.yml

@@ -1,4 +1,4 @@
-name: MET CI/CD Workflow
+name: Documentation
 on:
   push:
     branches:
@@ -7,6 +7,8 @@ on:
       - feature_*
       - main_*
       - bugfix_*
+    paths:
+      - met/docs/**
   pull_request:
     types: [opened, reopened, synchronize]
 
@@ -24,26 +26,14 @@ jobs:
           python -m pip install --upgrade python-dateutil requests sphinx \
           sphinx-gallery Pillow sphinx_rtd_theme
       - name: Build docs
-        continue-on-error: true
-        run: |
-          DOCS_DIR=${GITHUB_WORKSPACE}/met/docs
-          cd ${DOCS_DIR}
-          make clean html
-          cd ${GITHUB_WORKSPACE}
-          warning_file=${DOCS_DIR}/_build/warnings.log
-          mkdir -p artifact/documentation
-          cp -r ${DOCS_DIR}/_build/html/* artifact/documentation
-          if [ -s $warning_file ]; then
-            cp -r ${DOCS_DIR}/_build/warnings.log artifact/doc_warnings.log
-            cp artifact/doc_warnings.log artifact/documentation
-          else
-            rm ${warning_file}
-          fi
+        run: ./.github/jobs/build_documentation.sh
       - uses: actions/upload-artifact@v2
+        if: always()
         with:
           name: documentation
           path: artifact/documentation
       - uses: actions/upload-artifact@v2
+        if: failure()
         with:
           name: documentation_warnings.log
           path: artifact/doc_warnings.log