[5.7] Fix SwiftDocC integration test #102
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
ethan-kusters
commented
Apr 18, 2022
ethan-kusters
commented
- Rationale: Updates the Swift-DocC integration test to accurately check for regressions in DocC's ability convert documentation for a Swift package.
- Risk: Low.
- Risk Detail: Updates an existing test to more closely match the way we expect DocC to be used.
- Reward: Medium
- Reward Details: Lowers risk of regressing Swift-DocC throughout the 5.7 release.
- Original PR: Fix SwiftDocC integration test #101
- Issue: rdar://91638258
- Code Reviewed By: N/A
- Testing Details: Tests continue to pass.
The integration test as currently written fails to actually compile any documentation because the Symbol Graph files for the test Swift Package are never built. This updates the test to build Symbol Graph files for the test package, convert it, and assert that produced DocC documentation contains the expected `data` subdirectory. Resolves rdar://91638258.
shahmishal
approved these changes
Apr 18, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.