CI: Merge two docs CIs to one (#1183)

* simplify a bit

* Update to artifact

* Merge `docs-preview.yml` and `docs.yml`

* not installed mkdocs will skip

* remove name

* use editable mode to avoid _pytest.pathlib.ImportPathMismatchError

* adjust block

* use better steps name

* Update CHANGELOG.md

* simplify name

* lint codes

* adjust block sequences

Author: Zeroto521

.github/workflows/docs-preview.yml

@@ -1,14 +1,16 @@
-name: Build documentation
+name: documentation
 
 on:
   push:
     branches:
       - dev
+  pull_request:
+    branches:
+      - dev
 
 jobs:
-  build-docs:
+  build:
     runs-on: ubuntu-latest
-    name: Build documentation
 
     # https://github.com/marketplace/actions/setup-miniconda#use-a-default-shell
     defaults:
@@ -25,19 +27,43 @@ jobs:
         with:
           auto-update-conda: true
           miniforge-variant: Mambaforge
-          channels: conda-forge
-          activate-environment: pyjanitor-dev
           environment-file: environment-dev.yml
           use-mamba: true
 
+      - name: Install pyjanitor
+        # use editable mode to avoid _pytest.pathlib.ImportPathMismatchError
+        run: pip install -e .
+
       - name: Build docs
-        run: |
-          conda activate pyjanitor-dev
-          python -m ipykernel install --user --name pyjanitor-dev
-          pip install -e .
-          mkdocs build
+        run: mkdocs build
+
+      - uses: actions/upload-artifact@v3
+        with:
+          name: website
+          path: site/
+
+      - name: Test docs
+        run: pytest -m "documentation"
+
+      - name: Docs preview
+        if: ${{ github.event_name == 'pull_request' }}
+        uses: nwtgck/[email protected]
+        with:
+          publish-dir: "./site"
+          production-deploy: false
+          github-token: ${{ secrets.GHPAGES_TOKEN }}
+          deploy-message: "Deploy from GitHub Actions"
+          enable-pull-request-comment: true
+          enable-commit-comment: false
+          overwrites-pull-request-comment: true
+          alias: deploy-preview-${{ github.event.number }}
+        env:
+          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
+        timeout-minutes: 1
 
       - name: Deploy website
+        if: ${{ github.event_name == 'push' }}
         uses: peaceiris/actions-gh-pages@v3
         with:
           # https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-set-personal-access-token-personal_token

.github/workflows/docs.yml

@@ -30,6 +30,7 @@
 -   [ENH] Add explicit default parameter to `case_when` function. Issue #1159 @samukweku
 -   [BUG] pandas 1.5.x `_MergeOperation` doesn't have `copy` keyword anymore. Issue #1174 @Zeroto521
 -   [TST] Compat with macos and window, to fix `FailedHealthCheck` Issue #1181 @Zeroto521
+-   [INF] Merge two docs CIs (`docs-preview.yml` and `docs.yml`) to one. And add `documentation` pytest mark. PR #1183 @Zeroto521
 
 ## [v0.23.1] - 2022-05-03
 

CHANGELOG.md

@@ -12,4 +12,5 @@ markers =
     spark_functions: tests for pyspark functions
     xarray: tests for xarray functions
     timeseries: tests for timeseries
+    documentation: tests for documentation
     turtle: tests that take more than 5 seconds to execute

pytest.ini

@@ -2,7 +2,16 @@
 
 import os
 
+import pytest
 
+
+# If `mkdocs` wasn't installed in environment, just skip.
+# Can't use `pytest.importorskip("mkdocs")`, 'mkdocs' is also
+# a folder name to pyjanitor project.
+pytest.importorskip("mkdocstrings")
+
+
+@pytest.mark.documentation
 def test_docs_general_functions_present():
     """Test that all docs pages build correctly.