Skip to content

Commit

Permalink
merge baseatlasclass refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
bmschmidt committed Jun 2, 2024
1 parent 9d7b3e3 commit ed03b77
Show file tree
Hide file tree
Showing 11 changed files with 7,689 additions and 38 deletions.
43 changes: 43 additions & 0 deletions .github/workflows/publish-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Publish TSDoc to GitHub Pages

permissions:
contents: write
actions: read
checks: write
deployments: write
issues: write
metadata: read
packages: read
pull-requests: write
statuses: write

on:
push:
branches:
- main
- docs

jobs:
build-and-deploy:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v2

- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: '20'

- name: Install dependencies
run: npm install

- name: Generate documentation
run: npx typedoc

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ src/openapi.d.ts
etc/openapi.json
private
dist
docs
104 changes: 102 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
"ts-node": "^10.9.1",
"ts-node-dev": "^2.0.0",
"tsconfig-paths": "^4.2.0",
"typedoc": "^0.25.13",
"typescript": "^4.9.5",
"uvu": "^0.5.6"
},
Expand Down
Loading

0 comments on commit ed03b77

Please sign in to comment.