Skip to content

Merge pull request #23 from AliMark71/patch-1 #5

Merge pull request #23 from AliMark71/patch-1

Merge pull request #23 from AliMark71/patch-1 #5

Workflow file for this run

# 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: tayloraswift/swift-install-action@master
with:
swift-prefix: "swift-6.0.2-release/ubuntu2404/swift-6.0.2-RELEASE"
swift-id: "swift-6.0.2-RELEASE-ubuntu24.04"
- name: Install Unidoc
uses: tayloraswift/swift-unidoc-action@master
# This clobbers everything in the current directory!
- name: Checkout repository
uses: actions/checkout@v3
- name: Validate documentation
run: |
unidoc compile \
--swift-toolchain $SWIFT_INSTALLATION \
--ci fail-on-errors \
--project-path .
macos:
runs-on: macos-15
name: macOS
steps:
- name: Install Unidoc
uses: tayloraswift/swift-unidoc-action@master
- name: Checkout repository
uses: actions/checkout@v3
- name: Validate documentation
run: |
unidoc compile \
--ci fail-on-errors \
--project-path .