Skip to content

Merge pull request #176 from Caneryy/patch-1 #1

Merge pull request #176 from Caneryy/patch-1

Merge pull request #176 from Caneryy/patch-1 #1

Workflow file for this run

name: Build and Checks
on:
push:
branches: [main]
pull_request:
branches: [main]
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
steps:
# Checkout the code
- uses: actions/checkout@v2
# Setup node with version and cache dependencies
- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: '18.12.0'
cache: 'yarn'
# Cache Docusaurus build artifacts for faster build times
- name: Cache Docusaurus artifacts
uses: actions/cache@v3
with:
key: ${{ runner.os }}-docusaurus-${{ hashFiles('**/yarn.lock') }}
path: |
.docusaurus
build
# Cache node_modules for faster build times
- name: Cache node_modules
uses: actions/cache@v3
with:
key: ${{ runner.os }}-node-modules-${{ hashFiles('**/yarn.lock') }}
path: node_modules
# Install project dependencies
- run: yarn install --frozen-lockfile
# Build the Docusaurus project
- run: yarn build
lintChecks:
needs: build
runs-on: ubuntu-latest
steps:
# Checkout the code
- uses: actions/checkout@v2
# Check links in markdown files
- name: Link Checker
uses: lycheeverse/lychee-action@v1
with:
args: --verbose --no-progress './docs/'
fail: true
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
# Check spelling in markdown files using cspell
- name: Spell Checker using cspell
uses: streetsidesoftware/cspell-action@v1
with:
config: './cspell.json'