api-docs.yml 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. name: Build and publish v1 API docs
  2. on:
  3. push:
  4. branches: [v1_release]
  5. paths:
  6. - docfx/**
  7. permissions:
  8. id-token: write
  9. pages: write
  10. jobs:
  11. deploy:
  12. name: Build and Deploy v1 API docs to github-pages
  13. environment:
  14. name: github-pages
  15. url: ${{ steps.deployment.outputs.page_url }}
  16. runs-on: windows-latest
  17. steps:
  18. - name: Checkout
  19. uses: actions/checkout@v4
  20. - name: DocFX Build
  21. working-directory: docfx
  22. run: |
  23. dotnet tool install -g docfx
  24. $env:DOCFX_SOURCE_BRANCH_NAME="${{ github.ref_name }}"
  25. docfx metadata
  26. docfx build
  27. continue-on-error: false
  28. - name: Setup Pages
  29. uses: actions/configure-pages@v5
  30. - name: Upload artifact
  31. uses: actions/upload-pages-artifact@v2
  32. with:
  33. path: docfx/_site
  34. - name: Terminal.GuiV1Docs Repository Dispatch ${{ github.ref_name }}
  35. if: github.ref_name == 'v1_release'
  36. uses: peter-evans/repository-dispatch@v3
  37. with:
  38. token: ${{ secrets.V2DOCS_TOKEN }}
  39. repository: gui-cs/Terminal.GuiV1Docs
  40. event-type: v1_release_push
  41. client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'