-
Notifications
You must be signed in to change notification settings - Fork 1
Xcode Documentation Catalog with GitHub Pages #113
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
Conversation
ac7090f
to
a1156b1
Compare
With a1156b1 I fixed a test which prevented this pull request from being mergable. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Adds a DocC-based documentation catalog with GitHub Pages deployment and enhances code with async testing and API docs.
- Introduces a GitHub Actions workflow to build and deploy documentation on GitHub Pages.
- Provides theme settings and initial Documentation.md for NextcloudFileProviderKit.
- Replaces test sleeps with XCTest expectations and adds documentation comments to public APIs.
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
File | Description |
---|---|
Tests/NextcloudFileProviderKitTests/RemoteChangeObserverEtagOptimizationTests.swift | Replace Task.sleep calls with XCTest async expectations |
Sources/NextcloudFileProviderKit/Utilities/LocalFiles.swift | Add functions for app group container paths, temp files, and lock handling with docs |
Sources/NextcloudFileProviderKit/Item/Item+LockFile.swift | Document createLockFile extension method |
Sources/NextcloudFileProviderKit/Interface/RemoteInterface.swift | Define RemoteInterface protocol with documentation |
Sources/NextcloudFileProviderKit/Enumeration/RemoteChangeObserver.swift | Extend startWorkingSetCheck to accept an optional completion closure |
Sources/NextcloudFileProviderKit/Documentation.docc/theme-settings.json | Add DocC theme color and typography settings |
Sources/NextcloudFileProviderKit/Documentation.docc/Documentation.md | Provide project overview and feature list for DocC |
.github/workflows/documentation.yml | Set up CI job to build and deploy documentation via GitHub Actions |
Comments suppressed due to low confidence (3)
.github/workflows/documentation.yml:18
- The runner label
macos-15
is not valid on GitHub Actions. Consider usingmacos-latest
or a supported version likemacos-12
to ensure the job runs correctly.
runs-on: macos-15
Sources/NextcloudFileProviderKit/Utilities/LocalFiles.swift:83
- [nitpick] The
originalFileName(fromLockFileName:)
doc comment is missing a- Returns:
section describing the returned value.
public func originalFileName(fromLockFileName lockFilename: String) -> String? {
Tests/NextcloudFileProviderKitTests/RemoteChangeObserverEtagOptimizationTests.swift:135
- The
await fulfillment(of:)
call requires a timeout parameter. Add something liketimeout: 1.0
to avoid a compile error and ensure the test doesn't hang indefinitely.
await fulfillment(of: [workingSetCheckCompleted])
Sources/NextcloudFileProviderKit/Interface/RemoteInterface.swift
Outdated
Show resolved
Hide resolved
Signed-off-by: Iva Horn <[email protected]>
Otherwise the affected test fails in GitHub actions due to the hosted Action runners being significantly slower. Signed-off-by: Iva Horn <[email protected]>
…es created by third-party apps. Signed-off-by: Iva Horn <[email protected]>
Signed-off-by: Iva Horn <[email protected]>
9b0d334
to
d3e3f3f
Compare
No description provided.