Skip to content

Commit

Permalink
ci: add GitHub action to generate and deploy docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisalley committed Dec 29, 2024
1 parent f0c787a commit b4107ff
Showing 1 changed file with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Simple workflow for deploying static content to GitHub Pages
name: Docs
on: [push]

jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
permissions:
contents: write
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- name: Checkout repo
uses: actions/checkout@v4

- name: Install pnpm package manager
uses: pnpm/action-setup@v4
with:
version: 9.10.0

- name: Use Node ${{ matrix.node }}
uses: actions/setup-node@v4
with:
cache: 'pnpm'

- name: Install Dependencies
run: pnpm install

- name: Install TypeDoc
run: pnpm -g install typedoc

- name: Generate docs
run: typedoc src/index.ts

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

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './docs'
# - name: Deploy to GitHub Pages
# id: deployment
# uses: actions/deploy-pages@v4

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

0 comments on commit b4107ff

Please sign in to comment.