Skip to content

Commit

Permalink
Deploy documentation site to gh pages
Browse files Browse the repository at this point in the history
  • Loading branch information
joshklop committed Aug 16, 2023
1 parent dad5561 commit 23469f2
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 0 deletions.
43 changes: 43 additions & 0 deletions .github/workflows/docs-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Deploy Documentation to GitHub Pages

on:
push:
branches:
main
workflow_dispatch:

permissions:
contents: write

jobs:
deploy:
name: Deploy to GitHub Pages
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version-file: .nvmrc
cache: npm
cache-dependency-path: docs

- name: Install dependencies
run: npm ci
working-directory: docs
- name: Build website
run: npm run build
working-directory: docs

- 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: ./docs/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
25 changes: 25 additions & 0 deletions .github/workflows/docs-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Test Documentation Build

on:
pull_request:
branches:
- main

jobs:
test-deploy:
name: Test deployment
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version-file: docs/.nvmrc
cache: npm
cache-dependency-path: docs

- name: Install dependencies
run: npm ci
working-directory: docs
- name: Build website
run: npm run build
working-directory: docs

0 comments on commit 23469f2

Please sign in to comment.