3.0.0-rc1 #25
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: GitHub Pages documentation setup | |
on: | |
push: | |
tags: | |
- v* | |
workflow_dispatch: | |
jobs: | |
docs: | |
name: Setup documentation | |
runs-on: ubuntu-latest | |
steps: | |
# Checkout | |
- uses: actions/checkout@v4 | |
with: | |
path: ./project/ | |
- uses: actions/checkout@v4 | |
with: | |
ref: docs | |
path: ./docs/ | |
# Cleanup (docs) | |
- name: Clean documentation directory | |
working-directory: ./docs/ | |
run: | | |
git rm --ignore-unmatch -rf . | |
git clean -fxd | |
# Generation (project) | |
- name: Install dependencies | |
working-directory: ./project/ | |
run: npm ci | |
- name: Run TypeDoc | |
working-directory: ./project/ | |
run: | | |
npx --yes typedoc \ | |
--out ../docs \ | |
--cleanOutputDir false \ | |
--tsconfig ./tsconfig.types.json \ | |
src/index.ts | |
# Commit | |
- name: Commit new documentation | |
uses: EndBug/add-and-commit@v9 | |
with: | |
cwd: ./docs/ | |
default_author: github_actions | |
add: "." | |
message: Updating documentation [${{ github.sha }}] | |
push: true | |