docs: adds custom serialization guide #43
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: Deploy Docusaurus site to Pages | |
on: | |
# Runs on pushes targeting the default branch | |
push: | |
branches: ["main", "pages/**"] | |
paths: | |
- "documentation/**" | |
# Allows you to run this workflow manually from the Actions tab | |
workflow_dispatch: | |
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
# Allow one concurrent deployment | |
concurrency: | |
group: "pages" | |
cancel-in-progress: true | |
jobs: | |
# Build job | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- name: Setup Node | |
uses: actions/setup-node@v4 | |
with: | |
node-version: "20" | |
- name: Install dependencies | |
run: npm ci | |
working-directory: ./documentation | |
- name: Build Docusaurus site | |
run: npm run build | |
working-directory: ./documentation | |
- name: Upload artifact for deployment | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: ./documentation/build | |
# Deployment job | |
deploy: | |
needs: build | |
runs-on: ubuntu-latest | |
environment: | |
name: github-pages | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 | |
- name: Print page URL | |
run: echo "Deployed to ${PAGES_URL}" | |
env: | |
PAGES_URL: ${{ steps.deployment.outputs.page_url }} |