docs: fix documentation generation #383
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
This corrects a mistake I made when I proposed the changes for doc generation: we don't actually generate docs for `macos-xcodebuild`! The error was masked, because once docs are in S3 they don't get deleted by subsequent builds not generating them. I.e. the existing docs for `main` were simply slowly getting more and more outdated. A recent change on our end exposed this issue.
Thanks for opening this pull request!
|
Codecov Report
@@ Coverage Diff @@
## main #383 +/- ##
==========================================
- Coverage 89.67% 89.66% -0.02%
==========================================
Files 155 155
Lines 14121 14121
==========================================
- Hits 12663 12661 -2
- Misses 1458 1460 +2
Continue to review full report at Codecov.
|
cbaker6
changed the title
Contributor
|
Thanks Sven! Based on SwiftPackageIndex/SwiftPackageIndex-Server#1892 do you recommend to merge this now or should I wait? |
Contributor
Author
|
It should go in as soon as possible, as that PR (#1892) will briefly disable the documentation link until we've reprocessed. I'll manually trigger after you merge so we don't have a 24h gap! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
New Pull Request Checklist
Issue Description
This corrects a mistake I made when I proposed the changes for doc generation: we don't actually generate docs for
macos-xcodebuild! The error was masked, because once docs are in S3 they don't get deleted by subsequent builds not generating them. I.e. the existing docs formainwere simply slowly getting more and more outdated.A recent change on our end exposed this issue.
Related issue: #n/a
Approach
TODOs before merging