Merge pull request #97 from orbitdb/build/api-publish

chore: Add api publish to github pages.
This commit is contained in:
Hayden Young 2023-08-24 20:11:12 +08:00 committed by GitHub
commit ca291c78a4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

41
.github/workflows/api-publish.yml vendored Normal file
View File

@ -0,0 +1,41 @@
---
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