Release 6.0.2. #4
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: API docs | |
on: | |
push: | |
tags: ['[0-9]+.[0-9]+*'] | |
permissions: | |
contents: write | |
jobs: | |
api-docs: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
with: | |
path: code | |
persist-credentials: false | |
- name: Setup Node.js | |
uses: actions/setup-node@v4 | |
with: | |
node-version: '20.x' | |
cache: 'npm' | |
cache-dependency-path: code/package-lock.json | |
- name: Build API docs | |
run: npm ci && npm run build && npm run typedoc | |
working-directory: code | |
- name: Checkout pages | |
uses: actions/checkout@v4 | |
with: | |
ref: gh-pages | |
path: pages | |
- name: Deploy pages | |
run: | | |
SDK_VERSION_FOLDER=`echo "$SDK_VERSION" | awk --field-separator '.' '{print $1".x";}'` | |
# Create .nojekyll if it doesn't exist yet | |
touch .nojekyll | |
mkdir -p "$SDK_VERSION_FOLDER" | |
rsync --quiet --archive --checksum --delete --exclude .git ../code/docs/ "$SDK_VERSION_FOLDER/" | |
# Remove .nojekyll generated by TypeDoc | |
if [ -f "$SDK_VERSION_FOLDER/.nojekyll" ]; then rm "$SDK_VERSION_FOLDER/.nojekyll"; fi | |
if [ -e latest ]; then rm -r latest; fi | |
ln -s "$SDK_VERSION_FOLDER" latest | |
git config user.email "$USER_EMAIL" | |
git config user.name "$USER_NAME" | |
git add --all . | |
# Only commit when there are changes | |
git diff --quiet && git diff --staged --quiet || git commit --message "Generated API docs for version ${SDK_VERSION}" | |
git push | |
shell: bash | |
working-directory: pages | |
env: | |
SDK_VERSION: ${{ github.ref_name }} | |
USER_EMAIL: ${{ github.event.pusher.email }} | |
USER_NAME: ${{ github.event.pusher.name }} |