mirror of
https://github.com/logos-storage/logos-storage-nim.git
synced 2026-06-13 14:09:47 +00:00
67 lines
1.5 KiB
YAML
67 lines
1.5 KiB
YAML
name: OpenAPI
|
|
|
|
on:
|
|
push:
|
|
tags:
|
|
- "v*.*.*"
|
|
paths:
|
|
- "openapi.yaml"
|
|
- ".github/workflows/docs.yml"
|
|
pull_request:
|
|
branches:
|
|
- "**"
|
|
paths:
|
|
- "openapi.yaml"
|
|
- ".github/workflows/docs.yml"
|
|
|
|
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
|
|
permissions:
|
|
contents: read
|
|
pages: write
|
|
id-token: write
|
|
|
|
jobs:
|
|
lint:
|
|
name: Lint
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v6
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- uses: actions/setup-node@v6
|
|
with:
|
|
node-version: 24
|
|
|
|
- name: Lint OpenAPI
|
|
run: npx @redocly/cli lint openapi.yaml
|
|
|
|
deploy:
|
|
name: Deploy
|
|
runs-on: ubuntu-latest
|
|
if: startsWith(github.ref, 'refs/tags/')
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v6
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- uses: actions/setup-node@v6
|
|
with:
|
|
node-version: 24
|
|
|
|
- name: Build OpenAPI
|
|
run: npx @redocly/cli build-docs openapi.yaml --output openapi/index.html --title "Logos Storage API"
|
|
|
|
- name: Build Postman Collection
|
|
run: npx -y openapi-to-postmanv2 -s openapi.yaml -o openapi/postman.json -p -O folderStrategy=Tags,includeAuthInfoInExample=false
|
|
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@v3
|
|
with:
|
|
path: openapi
|
|
|
|
- name: Deploy to GitHub Pages
|
|
uses: actions/deploy-pages@v5
|