Repository navigation
docs: state what CI does and does not check - #11
Merged
Merged
Conversation
The README claimed CI runs swift build and swift test. It does not, and cannot: no hosted runner has the SwiftPM 6.4 this package needs. Say what CI actually checks, why build is excluded, and that the build/test obligation is the contributor's until a suitable runner exists. BRANCHING.md carried the same assumption in its first paragraph.
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
The README and
docs/BRANCHING.mdboth claimed CI runsswift buildandswift test. It does not, and cannot on a hosted runner — see #10 for why.This corrects that in both places: CI checks formatting and syntax, the build/test obligation sits with the contributor until a runner ships SwiftPM 6.4, and the workflow file's comment names what to add when that happens.
Testing
Docs only. No source changed.