Skip to content

[5.7] Remove confusing error when no docs are produced #149

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.

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

Conversation

ethan-kusters
Copy link
Contributor

@ethan-kusters ethan-kusters commented Apr 15, 2022

  • Rationale: Addressed a regression where docc convert would throw an error upon failing to actually produce documentation for an otherwise valid DocC catalog.
  • Risk: Low
  • Risk Detail: Minor, targeted change that is covered by a test.
  • Reward: High
  • Reward Details: Resolves a regression and avoids potential breakage with DocC's integration into other clients. Unblocks the enablement of transform-for-static-hosting by default for the 5.7 release.
  • Original PR: Remove confusing error when no docs are produced #148
  • Issue: rdar://91790147
  • Code Reviewed By: @d-ronnqvist and @talzag
  • Testing Details: Added unit tests to ensure that the default behavior of docc convert on the command-line does not throw an error in this scenario.

Removes a confusing error that started being emitted when `docc convert`
failed to actually produce documentation for an otherwise valid DocC catalog.

This regression was introduced by the enablement of transform for static
hosting by default since that command relies on a `data` subdirectory
existing in the produced documentation archive.

Resolves rdar://91790147.
@ethan-kusters
Copy link
Contributor Author

@swift-ci please test

@ethan-kusters ethan-kusters requested a review from sara-radi April 15, 2022 18:42
@ethan-kusters ethan-kusters merged commit adc8503 into swiftlang:release/5.7 Apr 19, 2022
@ethan-kusters ethan-kusters deleted the fix-confusing-error-5.7 branch April 19, 2022 00:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants