Skip to content

Commit d3fd9b9

Browse files
authored
Fix required: true in build-swiftusd.inputs (#17)
* Change build-swiftusd.inputs.openusd-ref, build-targets to required: false since they have defaults * Add permissions: contents: write to check-pull-requests-for-documentation-warning's use of build-swiftusd * Add untar step to check-pull-requests-for-documentation-warnings * Relax required files for docc script detection of the SwiftUsd repo root
1 parent aa904b9 commit d3fd9b9

3 files changed

Lines changed: 13 additions & 8 deletions

File tree

.github/workflows/build-swiftusd.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,13 @@ on:
3333

3434
openusd-ref:
3535
description: 'OpenUSD ref'
36-
required: true
36+
required: false
3737
type: string
3838
default: 'v25.08'
3939

4040
build-targets:
4141
description: 'Build target list, or ALL'
42-
required: true
42+
required: false
4343
type: string
4444
default: 'ALL'
4545

.github/workflows/check-pull-requests-for-documentation-warnings.yml

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ permissions:
2525
on: pull_request
2626
jobs:
2727
Build-SwiftUsd:
28+
permissions:
29+
contents: write
2830
uses: ./.github/workflows/build-swiftusd.yml
2931
with:
3032
swiftusd-ref: ${{ github.ref }}
@@ -36,12 +38,17 @@ jobs:
3638
- name: Download package artifact
3739
uses: actions/download-artifact@v5
3840
with:
39-
path: .
40-
name: SwiftUsd-package-${{ github.run_id }}
41+
path: SwiftUsd.tar.gz
42+
name: SwiftUsd-package-${{ github.run_id }}.tar.gz
43+
44+
- name: Untar package artifact
45+
run: |
46+
mkdir ./SwiftUsd
47+
tar -xzf ./SwiftUsd.tar.gz/SwiftUsd.tar.gz -C ./SwiftUsd
4148
4249
- name: Check for documentation warnings
4350
run: |
44-
swift run --package-path ./scripts/docc build-documentation
45-
swift run --package-path ./scripts/docc check-documentation
51+
swift run --package-path ./SwiftUsd/scripts/docc build-documentation
52+
swift run --package-path ./SwiftUsd/scripts/docc check-documentation
4653
4754

scripts/docc/Sources/SwiftUsdDoccUtil/FileSystemUtil.swift

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,13 @@ final public class Driver: Sendable {
3737

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

5048
return result
5149
}

0 commit comments

Comments
 (0)