add_doc_server_ssh_keys bash script

Author: tore-espressif

.github/workflows/docs.yml

@@ -73,23 +73,20 @@ jobs:
           echo "version=$git_ver" >> $GITHUB_OUTPUT
           echo "GIT_VER=$git_ver" >> $GITHUB_ENV
 
-      - name: Set up SSH
-        run: |
-          mkdir -p ~/.ssh
-          echo "${{ secrets.DOCS_PRIVATEKEY }}" > ~/.ssh/id_rsa
-          chmod 600 ~/.ssh/id_rsa
-          ssh-keyscan -H ${{ vars.DOCS_SERVER }} >> ~/.ssh/known_hosts || true
-
       - name: Deploy documentation
         working-directory: docs
+        shell: bash
         env:
           GIT_VER: ${{ steps.git_version.outputs.version }}
           DOCS_BUILD_DIR: ${{ github.workspace }}/docs/_build
           DOCS_DEPLOY_URL_BASE: ${{ vars.DOCS_URL_BASE }}
           DOCS_DEPLOY_SERVER: ${{ vars.DOCS_SERVER }}
           DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_SERVER_USER }}
           DOCS_DEPLOY_PATH: ${{ vars.DOCS_PATH }}
+          DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_PRIVATEKEY }}
           # TYPE is optional - only used for output formatting (shows "deploy" or "preview" in logs)
-          #TYPE: ${{ github.ref_name == 'master' && 'deploy' || 'preview' }}
+          TYPE: ${{ github.ref_name == 'master' && 'deploy' || 'preview' }}
         run: |
+          source $GITHUB_WORKSPACE/docs/utils.sh
+          add_doc_server_ssh_keys "$DOCS_DEPLOY_PRIVATEKEY" "$DOCS_DEPLOY_SERVER" "$DOCS_DEPLOY_SERVER_USER"
           deploy-docs

docs/utils.sh

@@ -0,0 +1,18 @@
+# Bash helper functions for adding SSH keys
+
+function add_ssh_keys() {
+  local key_string="${1}"
+  mkdir -p ~/.ssh
+  chmod 700 ~/.ssh
+  echo -n "${key_string}" >~/.ssh/id_rsa_base64
+  base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 >~/.ssh/id_rsa
+  chmod 600 ~/.ssh/id_rsa
+}
+
+function add_doc_server_ssh_keys() {
+  local key_string="${1}"
+  local server_url="${2}"
+  local server_user="${3}"
+  add_ssh_keys "${key_string}"
+  echo -e "Host ${server_url}\n\tStrictHostKeyChecking no\n\tUser ${server_user}\n" >>~/.ssh/config
+}