Skip to content

docs: Add swagger docs #218

docs: Add swagger docs

docs: Add swagger docs #218

Workflow file for this run

name: docs
on:
push:
branches: [dev]
paths: ['docs/**']
pull_request:
branches: [dev]
paths: ['docs/**']
# trigger deployment manually
workflow_dispatch:
defaults:
run:
shell: bash
working-directory: docs
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
# fetch all commits to get last updated time or other git log info
fetch-depth: 0
- name: Setup Node.js
uses: actions/setup-node@v1
with:
# choose node.js version to use
node-version: '16'
# install dependencies if the cache did not hit
- name: Install dependencies
run: npm ci
# run build script
- name: Build Site
run: npm run build
# please check out the docs of the workflow for more details
# @see https://github.com/crazy-max/ghaction-github-pages
- name: Deploy to GitHub Pages
uses: crazy-max/ghaction-github-pages@v2
if: github.event_name != 'pull_request'
with:
# deploy to gh-pages branch
target_branch: gh-pages
build_dir: docs/.vitepress/dist/Coalesce
jekyll: false
env:
# @see https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}