Skip to content

Commit c4658fa

Browse files
committed
Added explanation comments on why checks are skipped.
1 parent 0af8920 commit c4658fa

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

restfiles/doc-test.restfile

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ requests:
9191
X-SPI-Smoke-Test: ${smoke_test_token}
9292
validation:
9393
status: .regex((2|3)\d\d)
94+
# Doc build is failing with a genuine error
9495
# /GetStream/stream-chat-swiftui/documentation:
9596
# url: ${base_url}/GetStream/stream-chat-swiftui/documentation
9697
# headers:
@@ -103,6 +104,7 @@ requests:
103104
X-SPI-Smoke-Test: ${smoke_test_token}
104105
validation:
105106
status: .regex((2|3)\d\d)
107+
# Build failures across the board
106108
# /GetStream/stream-video-swift/documentation:
107109
# url: ${base_url}/GetStream/stream-video-swift/documentation
108110
# headers:
@@ -427,6 +429,7 @@ requests:
427429
X-SPI-Smoke-Test: ${smoke_test_token}
428430
validation:
429431
status: .regex((2|3)\d\d)
432+
# All builds fail
430433
# /apple/swift-playdate-examples/documentation:
431434
# url: ${base_url}/apple/swift-playdate-examples/documentation
432435
# headers:
@@ -625,12 +628,14 @@ requests:
625628
X-SPI-Smoke-Test: ${smoke_test_token}
626629
validation:
627630
status: .regex((2|3)\d\d)
628-
/kingslay/KSPlayer/documentation:
629-
url: ${base_url}/kingslay/KSPlayer/documentation
630-
headers:
631-
X-SPI-Smoke-Test: ${smoke_test_token}
632-
validation:
633-
status: .regex((2|3)\d\d)
631+
# 'KSPlayer' does not contain any documentable symbols or a DocC catalog and will not produce documentation
632+
# Needs further investigation
633+
# /kingslay/KSPlayer/documentation:
634+
# url: ${base_url}/kingslay/KSPlayer/documentation
635+
# headers:
636+
# X-SPI-Smoke-Test: ${smoke_test_token}
637+
# validation:
638+
# status: .regex((2|3)\d\d)
634639
/krzyzanowskim/CryptoSwift/documentation:
635640
url: ${base_url}/krzyzanowskim/CryptoSwift/documentation
636641
headers:

0 commit comments

Comments
 (0)