mirror of
https://github.com/orbitdb/orbitdb.git
synced 2025-03-30 15:08:28 +00:00
41 lines
828 B
YAML
41 lines
828 B
YAML
---
|
|
name: Generate API Docs
|
|
|
|
on:
|
|
push:
|
|
tags:
|
|
- 'v*'
|
|
|
|
# Allows you to run this workflow manually from the Actions tab
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
pages: write
|
|
id-token: write
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- uses: actions/setup-node@v3
|
|
with:
|
|
node-version: 'lts/*'
|
|
registry-url: https://registry.npmjs.org/
|
|
- run: npm ci
|
|
- run: npm run api:docs
|
|
- uses: actions/upload-pages-artifact@v2
|
|
with:
|
|
path: ./docs/api/
|
|
|
|
deploy:
|
|
needs: build
|
|
|
|
# Specify runner + deployment step
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v2 # or the latest "vX.X.X" version tag for this action
|
|
|