Merge pull request #1705 from fractal-analytics-platform/1693-bump-fa… #3010
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: docs | |
on: | |
push: | |
branches: ["main"] | |
pull_request: | |
branches: ["main"] | |
jobs: | |
docs: | |
name: "Deploy docs" | |
runs-on: ubuntu-22.04 | |
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: '3.10' | |
cache: pip | |
- name: Install current fractal-server | |
run: python -m pip install -e . | |
- name: extract openapi schema | |
env: | |
JWT_SECRET_KEY: 1234 | |
FRACTAL_TASKS_DIR: /tmp/fractal-server/tasks/ | |
FRACTAL_RUNNER_WORKING_BASE_DIR: /tmp/fractal-server/artifacts/ | |
OAUTH_OAUTH2EXAMPLE_CLIENT_ID: oidc_example_client_id | |
OAUTH_OAUTH2EXAMPLE_CLIENT_SECRET: oicd_example_client_secret | |
OAUTH_OAUTH2EXAMPLE_OIDC_CONFIGURATION_ENDPOINT: https://accounts.google.com/.well-known/openid-configuration | |
run: fractalctl openapi -f docs/openapi.json | |
- name: Deploy docs | |
uses: mhausenblas/mkdocs-deploy-gh-pages@master | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
REQUIREMENTS: docs/doc-requirements.txt | |
docs-build: | |
name: "Test docs build" | |
runs-on: ubuntu-22.04 | |
if: ${{ github.event_name != 'push' || github.ref != 'refs/heads/main' }} | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: '3.10' | |
cache: pip | |
- name: Install current fractal-server | |
run: python -m pip install -e . | |
- name: extract openapi schema | |
env: | |
JWT_SECRET_KEY: 1234 | |
FRACTAL_TASKS_DIR: /tmp/fractal-server/tasks/ | |
FRACTAL_RUNNER_WORKING_BASE_DIR: /tmp/fractal-server/artifacts/ | |
OAUTH_OAUTH2EXAMPLE_CLIENT_ID: oidc_example_client_id | |
OAUTH_OAUTH2EXAMPLE_CLIENT_SECRET: oicd_example_client_secret | |
OAUTH_OAUTH2EXAMPLE_OIDC_CONFIGURATION_ENDPOINT: https://accounts.google.com/.well-known/openid-configuration | |
run: fractalctl openapi -f docs/openapi.json | |
- name: Install dependencies | |
run: python -m pip install -r docs/doc-requirements.txt | |
- name: MKDocs build | |
run: mkdocs build --config-file mkdocs.yml |