generate-api-documentation.yaml 751 B

123456789101112131415161718192021222324252627
  1. name: javascript-packages
  2. on:
  3. push:
  4. paths:
  5. - openapi.yaml
  6. jobs:
  7. run:
  8. name: Generate API Documentation
  9. runs-on: ubuntu-latest
  10. steps:
  11. - name: Checkout repo
  12. uses: actions/checkout@v3
  13. - name: Run redoc on openapi.yaml
  14. run: |
  15. npx redoc-cli bundle openapi.yaml -o docs/api/index.html --options '{"hideHostname": true, "pathInMiddlePanel": true}'
  16. - name: Commit changes
  17. uses: EndBug/add-and-commit@v9
  18. with:
  19. author_name: Owncast
  20. author_email: owncast@owncast.online
  21. message: "Commit updated API documentation"
  22. add: "docs/api/index.html"
  23. env:
  24. GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}