Skip to content

Commit

Permalink
Add docs deployment action
Browse files Browse the repository at this point in the history
  • Loading branch information
JakeWags committed Mar 12, 2024
1 parent 12be303 commit c354fe1
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/deploy_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Deploy Documentation

on:
push:
branches:
- main

jobs:
deploy:
runs-on: ubuntu-22.04
permissions:
contents: write
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- uses: actions/checkout@v3

- uses: actions/setup-node@v3
with:
node-version: lts/*
cache: "yarn"

- name: Install dependencies
run: yarn install --immutable

- name: Run yarn build
run: yarn build

- name: Run yarn doc
# build typedocs with yarn doc command
run: yarn doc

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs

0 comments on commit c354fe1

Please sign in to comment.