Skip to content

Spec: add realistic schema-level examples for all major types #3

Spec: add realistic schema-level examples for all major types

Spec: add realistic schema-level examples for all major types #3

Workflow file for this run

name: Deploy docs
on:
push:
branches: [main]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
name: Build docs site
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Node
uses: actions/setup-node@v4
with:
node-version: "20"
- name: Build ReDoc HTML for OCAS
run: |
npm install -g @redocly/cli
mkdir -p _site/open-charity-api
redocly build-docs open-charity-api/spec/openapi.yaml \
--output _site/open-charity-api/index.html \
--title "OCAS — Open Charity API Standard"
- name: Copy landing page
run: cp docs-site/index.html _site/index.html
- name: Upload artefact
uses: actions/upload-pages-artifact@v3
with:
path: _site
deploy:
name: Deploy to GitHub Pages
runs-on: ubuntu-latest
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy
id: deployment
uses: actions/deploy-pages@v4