docs: publish docs too zoomin

Add pipeline to publidh docs to zoomin.

Signed-off-by: Giacomo Dematteis <[email protected]>

Author: DematteisGiacomo

.github/workflows/docs-build-and-publish-zooomin.yml

@@ -0,0 +1,106 @@
+name: Documentation Build and Publish to Zoomin
+
+on:
+  workflow_dispatch:
+    inputs:
+      documentation_tag:
+        type: string
+        required: false
+        default: "latest"
+        description: "Label of the documentation"
+      publish_to_prod:
+        type: boolean
+        default: false
+      publish_to_dev:
+        type: boolean
+        default: true
+
+  workflow_call:
+    inputs:
+      documentation_tag:
+        type: string
+        required: true
+        default: "latest"
+      publish_to_prod:
+        type: boolean
+        default: false
+      publish_to_dev:
+        type: boolean
+        default: true
+
+jobs:
+  docs-build-and-publish:
+    env:
+      ARCHIVE: "addon-thingy91x_oob_${{inputs.documentation_tag}}.zip"
+
+    runs-on: ubuntu-latest
+
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+      cancel-in-progress: true
+
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y python3 python3-pip
+
+      - name: Install Python dependencies
+        working-directory: docs
+        run: |
+          python3 -m pip install -r requirements.txt
+
+      - name: Build documentation
+        working-directory: docs
+        run: |
+          sphinx-build -M html . build
+
+          cp custom.properties build/html
+          sed -i 's/__VERSION__/'"${{inputs.documentation_tag}}"'/g' build/html/custom.properties
+
+          cp tags.yml build/html
+          sed -i 's/__VERSION__/'"${{inputs.documentation_tag}}"'/g' build/html/tags.yml
+
+          cd build/html
+
+          zip -rq "${{env.ARCHIVE}}" .
+          ls -lah .
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: doc-build
+          if-no-files-found: error
+          retention-days: 2
+          path: |
+            docs/build/html/${{env.ARCHIVE}}
+
+      - name: Prepare Key
+        run: |
+          mkdir -p /root/.ssh
+          ssh-keyscan upload-v1.zoominsoftware.io >> /root/.ssh/known_hosts
+
+          echo "${{ secrets.ZOOMIN_KEY }}" > zoomin_key
+          chmod 600 zoomin_key
+
+      - name: Publish documentation - prod
+        if: ${{inputs.publish_to_prod}}
+        run: |
+          sftp -v -i zoomin_key [email protected] <<EOF
+            cd docs-be.zoominsoftware.io/sphinx-html/incoming
+            put docs/build/html/${{env.ARCHIVE}}
+          EOF
+
+      - name: Publish documentation - dev
+        if: ${{inputs.publish_to_dev}}
+        run: |
+          sftp -v -i zoomin_key [email protected] <<EOF
+            cd nordic-be-dev.zoominsoftware.io/sphinx-html/incoming
+            put docs/build/html/${{env.ARCHIVE}}
+          EOF

.github/workflows/docs-build-and-publish.yml

@@ -7,7 +7,6 @@ on:
       - main
     paths:
       - '.github/workflows/docs-build-and-publish.yml'
-      - 'docs/**'
   push:
     branches:
       - main

.github/workflows/on-push-zoomin-publish.yml

@@ -0,0 +1,18 @@
+# Publish latest documentation on push to main
+name: Publish latest documentation on push
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'doc/**'
+
+jobs:
+  deploy:
+    uses: ./.github/workflows/docs-build-and-publish.yml
+    with:
+      documentation_tag: "latest"
+      publish_to_prod: false
+      publish_to_dev: true
+    secrets: inherit

docs/custom.properties

@@ -0,0 +1,2 @@
+manual.name=addon-nrfcloud_firmware-__VERSION__
+booktitle=Hello nRF Cloud firmware Add-on __VERSION__

docs/tags.yml

@@ -0,0 +1,9 @@
+# Document tags for Zoomin.
+
+# Tags for all topics:
+mapping_global:
+  - addon-hello-nrfcloud-firmware-__VERSION__
+  - cluster-addon-hello-nrfcloud-firmware-__VERSION__
+
+# Tags for individual topics:
+mapping_topics: