Skip to content

Updated OpenAPI spec to v0.5.1 #15

Updated OpenAPI spec to v0.5.1

Updated OpenAPI spec to v0.5.1 #15

Workflow file for this run

# SPDX-FileCopyrightText: 2023 Sidings Media
# SPDX-License-Identifier: CC0-1.0
name: Docusaurus
on:
# Runs on pushes targeting the default branch
push:
branches:
- main
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
submodules: recursive
- name: Use Node.js
uses: actions/setup-node@v3
with:
node-version: '20.x'
- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Convert OpenAPI spec to single file
run: yarn build-api-docs
- name: Build API docs
run: yarn docusaurus gen-api-docs all
- name: Build static files
run: yarn build
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: ./build
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2