doc-publish-typescript-project.yml

name: Build and Document Application

on:
  workflow_call:
    secrets:
      token:
        description: 'The GitHub/npm token'
        required: true

jobs:
  build-docs:
    name: Build Docs
    runs-on: ubuntu-latest
    env:
      working-directory: ./
    defaults:
      run:
        working-directory: ${{env.working-directory}}
    steps:
      - name: Setup
        uses: OpenPhone/gha/.github/actions/setup@v5
        with:
          token: ${{ secrets.token }}
          working-directory: ${{env.working-directory}}

      - name: Typecheck
        run: npm run typecheck

      - name: Lint
        run: npm run lint

      - name: Build
        run: npm run build

      - name: Generate Docs
        run: npm run doc

      - name: Setup Pages
        uses: actions/configure-pages@v3
        with:
          token: ${{ secrets.token }}

      - name: Update Swagger UI
        env:
          SWAGGER_YAML: "openapi.json"
        run: |
          mkdir -p docs
          cd docs
          release_tag=$(curl -sL https://api.github.com/repos/swagger-api/swagger-ui/releases/latest | jq -r ".tag_name")
          echo "release_tag=$release_tag" >> $GITHUB_OUTPUT
          # Download the release
          curl -sL -o $release_tag https://api.github.com/repos/swagger-api/swagger-ui/tarball/$release_tag
          # Extract the dist directory
          tar -xzf $release_tag --strip-components=1 $(tar -tzf $release_tag | head -1 | cut -f1 -d"/")/dist
          rm $release_tag
          # Move index.html to the root
          mv dist/index.html .
          # Fix references in dist/swagger-initializer and index.html
          sed -i "s|https://petstore.swagger.io/v2/swagger.json|$SWAGGER_YAML|g" dist/swagger-initializer.js
          sed -i "s|href=\"./|href=\"dist/|g" index.html
          sed -i "s|src=\"./|src=\"dist/|g" index.html
          sed -i "s|href=\"index|href=\"dist/index|g" index.html

      - name: Upload Artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: "./docs"

  deploy-docs:
    name: Deploy Docs to Github Pages
    runs-on: ubuntu-latest
    needs: build-docs

    permissions:
      pages: write
      id-token: write

    environment:
      # environment created automatically by GitHub
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2
        with:
          token: ${{ secrets.token }}