SQLModel->SQLAlchemy, part 4 (vendoring) #9359
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", 'ihb-develop'] | |
| pull_request: | |
| branches: ["main", 'ihb-develop'] | |
| env: | |
| JWT_SECRET_KEY: "very_secret_key-very_secret_key-very_secret_key" | |
| POSTGRES_DB: fake | |
| OAUTH_CLIENT_NAME: oauth2-example | |
| OAUTH_CLIENT_ID: oidc_example_client_id | |
| OAUTH_CLIENT_SECRET: oicd_example_client_secret | |
| OAUTH_OIDC_CONFIG_ENDPOINT: https://accounts.google.com/.well-known/openid-configuration | |
| permissions: {} | |
| jobs: | |
| build: | |
| name: "Build documentation" | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | |
| with: | |
| persist-credentials: false | |
| - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1 | |
| with: | |
| version: "0.11.26" | |
| enable-cache: false | |
| python-version: "3.12" | |
| - run: uv sync --frozen --group docs | |
| - run: uv run --frozen fractalctl openapi -f docs/openapi.json | |
| - run: uv run --frozen python docs/scripts/generate_swagger_ui.py | |
| env: | |
| OPENAPI_URL: "https://fractal-analytics-platform.github.io/fractal-server/openapi.json" | |
| - run: uv run --frozen python docs/scripts/generate_cli_ref.py | |
| - run: uv run --frozen python docs/scripts/generate_code_ref.py | |
| - run: uv run --frozen zensical build --clean --strict | |
| - uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0 | |
| with: | |
| path: "site" | |
| deploy: | |
| name: "Deploy docs" | |
| runs-on: ubuntu-24.04 | |
| if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} | |
| needs: build | |
| permissions: | |
| # https://github.com/actions/deploy-pages?tab=readme-ov-file | |
| # https://docs.github.com/en/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-cloud-providers#adding-permissions-settings | |
| pages: write # To create pages deployments when calling the GitHub API | |
| id-token: write # To request the OIDC JWT token | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0 | |
| id: deployment |