Merge pull request #5123 from jluhrsen/pages-test

add job to test github pages deployment

Author: tssurya

.github/workflows/static.yml renamed to .github/workflows/docs.yml

@@ -1,10 +1,11 @@
 # Simple workflow for deploying static content to GitHub Pages
-name: Deploy static content to Pages
+name: Test and Deploy static content to Pages
 
 on:
-  # Runs on pushes targeting the default branch
   push:
     branches: ["master"]
+  pull_request:
+    branches: ["master"]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -22,11 +23,12 @@ concurrency:
   cancel-in-progress: false
 
 jobs:
-  # Single deploy job since we're just deploying
+  # build and deploy pages on merges
   deploy:
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
+    if: github.event_name != 'pull_request'
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -47,3 +49,21 @@ jobs:
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4
+  # test that docs build correctly on PRs
+  test-deploy:
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: |
+          pip install mkdocs-material
+          pip install $(mkdocs-get-deps)
+      - run: mkdocs build
+      - name: Upload Artifact (Test)
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-mkdocs-site
+          path: ./site

docs/ci/ci.md

@@ -14,6 +14,7 @@ The following tasks are performed:
 - Check out the Kubernetes source tree and compiles some dependencies
 - Install KIND
 - Run a matrix of End-To-End Tests using KIND
+- Ensure that documentation builds successfully
 
 The full matrix of e2e tests found [here](https://github.com/ovn-org/ovn-kubernetes/blob/master/.github/workflows/test.yml)
 are also run periodically (twice daily) using an OVN-Kubernetes build based on the currently merged code base.
@@ -379,3 +380,12 @@ defined in https://github.com/kubernetes-sigs/network-policy-api/tree/master/con
 and then invoked from this repo. Any changes to the tests first have to be submitted
 upstream to `network-policy-api` repo and then brought downstream into the ovn-kubernetes repo
 through version bump.
+
+# Documentation Build Check
+
+To catch any potential documentation build breakages which would prevent any docs changes
+from being deployed to our GitHub Pages [site](https://github.com/ovn-org/ovn-kubernetes). The build check will produce the
+html docs and will be available in the job artifacts for review. There is a link printed
+in the job run logs inside the step "Upload Artifact". Download and unzip that locally 
+to view the resulting docs after they are built to see what would be deployed to github
+pages.