Skip to content

Merge pull request #172 from Comet-Robotics/170-serverdocumentation-a… #48

Merge pull request #172 from Comet-Robotics/170-serverdocumentation-a…

Merge pull request #172 from Comet-Robotics/170-serverdocumentation-a… #48

Workflow file for this run

name: build-documentation
on:
push:
branches:
- main
jobs:
typedoc:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
cache: yarn
- name: Install modules
run: yarn --frozen-lockfile
- name: Run typedoc
run: yarn run docs:build
- uses: actions/upload-pages-artifact@v3
with:
path: site
# Deploy job
deploy:
# Add a dependency to the build job
needs: typedoc
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
# Specify runner + deployment step
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4