data-validation-engine/.github/workflows/ci_docs_build.yml at main · NHSDigital/data-validation-engine · 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
name: Verify docs build correctly

on:
  pull_request:
    branches:
      - main
    types: [opened, reopened, synchronize]

jobs:
  build:
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@v5

      - name: Install extra dependencies for a python install
        run: |
          sudo apt-get update
          sudo apt -y install --no-install-recommends liblzma-dev libbz2-dev libreadline-dev

      - name: Install asdf cli
        uses: asdf-vm/actions/setup@b7bcd026f18772e44fe1026d729e1611cc435d47

      - name: Install software through asdf
        uses: asdf-vm/actions/install@b7bcd026f18772e44fe1026d729e1611cc435d47

      - name: reshim asdf
        run: asdf reshim

      - name: ensure poetry using desired python version
        run: poetry env use $(asdf which python)

      - name: install docs requirements
        run: |
          poetry install --sync --no-interaction --with docs

      - name: verify docs build correctly
        run: poetry run zensical build --strict