Skip to content

Commit

Permalink
ci: add github workflow to generate and deploy the type docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vplasencia committed Apr 18, 2024
1 parent d1a87b3 commit c5270eb
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 1 deletion.
35 changes: 35 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: docs

on:
push:
branches:
- main

jobs:
gh-pages:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: yarn

- name: Install dependencies
run: yarn

- name: Build libraries
run: yarn build:libraries

- name: Generate doc website
run: yarn docs

- name: Publish on Github Pages
uses: crazy-max/[email protected]
with:
build_dir: docs
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"format": "yarn format:prettier",
"format:write": "yarn format:prettier:write",
"style": "yarn lint && yarn format",
"docs": "typedoc --cname extensionstypes.semaphore.pse.dev --githubPages true",
"docs": "typedoc --githubPages true",
"version:bump": "yarn workspace @semaphore-extensions/${0} version ${1} && yarn remove:stable-version-field ${0} && NO_HOOK=1 git commit -am \"chore(${0}): v${1}\" && git tag ${0}-v${1}",
"version:publish": "yarn workspaces foreach -A --no-private npm publish --tolerate-republish --access public",
"version:release": "changelogithub",
Expand Down

0 comments on commit c5270eb

Please sign in to comment.