Merge branch 'develop' #4
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 mkdocforge site | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - 'docs/**' | |
| - 'mkdocs.yml' | |
| - '.github/workflows/site.yml' | |
| - '.mdformat.toml' | |
| - 'pyproject.toml' | |
| - 'Makefile' | |
| pull_request: | |
| branches: | |
| - main | |
| paths: | |
| - 'docs/**' | |
| - '.mdformat.toml' | |
| - 'mkdocs.yml' | |
| - 'pyproject.toml' | |
| - 'Makefile' | |
| workflow_dispatch: # Allow manual triggering | |
| jobs: | |
| lint-docs: | |
| name: Lint Documentation | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' | |
| cache: 'pip' | |
| - name: Setup UV | |
| uses: astral-sh/setup-uv@v5 | |
| with: | |
| version: "latest" | |
| enable-cache: true | |
| - name: Install linting dependencies | |
| run: | | |
| rm -f uv.lock | |
| make uv_sync_lint | |
| - name: Lint Markdown files | |
| run: uv run mdformat --check docs/ | |
| deploy-docs: | |
| name: Deploy Documentation | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| needs: lint-docs | |
| runs-on: ubuntu-24.04 | |
| permissions: | |
| pages: write | |
| id-token: write | |
| contents: write | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 # Fetch all history for proper versioning | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' | |
| cache: 'pip' | |
| - name: Setup UV | |
| uses: astral-sh/setup-uv@v5 | |
| with: | |
| version: latest | |
| enable-cache: true | |
| - name: Install dependencies | |
| run: | | |
| rm -f uv.lock | |
| make uv_sync_docs | |
| - name: Build documentation | |
| run: make uv_mkdocs_build | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: site | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |