Skip to content

Add ci-at-desk, a script for locally running CI workflows #31

Add ci-at-desk, a script for locally running CI workflows

Add ci-at-desk, a script for locally running CI workflows #31

#===----------------------------------------------------------------------===#
# This source file is part of github.com/apple/SwiftUsd
#
# Copyright © 2025 Apple Inc. and the SwiftUsd project authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
#===----------------------------------------------------------------------===#
name: Check Pull Requests for Documentation Warnings
permissions:
contents: read
on: pull_request
jobs:
Build-SwiftUsd:
permissions:
contents: write
uses: ./.github/workflows/build-swiftusd.yml
with:
swiftusd-ref: ${{ github.ref }}
Check-Documentation-Warnings:
runs-on: [self-hosted, macos]
needs: [Build-SwiftUsd]
steps:
- name: Download package artifact
uses: actions/download-artifact@v5
with:
path: SwiftUsd.tar.gz
name: SwiftUsd-package-${{ github.run_id }}.tar.gz
- name: Untar package artifact
run: |
mkdir ./SwiftUsd
tar -xzf ./SwiftUsd.tar.gz/SwiftUsd.tar.gz -C ./SwiftUsd
- name: Check for documentation warnings
run: |
swift run --package-path ./SwiftUsd/scripts/docc build-documentation
swift run --package-path ./SwiftUsd/scripts/docc check-documentation