owncast/.github/workflows/generate-api-documentation.yaml

28 lines
751 B
YAML
Raw Normal View History

name: javascript-packages
on:
push:
paths:
- openapi.yaml
jobs:
run:
name: Generate API Documentation
runs-on: ubuntu-latest
steps:
- name: Checkout repo
2022-04-10 14:54:39 +03:00
uses: actions/checkout@v3
- name: Run redoc on openapi.yaml
run: |
npx redoc-cli bundle openapi.yaml -o docs/api/index.html --options '{"hideHostname": true, "pathInMiddlePanel": true}'
- name: Commit changes
uses: EndBug/add-and-commit@v9
with:
author_name: Owncast
author_email: owncast@owncast.online
message: "Commit updated API documentation"
add: "docs/api/index.html"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}