ANS-52 Refactor README to Prioritize Developer SDKs #24
This file contains hidden or 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 MkDocs Site to GitHub Pages | |
on: | |
push: | |
branches: | |
- main | |
# Allow manual triggering | |
workflow_dispatch: | |
# Required permissions for GitHub Pages deployment | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
# Ensure only one deployment runs at a time | |
concurrency: | |
group: "pages" | |
cancel-in-progress: false | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.x' | |
- name: Install dependencies | |
run: | | |
pip install mkdocs mkdocs-material pymdown-extensions mkdocs-mermaid2-plugin | |
# If you add other plugins later and list them in a requirements.txt: | |
# pip install -r requirements-docs.txt | |
- name: Build documentation | |
run: mkdocs build --strict | |
- name: Setup Pages | |
uses: actions/configure-pages@v4 | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: './site' | |
deploy: | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
needs: build | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |