Merged
Conversation
* Fix docc workflow * Update docc.yml
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR integrates the DocC plugin into the project to improve documentation generation. Key changes include:
- Adding a swift-docc-plugin dependency and updating Package.swift.
- Replacing the xcodebuild-based documentation build with swift package generate-documentation.
- Updating GitHub workflows for Swift setup and GitHub Pages deployment.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| Sources/AppState/Application/Application.swift | Added @mainactor to the static logger for thread isolation clarity. |
| Package.swift | Added swift-docc-plugin dependency for DocC integration. |
| .github/workflows/macOS.yml | Updated workflow to include Swift setup with version 6.1.0. |
| .github/workflows/docc.yml | Replaced xcodebuild steps with swift package generate-documentation and updated deployment actions. |
Comments suppressed due to low confidence (2)
.github/workflows/docc.yml:39
- [nitpick] Consider adding an inline comment explaining the switch from 'xcodebuild docbuild' to 'swift package generate-documentation' to aid future maintainers.
swift package --allow-writing-to-directory docs \
Sources/AppState/Application/Application.swift:17
- Ensure the @mainactor annotation on 'logger' is intentional; verify that binding logger access to the main thread aligns with all usage contexts in production.
@MainActor
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
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.
Summary
swift package generate-documentationTesting
swift test -vhttps://chatgpt.com/codex/tasks/task_e_683fb10a19288326b3ebb7062c003ce9