From c5270eb7cf6e529cea8f07fa94be2da876e4db3b Mon Sep 17 00:00:00 2001 From: Vivian Plasencia Date: Thu, 18 Apr 2024 13:18:25 +0200 Subject: [PATCH] ci: add github workflow to generate and deploy the type docs --- .github/workflows/docs.yml | 35 +++++++++++++++++++++++++++++++++++ package.json | 2 +- 2 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..6fb7c68 --- /dev/null +++ b/.github/workflows/docs.yml @@ -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/ghaction-github-pages@v2.5.0 + with: + build_dir: docs + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/package.json b/package.json index adacf7d..68a209c 100644 --- a/package.json +++ b/package.json @@ -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",