Introduce a macOS DocC soundness check #216
Open
+61
−2
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
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This introduces a variant of the "Documentation Check" (i.e.
docs-check) job withinsoundness.ymlwhich runs the same check on macOS instead of Linux.This new job is disabled by default, but can be enabled via the new
docs_check_macos_enabledinput setting.Motivation: Some packages (such as Swift Testing) are unable to use the current documentation check job because they encounter issues when attempting to build documentation on platforms other than macOS. (In Swift Testing's case, the problems relate to its use of Swift cross-import overlays and cross-module references.) Those issues will be tracked separately, but cannot always be readily worked around. Additionally, having a macOS job which builds documentation helps ensure the documentation can be built successfully at-desk when developing on macOS.