initial commit

Change-Id: Ied1b5f2137f2b5f803d5411235607bd27c5e57ba
2026-03-24 10:43:21 +00:00
commit e868792eda
19 changed files with 1205 additions and 0 deletions
--- a/.gitea/workflows/techdocs.yml
+++ b/.gitea/workflows/techdocs.yml
@@ -0,0 +1,108 @@
+name: Build and Publish TechDocs
+
+on:
+  workflow_run:
+    workflows: ["Build and Push to ACR"]
+    branches: [main]
+    types: [completed]
+  workflow_dispatch: {}
+
+env:
+  AZURE_FEDERATED_TOKEN_FILE: /var/run/secrets/azure/tokens/azure-identity-token
+  AZURE_ACCOUNT_NAME: "bstagecjotdevsttechdocs"
+  ENTITY_NAMESPACE: default
+  ENTITY_KIND: component
+  ENTITY_NAME: tmpl-test-go
+
+jobs:
+  guard:
+    name: Platform guard
+    runs-on: ubuntu-latest
+    outputs:
+      ready: 
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check platform initialized
+        id: check
+        run: |
+          if [ -f ".platform/initialized.md" ]; then
+            echo "ready=true" >> $GITHUB_OUTPUT
+            echo "Proceeding: platform initialized"
+          else
+            echo "ready=false" >> $GITHUB_OUTPUT
+            echo "Skipping: .platform/initialized.md not on main yet - merge the dev->main PR first"
+          fi
+
+  build-and-publish:
+    needs: guard
+    if: needs.guard.outputs.ready == 'true' && (github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch')
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Bootstrap pip
+        run: |
+          python3 --version
+          if python3 -m pip --version 2>/dev/null; then
+            echo "pip already available"
+          elif python3 -m ensurepip --version 2>/dev/null; then
+            python3 -m ensurepip --upgrade
+          else
+            apt-get update -qq
+            apt-get install -y python3-pip
+          fi
+          python3 -m pip install --upgrade pip
+          python3 -m pip --version
+
+      - name: Install dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+          python3 -m pip install \
+            mkdocs-techdocs-core==1.* \
+            mkdocs-git-revision-date-localized-plugin \
+            mkdocs-awesome-pages-plugin
+
+          npm install -g @techdocs/cli
+
+      - name: Validate MkDocs config
+        run: mkdocs build --strict --site-dir /tmp/mkdocs-validate
+
+      - name: Build TechDocs site
+        run: |
+          techdocs-cli generate \
+            --source-dir . \
+            --output-dir ./site \
+            --no-docker \
+            --verbose
+
+      - name: Install Azure CLI
+        run: |
+          if command -v az &>/dev/null; then
+            echo "Azure CLI already installed: $(az version --query '"azure-cli"' -o tsv)"
+          else
+            curl -sL https://aka.ms/InstallAzureCLIDeb | bash
+          fi
+
+      - name: Azure login (OIDC)
+        run: |
+          az login \
+            --service-principal \
+            --username "$AZURE_CLIENT_ID" \
+            --tenant "$AZURE_TENANT_ID" \
+            --federated-token "$(cat $AZURE_FEDERATED_TOKEN_FILE)"
+
+          echo "Azure login successful"
+
+      - name: Publish TechDocs site
+        run: |
+          techdocs-cli publish \
+            --publisher-type azureBlobStorage \
+            --storage-name "techdocs" \
+            --azureAccountName "$AZURE_ACCOUNT_NAME" \
+            --entity "$ENTITY_NAMESPACE/$ENTITY_KIND/$ENTITY_NAME"