flixopt/.github/workflows/docs.yaml at 78969bddf2619670fd5606bfbfa93789895d8c01 · flixOpt/flixopt · 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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
name: Docs

on:
  push:
    branches: [main]
    paths:
      - 'docs/**'
      - 'mkdocs.yml'
      - 'flixopt/**'
  pull_request:
    paths:
      - 'docs/**'
      - 'mkdocs.yml'
  workflow_dispatch:
  workflow_call:
    inputs:
      deploy:
        type: boolean
        default: false
      version:
        type: string
        required: false

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

env:
  PYTHON_VERSION: "3.11"
  MPLBACKEND: Agg
  PLOTLY_RENDERER: json

jobs:
  build:
    name: Build documentation
    runs-on: ubuntu-24.04
    timeout-minutes: 30
    steps:
      - uses: actions/checkout@v5
        with:
          fetch-depth: 0

      - uses: astral-sh/setup-uv@v7
        with:
          version: "0.9.10"
          enable-cache: true

      - uses: actions/setup-python@v6
        with:
          python-version: ${{ env.PYTHON_VERSION }}

      - name: Extract changelog
        run: |
          cp CHANGELOG.md docs/changelog.md
          python scripts/format_changelog.py

      - name: Install dependencies
        run: uv pip install --system ".[docs,full]"

      - name: Build docs
        run: mkdocs build --strict

      - uses: actions/upload-artifact@v4
        with:
          name: docs
          path: site/
          retention-days: 7

  deploy:
    name: Deploy documentation
    needs: build
    if: ${{ inputs.deploy == true && inputs.version != '' }}
    runs-on: ubuntu-24.04
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v5
        with:
          fetch-depth: 0

      - uses: astral-sh/setup-uv@v7
        with:
          version: "0.9.10"
          enable-cache: true

      - uses: actions/setup-python@v6
        with:
          python-version: ${{ env.PYTHON_VERSION }}

      - name: Install mike
        run: uv pip install --system mike

      - uses: actions/download-artifact@v4
        with:
          name: docs
          path: site/

      - name: Configure Git
        run: |
          git config user.name "github-actions[bot]"
          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"

      - name: Deploy docs
        run: |
          VERSION=${{ inputs.version }}
          VERSION=${VERSION#v}
          mike deploy --push --update-aliases --no-build $VERSION latest
          mike set-default --push latest