Skip to content

[Docs] Quick bug fix #184

[Docs] Quick bug fix

[Docs] Quick bug fix #184

name: Deploy Documentation
on:
push:
branches:
- develop
paths:
- "documentation/**"
workflow_dispatch:
jobs:
deploy:
name: Deploy to GitHub Pages
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- run: sudo apt update && sudo apt install libvips-dev -y
- uses: actions/setup-node@v3
with:
node-version: 18
cache: npm
cache-dependency-path: ./documentation/package-lock.json
- name: Install dependencies
run: npm ci
working-directory: ./documentation
- name: Build website
run: npm run build
working-directory: ./documentation
env:
POSTHOG_API_KEY: ${{ secrets.POSTHOG_API_KEY }}
- name: Add CNAME
run: echo "docs.typewritermc.com" > ./documentation/build/CNAME
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Build output to publish to the `gh-pages` branch:
publish_dir: ./documentation/build
# The following lines assign commit authorship to the official
# GH-Actions bot for deploys to `gh-pages` branch:
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
# The GH actions bot is used by default if you didn't specify the two fields.
# You can swap them out with your own user credentials.
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com