swift-json/.github/workflows/Documentation.yml at 3bba4c380c1371fd106bdc4d9e77fc6e8d8fdaa1 · rarestype/swift-json · 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
# This workflow validates the package’s documentation. Because documentation building involves
# compiling the package, this also checks that the package itself compiles successfully on each
# supported platform.
name: documentation

on:
    push:
        branches: [ master ]
    pull_request:
        branches: [ master ]

jobs:
    linux:
        runs-on: ubuntu-24.04
        name: Ubuntu 24.04

        steps:
            -   name: 🤍 Install Swift 🤍
                uses: rarestype/swift-install-action@master
                with:
                    swift-prefix: "swift-6.2.4-release/ubuntu2404/swift-6.2.4-RELEASE"
                    swift-id: "swift-6.2.4-RELEASE-ubuntu24.04"

            -   name: 🤍 Install Unidoc 🤍
                uses: rarestype/unidoc-action@master

            #   This clobbers everything in the current directory!
            -   name: 🤍 Checkout repository 🤍
                uses: actions/checkout@v6

            -   name: 🤍 Validate documentation 🤍
                run: |
                    unidoc compile \
                    --swift-toolchain $SWIFT_INSTALLATION \
                    --ci fail-on-errors \
                    --project-path .

    macos:
        runs-on: macos-26
        name: macOS
        steps:
            -   name: 🤍 Install Unidoc 🤍
                uses: rarestype/unidoc-action@master

            -   name: 🤍 Checkout repository 🤍
                uses: actions/checkout@v6

            -   name: 🤍 Select Xcode 26.3 🤍
                run: sudo xcode-select -s /Applications/Xcode_26.3.app/Contents/Developer

            -   name: 🤍 Validate documentation 🤍
                run: |
                    unidoc build \
                    --ci fail-on-errors \
                    --project-path .