11# This workflow builds the project under the “starter” configuration, namely, what you would get
22# if you ran `swift build` without any arguments. We use this to verify that we can generate the
33# documentation for Unidoc itself.
4-
5- name : build
4+ name : documentation
65
76on :
87 push :
@@ -17,11 +16,14 @@ jobs:
1716 env :
1817 UNIDOC_ENABLE_INDEXSTORE : " 0"
1918 steps :
19+ # Important! We install an Ubuntu 22.04 Swift toolchain, and not the 24.04 one
20+ # because the 24.04 toolchain for some reason is built with assertions enabled,
21+ # which causes the Swift compiler to crash when building the package.
2022 - name : Install Swift
2123 uses : tayloraswift/swift-install-action@master
2224 with :
23- swift-prefix : " swift-5.10.1-release/ubuntu2404 /swift-5.10.1-RELEASE"
24- swift-id : " swift-5.10.1-RELEASE-ubuntu24 .04"
25+ swift-prefix : " swift-5.10.1-release/ubuntu2204 /swift-5.10.1-RELEASE"
26+ swift-id : " swift-5.10.1-RELEASE-ubuntu22 .04"
2527
2628 # This installs an older version of Unidoc, not the one we are testing.
2729 - name : Install Unidoc
3234 - name : Checkout repository
3335 uses : actions/checkout@v3
3436
35- - name : Build debug
36- run : |
37- swift --version
38- swift build
39-
4037 - name : Build documentation
4138 run : |
4239 unidoc compile -I .. \
@@ -52,11 +49,16 @@ jobs:
5249 DEVELOPER_DIR : " /Applications/Xcode_15.3.app/Contents/Developer"
5350
5451 steps :
52+ - name : Install Unidoc
53+ uses : tayloraswift/swift-unidoc-action@master
54+ with :
55+ unidoc-version : " master"
56+
5557 - name : Checkout repository
5658 uses : actions/checkout@v3
5759
58- - name : Build debug
60+ - name : Build documentation
5961 run : |
60- swift --version
61- swift build
62-
62+ unidoc compile -I .. \
63+ --ci fail-on-errors \
64+ --package-name swift-unidoc
0 commit comments