Skip to content

Commit

Permalink
ci: 🎡 publish type reference
Browse files Browse the repository at this point in the history
  • Loading branch information
streamich committed Nov 24, 2023
1 parent 560c0fc commit c3af4a5
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 1 deletion.
26 changes: 26 additions & 0 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Node.js CI

on:
push:
branches: [ master ]

jobs:
gh-pages:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [20.x]
steps:
- uses: actions/checkout@v4
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
cache: yarn
- run: yarn install --frozen-lockfile
- run: npx typedoc
- name: Publish to gh-pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./typedocs
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -119,3 +119,6 @@ dist
lib/
es6/
es2020/

/docs/
/typedocs/
8 changes: 7 additions & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,11 @@
"src/**/__mocks__/**/*.*",
"*.test.ts",
"*.spec.ts"
]
],
"typedocOptions": {
"entryPoints": [
"src/index.ts",
],
"out": "typedocs"
}
}

0 comments on commit c3af4a5

Please sign in to comment.