Skip to content

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

Merged
merged 4 commits into from
Jul 17, 2025
Merged

Conversation

i2h3
Copy link
Collaborator

@i2h3 i2h3 commented Jul 10, 2025

No description provided.

@i2h3 i2h3 self-assigned this Jul 10, 2025
@i2h3 i2h3 added the documentation Improvements or additions to documentation label Jul 10, 2025
@i2h3 i2h3 force-pushed the documentation-catalog branch 2 times, most recently from ac7090f to a1156b1 Compare July 17, 2025 08:07
@i2h3 i2h3 requested a review from claucambra July 17, 2025 08:36
@i2h3
Copy link
Collaborator Author

i2h3 commented Jul 17, 2025

With a1156b1 I fixed a test which prevented this pull request from being mergable.

@i2h3 i2h3 requested review from camilasan, nilsding and Rello July 17, 2025 11:45
@i2h3 i2h3 requested a review from Copilot July 17, 2025 12:22
Copy link

@Copilot Copilot AI left a 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 using macos-latest or a supported version like macos-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 like timeout: 1.0 to avoid a compile error and ensure the test doesn't hang indefinitely.
        await fulfillment(of: [workingSetCheckCompleted])

i2h3 added 4 commits July 17, 2025 14:29
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]>
@i2h3 i2h3 force-pushed the documentation-catalog branch from 9b0d334 to d3e3f3f Compare July 17, 2025 12:29
@i2h3 i2h3 merged commit 26d00a8 into main Jul 17, 2025
2 checks passed
@i2h3 i2h3 deleted the documentation-catalog branch July 17, 2025 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants