Skip to content

Fix required: true in build-swiftusd.inputs #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maddyadams merged 5 commits into from
Jan 26, 2026
+13 −8
Merged

Fix required: true in build-swiftusd.inputs #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
88f5a64
Change build-swiftusd.inputs.openusd-ref, build-targets to required: …
maddyadams Jan 26, 2026
a44b303
Add permissions: contents: write to check-pull-requests-for-documenta…
maddyadams Jan 26, 2026
ffdda4b
Add untar step to check-pull-requests-for-documentation-warnings
maddyadams Jan 26, 2026
7cf58a2
Fix workflow typo
maddyadams Jan 26, 2026
77185be
Relax required files for docc script detection of the SwiftUsd repo root
maddyadams Jan 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/build-swiftusd.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,13 @@ on:

openusd-ref:
description: 'OpenUSD ref'
required: true
required: false
type: string
default: 'v25.08'

build-targets:
description: 'Build target list, or ALL'
required: true
required: false
type: string
default: 'ALL'

Expand Down
15 changes: 11 additions & 4 deletions .github/workflows/check-pull-requests-for-documentation-warnings.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ permissions:
on: pull_request
jobs:
Build-SwiftUsd:
permissions:
contents: write
uses: ./.github/workflows/build-swiftusd.yml
with:
swiftusd-ref: ${{ github.ref }}
Expand All @@ -36,12 +38,17 @@ jobs:
- name: Download package artifact
uses: actions/download-artifact@v5
with:
path: .
name: SwiftUsd-package-${{ github.run_id }}
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 ./scripts/docc build-documentation
swift run --package-path ./scripts/docc check-documentation
swift run --package-path ./SwiftUsd/scripts/docc build-documentation
swift run --package-path ./SwiftUsd/scripts/docc check-documentation


2 changes: 0 additions & 2 deletions scripts/docc/Sources/SwiftUsdDoccUtil/FileSystemUtil.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,13 @@ final public class Driver: Sendable {

// Do a smoke test to make sure we have something that looks like the SwiftUsd repo
let repoContents = try! FileManager.default.contentsOfDirectory(atPath: result.path(percentEncoded: false))
assert(repoContents.contains("docs"), "Error! Could not find SwiftUsd repo URL")
assert(repoContents.contains("openusd-patch.patch"), "Error! Could not find SwiftUsd repo URL")
assert(repoContents.contains("Package.swift"), "Error! Could not find SwiftUsd repo URL")
assert(repoContents.contains("README.md"), "Error! Could not find SwiftUsd repo URL")
assert(repoContents.contains("scripts"), "Error! Could not find SwiftUsd repo URL")
assert(repoContents.contains("source"), "Error! Could not find SwiftUsd repo URL")
assert(repoContents.contains("swift-package"), "Error! Could not find SwiftUsd repo URL")
assert(repoContents.contains("SwiftUsd.docc"), "Error! Could not find SwiftUsd repo URL")
assert(repoContents.contains("SwiftUsd.doccarchive"), "Error! Could not find SwiftUsd repo URL")

return result
}
Expand Down