Skip to content

Commit

Permalink
clients/js: Add typedoc deployment
Browse files Browse the repository at this point in the history
  • Loading branch information
matevz committed Sep 15, 2023
1 parent 8cacb01 commit ac6ea8b
Show file tree
Hide file tree
Showing 4 changed files with 80 additions and 4 deletions.
71 changes: 71 additions & 0 deletions .github/workflows/ci-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: ci-docs

on:
pull_request:
paths:
- clients/js/**
branches:
- main

# Cancel in-progress jobs on same branch.
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
publish-docs:
name: publish-docs
runs-on: ubuntu-latest
defaults:
run:
working-directory: ./clients/js
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Install Node.js
uses: actions/setup-node@v3
with:
node-version: 18

- uses: pnpm/[email protected]
name: Install pnpm
id: pnpm-install
with:
version: 8
run_install: false

- name: Get pnpm store directory
id: pnpm-cache
shell: bash
run: |
echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
- uses: actions/cache@v3
name: Setup pnpm cache
with:
path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
restore-keys: |
${{ runner.os }}-pnpm-store-
- name: Install dependencies
run: pnpm --filter @oasisprotocol/sapphire-paratime install

- name: Build docs
run: |
pnpm typedoc
find docs
- name: Deploy to api-reference branch
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: clients/js/docs
publish_branch: api-reference
destination_dir: sapphire-paratime
commit_message: Deploy typescript API reference ${{ github.event.head_commit.message }}
force_orphan: true
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com

3 changes: 1 addition & 2 deletions clients/js/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@
"build:cjs": "tsc -p ./tsconfig.cjs.json && node scripts/rename-cjs",
"test": "jest",
"coverage": "jest --coverage",
"doc": "typedoc --excludeInternal --excludePrivate src/index.ts",
"prepublishOnly": "pnpm build"
},
"dependencies": {
Expand Down Expand Up @@ -70,7 +69,7 @@
"node-fetch": "^2.6.7",
"prettier": "^2.7.1",
"ts-jest": "^28.0.8",
"typedoc": "^0.23.15",
"typedoc": "^0.23.28",
"typescript": "^4.8.3"
}
}
6 changes: 6 additions & 0 deletions clients/js/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,11 @@
"sourceMap": true,
"strict": true,
"target": "es6"
},
"typedocOptions": {
"entryPoints": ["src/index.ts"],
"out": "docs",
"excludeInternal": true,
"excludePrivate": true
}
}
4 changes: 2 additions & 2 deletions pnpm-lock.yaml

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

0 comments on commit ac6ea8b

Please sign in to comment.