documentation-upload.yaml

name: Generate and upload documentation

on:
  release:
    types: [published]
  workflow_dispatch:
    inputs:
      version:
        description: 'Version to use for the documentation package in semver format (e.g. 1.2.3)'
        required: true

jobs:
  upload-documentation:
    runs-on: ubuntu-latest
    env:
      SDK_NAME: sinch-sdk-python

    steps:
      - name: Checkout Code
        uses: actions/checkout@v4

      - name: Resolve Version
        id: version
        run: |
          if [ "${{ github.event_name }}" = "release" ]; then
            VERSION="${{ github.event.release.tag_name }}"
          else
            VERSION="${{ inputs.version }}"
          fi
          # Strip leading 'v' if present (e.g. v1.2.3 → 1.2.3)
          VERSION="${VERSION#v}"
          echo "value=${VERSION}" >> "$GITHUB_OUTPUT"

      - name: Validate Version Format
        run: |
          VERSION="${{ steps.version.outputs.value }}"
          SEMVER_REGEX='^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-((alpha|beta|preview)(\.[0-9]+)?))?$'
          if [[ ! "$VERSION" =~ $SEMVER_REGEX ]]; then
            echo "::error::Invalid version format: '$VERSION'. Expected semver (e.g. 1.2.3, 1.2.3-alpha, 1.2.3-beta.1, 1.2.3-preview)"
            exit 1
          fi
          echo "Version '$VERSION' is valid"

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.11'

      - name: Install dev dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements-dev.txt

      - name: Generate Documentation
        run: |
          make docs

      - name: Package Documentation
        run: |
          cd docs/build/html
          zip -r "../../../${{ env.SDK_NAME }}-${{ steps.version.outputs.value }}.zip" .

      - name: Upload to GitLab Registry
        run: |
          echo "Uploading documentation package to GitLab Registry..."
          VERSION="${{ steps.version.outputs.value }}"
          curl --fail --show-error --location --header "PRIVATE-TOKEN: ${{ secrets.GITLAB_REGISTRY_UPLOAD_DOC_TOKEN }}" \
               --upload-file "./${{ env.SDK_NAME }}-${VERSION}.zip" \
               "https://gitlab.com/api/v4/projects/63164411/packages/generic/${{ env.SDK_NAME }}/${VERSION}/${{ env.SDK_NAME }}-${VERSION}.zip"
          echo "Documentation package for version ${VERSION} uploaded to GitLab Registry"

      - name: Trigger Downstream GitLab Pipeline
        run: |
          echo "Triggering downstream GitLab pipeline to notify about new documentation package version..."
          VERSION="${{ steps.version.outputs.value }}"
          curl --fail --show-error --location --request POST \
               --form "token=${{ secrets.GITLAB_NOTIFY_REGISTRY_UPLOADED_DOC_TOKEN }}" \
               --form "ref=main" \
               --form "variables[UPSTREAM_PACKAGE_NAME]=${{ env.SDK_NAME }}" \
               --form "variables[UPSTREAM_PACKAGE_VERSION]=${VERSION}" \
               "https://gitlab.com/api/v4/projects/63164411/trigger/pipeline"
          echo "Documentation repo notified about new package version ${VERSION}"