Scheduler/.github/workflows/docs.yml at main · mucsci/Scheduler · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# Publish Fern docs to https://mucsci-scheduler.docs.buildwithfern.com
# Requires repository secret FERN_TOKEN (see Fern Dashboard / `fern token`).

name: documentation

on:
  push:
    branches:
      - main
    paths:
      - "fern/**"
      - "scripts/**"
      - "src/scheduler/**"
      - ".github/workflows/docs.yml"
  workflow_dispatch:

permissions:
  contents: read

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v6
        with:
          persist-credentials: false

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: "3.12"

      - name: Install uv
        uses: astral-sh/setup-uv@v7

      - name: Set up Node
        uses: actions/setup-node@v6
        with:
          node-version: "20"

      - name: Install the project
        run: uv sync --locked --group dev

      - name: Generate OpenAPI, JSON Schema, and Python API reference
        run: |
          uv run python scripts/export_openapi.py
          uv run python scripts/export_config_schema.py
          uv run python scripts/gen_python_api_mdx.py

      - name: Install Fern CLI
        run: npm install -g fern-api@4.35.0

      - name: Fern check
        run: fern check

      - name: Publish docs to Fern
        env:
          FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
        run: fern generate --docs