Skip to content

Merge pull request #7 from rishichawda/update-docs #7

Merge pull request #7 from rishichawda/update-docs

Merge pull request #7 from rishichawda/update-docs #7

Workflow file for this run

name: Deploy Documentation
on:
push:
branches: [main]
paths:
- 'docs/**'
- 'lib/**'
- 'index.ts'
- 'styles.css'
- 'package.json'
- 'README.md'
- '.github/workflows/deploy-docs.yml'
# Allow manual trigger
workflow_dispatch:
# 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
concurrency:
group: pages
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '18'
cache: 'yarn'
cache-dependency-path: docs/yarn.lock
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Install Root Dependencies & Build Plugin
run: |
yarn install --frozen-lockfile
yarn build
- name: Install Docs Dependencies
run: |
cd docs
yarn install --frozen-lockfile
- name: Build Documentation Site
run: |
cd docs
yarn build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/build
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4