Skip to content

Publish API reference #6

Publish API reference

Publish API reference #6

Workflow file for this run

name: Publish API reference
on:
release:
types: [published]
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build-and-publish:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
name: Build and publish to npmjs.com
runs-on: ubuntu-latest
steps:
- name: Setup Node.js 20
uses: actions/setup-node@v3
with:
node-version: 20
- name: Checkout source code
uses: actions/checkout@v3
- uses: pnpm/action-setup@v3
with:
version: 8.10.0
run_install: false
- name: Get pnpm store directory
shell: bash
run: |
echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
- uses: actions/cache@v3
name: Setup pnpm cache
with:
path: ${{ env.STORE_PATH }}
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
restore-keys: |
${{ runner.os }}-pnpm-store-
- name: Install dependencies
run: pnpm install --frozen-lockfile false
- name: Generate API reference
run: pnpm generate-reference
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: "temp-docs"
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4