docs-deployment.yml

name: Docs Deployment

on:
  push:
    branches: ["master"]
    paths:
      - ".vscode/**.yml"

jobs:
  generate:
    runs-on: ubuntu-latest
    if: ${{ github.repository_owner == 'placeholder-app' }}
    steps:
      # Pull backend repository and place in ./backend
      - name: Checkout backend
        uses: actions/checkout@v3
        with:
          path: ./backend

      # Pull current api-docs repository and place in ./api-docs
      - name: Checkout api-docs
        uses: actions/checkout@v3
        with:
          repository: placeholder-app/api-docs
          path: ./api-docs
          token: ${{ secrets.API_TOKEN }}

      # Use backend repository openapi.yml to generate docs
      - name: Generate OpenAPI Docs
        uses: openapi-generators/openapitools-generator-action@v1
        with:
          generator: html2
          openapi-file: ./backend/.vscode/openapi.yml
          command-args: -o ./api-docs/docs

      # Push changes to api-docs repository
      - name: Push Updated Documentation
        run: |
          cd ./api-docs
          git config --local user.name "github-actions[bot]"
          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
          git add .
          git commit -m "Documentation Update"
          git push origin main --force