Docs

Megacommit #130

	name: Docs

	on:
	push:
	branches: [main]

	# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
	permissions:
	contents: read
	pages: write
	id-token: write

	jobs:
	# Build job
	build:
	# <Not provided for brevity>
	# At a minimum this job should upload artifacts using actions/upload-pages-artifact
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4

	- name: Use Node.js
	uses: actions/setup-node@v4
	with:
	node-version: "20.x"
	cache: "npm"

	- name: Install dependencies
	run: npm ci

	- name: Generate documentation
	run: npm run docs

	- name: Setup Pages
	uses: actions/configure-pages@v5

	- name: Upload artifact
	uses: actions/upload-pages-artifact@v3
	with:
	path: "docs"

	# Deploy job
	deploy:
	# Add a dependency to the build job
	needs: build

	# 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

Provide feedback