Skip to content

feat: Add preliminary code for generating OAS #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 7, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Docs

on:
push:
branches:
- master
workflow_dispatch:

jobs:
docs:
name: Publish docs / OS ${{ matrix.os }} / Node ${{ matrix.node }}
strategy:
matrix:
os:
- ubuntu-latest
node:
- '12'

runs-on: ${{ matrix.os }}

steps:
- uses: actions/checkout@v2

- uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node }}

- run: |
npm ci
npm run docs:export

- name: Generate Swagger UI
uses: Legion2/swagger-ui-action@v1
with:
output: docs
spec-file: openapi.json

- name: Publish
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs
force_orphan: true
commit_message: 'docs: update'
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -108,3 +108,6 @@ dist/

# Binaries
bin/

# postgres-meta
openapi.json
2 changes: 1 addition & 1 deletion docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
version: "3"
services:
db:
image: supabase/postgres:0.14.0
image: postgres:13
ports:
- "5432:5432"
volumes:
Expand Down
Loading