cabal/.github/workflows/users-guide.yml at master · haskell/cabal · 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
# Adapted from agda/agda/.github/workflows/user-manual.yml by Andreas, 2021-09-11

name: Assorted

# See: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#concurrency.
concurrency:
  group: ${{ github.ref }}-${{ github.workflow }}
  cancel-in-progress: true

on:
  push:
    branches:
    - master
    paths:
    - 'doc/Makefile'
    - 'doc/pyproject.toml'
    - 'doc/*.inc'
    - 'doc/*.py'
    - 'doc/*.rst'
    - 'doc/**/*.json'
    - '.github/workflows/users-guide.yml'
  pull_request:
    paths:
    - 'doc/Makefile'
    - 'doc/pyproject.toml'
    - 'doc/*.inc'
    - 'doc/*.py'
    - 'doc/*.rst'
    - 'doc/**/*.json'
    - '.github/workflows/users-guide.yml'
  release:
    types:
      - created

defaults:
  run:
    shell: bash

jobs:
  build:
    name: Users guide
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ['3.13']

    steps:
    - uses: actions/checkout@v6
      with:
        submodules: recursive

    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v6
      with:
        python-version: ${{ matrix.python-version }}

    - name: Install the latest version of uv
      uses: astral-sh/setup-uv@v7

    - name: Build User's Guide in HTML
      run: |
        make SPHINX_HTML_OUTDIR=html users-guide

    - uses: actions/upload-artifact@v6
      with:
        name: users-guide-html
        path: html/

    - name: Check security of requirements (dependencies)
      env:
        SKJOLD_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      run: |
        make -C doc check-requirements