Improves docs deploy job (#352)

This PR improves the initial docs deploy job that was introduced in PR:
#342

Add script for the docs deployment

- For pre-release, deploy at `dev`
- For release, deploy at version
- For PR, deploy at `dev`

.github/workflows/cicd.yaml

@@ -246,7 +246,7 @@ jobs:
 
           git fetch origin gh-pages --depth=1
 
-          if [[ $GITHUB_EVENT_NAME == "release" && $GITHUB_EVENT_ACTION == "published" ]]; then
+          if [[ $GITHUB_EVENT_NAME == "release" ]]; then
               hatch run docs:gh-release
           else
               hatch run docs:gh-deploy
@@ -258,6 +258,8 @@ jobs:
     needs:
       - Static-Check
       - Run-Unit-Tests
+      - Run-Integration-Tests
+      - Deploy-Pages
       - Code-Coverage
     runs-on: ubuntu-latest
     steps:

dagfactory/__init__.py

@@ -2,7 +2,7 @@
 
 from .dagfactory import DagFactory, load_yaml_dags
 
-__version__ = "0.21.0"
+__version__ = "0.22.0a2"
 __all__ = [
     "DagFactory",
     "load_yaml_dags",

pyproject.toml

@@ -117,8 +117,8 @@ dependencies = [
 
 [tool.hatch.envs.docs.scripts]
 dev = "mkdocs build && mkdocs serve" # For local development and preventing publishing
-gh-deploy = "mike deploy --push dev"
-gh-release = "version=$(python -W ignore -c 'import dagfactory; print(dagfactory.__version__)') && mike deploy --push --update-aliases $version latest"
+gh-deploy = "python scripts/docs_deploy.py dev"
+gh-release = "python scripts/docs_deploy.py release"
 
 ######################################
 # THIRD PARTY TOOLS

scripts/docs_deploy.py

@@ -0,0 +1,41 @@
+import subprocess
+import sys
+
+from packaging import version
+
+import dagfactory
+
+
+def deploy_docs(deploy_type: str):
+    _version = version.parse(dagfactory.__version__)
+
+    set_default = False
+
+    if deploy_type == "release":
+        if _version.pre is not None:
+            command = ["mike", "deploy", "--push", "dev"]
+        else:
+            command = ["mike", "deploy", "--push", "--update-aliases", str(_version), "latest"]
+            set_default = True
+    else:
+        command = ["mike", "deploy", "--push", "dev"]
+
+    try:
+        subprocess.run(command, capture_output=True, text=True, check=True)
+        if set_default:
+            default_command = ["mike", "set-default", "latest"]
+            subprocess.run(default_command, capture_output=True, text=True, check=True)
+    except subprocess.CalledProcessError as e:
+        raise Exception(f"Error deploying: {e.stderr}")
+
+
+if __name__ == "__main__":
+    if len(sys.argv) < 2:
+        raise Exception("Argument deploy type is required: 'dev' or 'release'")
+
+    deploy_type = sys.argv[1]
+
+    if deploy_type not in ["dev", "release"]:
+        raise Exception("Invalid argument provided. Valid deploy types are 'dev' or 'release'.")
+
+    deploy_docs(deploy_type)