Skip to content
📝 Validate Docs

docs: checkout docs for 1.12.0 #336

Sign in to view logs

docs: checkout docs for 1.12.0

docs: checkout docs for 1.12.0 #336

Workflow file for this run

.github/workflows/verify-docs.yml at 8621870
name: 📝 Validate Docs
on:
pull_request:
branches:
- main
paths:
- ".github/workflows/verify-docs.yml"
- "docs/**"
types:
- opened
- reopened
- synchronize
- closed
jobs:
build:
runs-on: ubuntu-latest
name: 🏗️ Build docs
defaults:
run:
working-directory: ./docs
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 18.x
cache: yarn
- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Build website
run: yarn build
lint:
runs-on: ubuntu-latest
name: 🔎 Lint Markdown
defaults:
run:
working-directory: ./docs
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 18.x
cache: yarn
- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Run Lint
run: yarn markdownlint-cli2 "**/*.md" "#node_modules"
preview:
runs-on: ubuntu-latest
name: 🛫 Deploy preview
defaults:
run:
working-directory: docs
steps:
- uses: actions/checkout@v4
- run: echo "PREVIEW_PATH=pr-preview/pr-${{ github.event.number }}" >> "$GITHUB_ENV"
- uses: actions/setup-node@v4
with:
node-version: 18.x
cache: yarn
- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Build website
run: yarn build
- name: Deploy preview
uses: rossjrw/pr-preview-action@v1
with:
source-dir: ./docs/build/