Feat gimie driven properties #1
Workflow file for this run
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: Docs | |
| on: | |
| push: | |
| branches: ["main", "develop"] | |
| paths: | |
| - "docs/**" | |
| - "mkdocs.yml" | |
| - "pyproject.toml" | |
| - ".github/workflows/docs.yaml" | |
| pull_request: | |
| branches: ["main", "develop"] | |
| paths: | |
| - "docs/**" | |
| - "mkdocs.yml" | |
| - "pyproject.toml" | |
| - ".github/workflows/docs.yaml" | |
| workflow_dispatch: | |
| # Required by actions/deploy-pages. | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Avoid stomping on each other if pushes land back-to-back. | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| name: Build MkDocs site | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 # mkdocs-material uses git for "last updated" metadata | |
| - name: Set up uv | |
| uses: astral-sh/setup-uv@v4 | |
| with: | |
| python-version: "3.12" | |
| - name: Install docs dependencies | |
| run: uv sync --extra docs | |
| - name: Build site (strict) | |
| # --strict turns warnings (broken links, missing nav targets, …) into | |
| # errors so we fail fast in CI rather than ship a broken site. | |
| run: uv run mkdocs build --strict --site-dir site | |
| - name: Upload Pages artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: site | |
| deploy: | |
| name: Deploy to GitHub Pages | |
| # Only deploy on pushes to the default branch — PR builds validate but | |
| # do not publish. workflow_dispatch on main also publishes. | |
| if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main' | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |