Skip to content

Commit

Permalink
Added Github workflow for publishing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Caesarovich committed Oct 4, 2023
1 parent 958ac5f commit df17047
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
30 changes: 30 additions & 0 deletions .github/workflows/pages-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Publish Docs

on:
workflow_dispatch:
push:
branches:
- main

jobs:
publish-docs:
runs-on: ubuntu-latest
permissions:
contents: write
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 20
cache: 'npm'
- name: Install dependencies
run: npm ci
- name: Build documentation
run: npm run docs:build
- name: Deploy on Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"prepack": "npm run build",
"rebuild": "npm run clean && npm run build",
"clean": "rm -rf dist",
"doc": "typedoc src/index.ts"
"docs:build": "typedoc src/index.ts"
},
"repository": {
"type": "git",
Expand Down

0 comments on commit df17047

Please sign in to comment.