Docs deploy CI updated for production deployment

.github/workflows/docs_legacy.yml → .github/workflows/docs_build.yml

@@ -1,22 +1,15 @@
-name: Build the Docs Legacy ReadTheDocs CI
+name: Documentation Build and Deploy CI
 
 on:
-  push:
-    branches:
-    - master
-    - release/*
-    paths:
-    - 'docs/**'
-    - '.github/workflows/docs_legacy.yml'
   pull_request:
     paths:
     - 'docs/**'
-    - '.github/workflows/docs_legacy.yml'
+    - '.github/workflows/docs.yml'
 
 jobs:
 
   build-docs:
-    name: Build ReadTheDocs
+    name: Build Documentation
     runs-on: ubuntu-22.04
     defaults:
       run:
@@ -34,5 +27,11 @@ jobs:
         sudo apt install python3-pip python3-setuptools
         # GitHub CI installs pip3 and setuptools outside the path.
         # Update the path to include them and run.
-        PATH=/home/runner/.local/bin:$PATH pip3 install --user -r ./docs/requirements.txt
-        cd ./docs && PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" make html
+        cd ./docs
+        PATH=/home/runner/.local/bin:$PATH pip3 install -r requirements.txt --prefer-binary
+        PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" build-docs -l en
+    - name: Archive Docs
+      uses: actions/upload-artifact@v2
+      with:
+        name: docs
+        path: docs

.github/workflows/docs_deploy.yml

@@ -1,50 +1,17 @@
-name: Documentation Build and Deploy CI
+name: Documentation Build and Deploy Production CI
 
 on:
   push:
     branches:
-    - master
     - release/*
     paths:
     - 'docs/**'
     - '.github/workflows/docs.yml'
-  pull_request:
-    paths:
-    - 'docs/**'
-    - '.github/workflows/docs.yml'
 
 jobs:
 
-  build-docs:
-    name: Build ESP-Docs
-    runs-on: ubuntu-22.04
-    defaults:
-      run:
-        shell: bash
-    steps:
-    - uses: actions/checkout@v3
-      with:
-        submodules: true
-    - uses: actions/setup-python@v4
-      with:
-        python-version: '3.10'
-    - name: Build
-      run: |
-        sudo apt update
-        sudo apt install python3-pip python3-setuptools
-        # GitHub CI installs pip3 and setuptools outside the path.
-        # Update the path to include them and run.
-        cd ./docs
-        PATH=/home/runner/.local/bin:$PATH pip3 install -r requirements.txt --prefer-binary
-        PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" build-docs -l en
-    - name: Archive Docs
-      uses: actions/upload-artifact@v2
-      with:
-        name: docs
-        path: docs
-
-  deploy-preview-docs:
-    name: Deploy Documentation
+  deploy-prod-docs:
+    name: Deploy Documentation Production
     runs-on: ubuntu-22.04
     defaults:
       run:
@@ -59,20 +26,12 @@ jobs:
     - name: Deploy Preview
       env:
         # Deploy to production server
-        # DOCS_BUILD_DIR: "./docs/_build/"
-        # DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_DEPLOY_KEY }}
-        # DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }}
-        # DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_SERVER_USER }}
-        # DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }}
-        # DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }}
-        # Deploy to preview server
-        TYPE: "preview"
         DOCS_BUILD_DIR: "${CI_PROJECT_DIR}/docs/_build/"
-        DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_KEY }}
-        DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }}
-        DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }}
-        DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }}
-        DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_USER }}
+        DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_PROD_PRIVATEKEY }}
+        DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PROD_PATH }}
+        DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_PROD_SERVER }}
+        DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_PROD_URL_BASE }}
+        DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_PROD_USER }}
       run: |
         sudo apt update
         sudo apt install python3-pip python3-setuptools

.github/workflows/docs_preview.yml

@@ -0,0 +1,46 @@
+name: Documentation Build and Deploy CI
+
+on:
+  push:
+    branches:
+    - master
+    paths:
+    - 'docs/**'
+    - '.github/workflows/docs.yml'
+
+jobs:
+
+  deploy-preview-docs:
+    name: Deploy Documentation Preview
+    runs-on: ubuntu-22.04
+    defaults:
+      run:
+        shell: bash
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        submodules: true
+    - uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+    - name: Deploy Preview
+      env:
+        # Deploy to preview server
+        DOCS_BUILD_DIR: "${CI_PROJECT_DIR}/docs/_build/"
+        DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_KEY }}
+        DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }}
+        DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }}
+        DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }}
+        DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_USER }}
+      run: |
+        sudo apt update
+        sudo apt install python3-pip python3-setuptools
+        source ./docs/utils.sh
+        add_doc_server_ssh_keys $DOCS_DEPLOY_PRIVATEKEY $DOCS_DEPLOY_SERVER $DOCS_DEPLOY_SERVER_USER
+        export GIT_VER=$(git describe --always)
+        echo "PIP install requirements..."
+        pip3 install --user -r ./docs/requirements.txt
+        echo "Building the Docs..."
+        cd ./docs && build-docs -l en
+        echo "Deploy the Docs..."
+        deploy-docs

docs/utils.sh

@@ -5,7 +5,7 @@ function add_ssh_keys() {
   mkdir -p ~/.ssh
   chmod 700 ~/.ssh
   echo -n "${key_string}" >~/.ssh/id_rsa_base64
-  base64 -w 0 ~/.ssh/id_rsa_base64 | base64 -di >~/.ssh/id_rsa
+  base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 >~/.ssh/id_rsa
   chmod 600 ~/.ssh/id_rsa
 }