mirror of
https://github.com/owncast/owncast.git
synced 2024-11-25 22:31:09 +03:00
Render api documentation when openapi.yaml is updated
This commit is contained in:
parent
2b8aea8797
commit
03151f1dd1
1 changed files with 28 additions and 0 deletions
28
.github/workflows/generate-api-documentation.yaml
vendored
Normal file
28
.github/workflows/generate-api-documentation.yaml
vendored
Normal file
|
@ -0,0 +1,28 @@
|
||||||
|
name: javascript-packages
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
paths:
|
||||||
|
- openapi.yaml
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
run:
|
||||||
|
name: Generate API Documentation
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout repo
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Run redoc on openapi.yaml
|
||||||
|
run: |
|
||||||
|
npx redoc-cli bundle openapi.yaml -o doc/api/index.html --options '{"hideHostname": true, "pathInMiddlePanel": true}
|
||||||
|
npm run build
|
||||||
|
|
||||||
|
- name: Commit changes
|
||||||
|
uses: EndBug/add-and-commit@v5
|
||||||
|
with:
|
||||||
|
author_name: Owncast
|
||||||
|
author_email: owncast@owncast.online
|
||||||
|
message: "Commit updated API documentation"
|
||||||
|
add: "doc/api/index.html"
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
Loading…
Reference in a new issue