Skip to content

Commit

Permalink
ci: add github action documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
arnaud-roland committed Jan 13, 2025
1 parent 39a66aa commit 4c501bc
Show file tree
Hide file tree
Showing 5 changed files with 1,526 additions and 177 deletions.
37 changes: 37 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Documentation

on:
push:
branches: ["master"]

workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: true

jobs:
build:

runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/configure-pages@v4
- uses: actions/setup-node@v4
with:
node-version: 18
- run: npm ci
- run: npm run build --if-present
- run: npx typedoc --entryPointStrategy Expand src
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './docs'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -113,4 +113,5 @@ DerivedData

#JSDoc
jsdoc/
docs/
.idea/
Loading

0 comments on commit 4c501bc

Please sign in to comment.