Public Options init, tests, CI matrix, DocC Pages & contributor docs - #20
Merged
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- Options: add public memberwise initializer so consumers can construct Options(...) directly (synthesized memberwise init was internal-only). - Tests: add ProgressUITests target (Options defaults/init, Progressable bucketing, GrowDirection alignment). - CI: bump checkout v3->v4, run `swift test`, build across all supported platforms (iOS/macOS/macCatalyst/watchOS/tvOS/visionOS). - Docs: fix uncompilable README examples; add DocC catalog, CHANGELOG, CONTRIBUTING; document Git Flow branching/release conventions in CLAUDE.md. - Templates: move PR template to default path so it auto-applies; add a required ProgressUI-version field to the bug report; refresh Xcode/iOS example versions. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- Add swift-docc-plugin (build-tool only) to Package.swift. - Add Documentation workflow that builds the ProgressUI.docc catalog for static hosting and deploys it to GitHub Pages on push to main. - Gitignore Package.resolved (no lockfile imposed on consumers) and the generated /docs site. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- Build on push for `main` only; `develop` is reached via PR, which already runs the suite, so per-merge double runs are eliminated. - Add a concurrency group to cancel superseded runs for the same ref. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
📋 Description
Hardens the package for public contributors and fixes a latent public-API bug.
Optionspublic init — the synthesized memberwise initializer was internal-only, soOptions(...)could not be constructed from a consumer module (only.setX()modifiers worked). Adds an explicitpublic initpreserving all defaults.ProgressUITeststarget (9 tests):Optionsdefaults/init,Progressable.calculate(from:)bucketing,GrowDirectionalignment.actions/checkout@v4, runsswift test, builds across all 6 advertised platforms; push scoped tomain+ concurrency to avoid redundant runs.swift-docc-plugin+ a workflow that publishes theProgressUI.docccatalog on push tomain.CHANGELOG.md,CONTRIBUTING.md, DocC landing page, and Git Flow conventions inCLAUDE.md..github/PULL_REQUEST_TEMPLATE.mdso it auto-applies; added a required ProgressUI-version field to the bug report; refreshed Xcode/iOS example versions to 26.🔄 Type of Change
Optionsinit)✅ How Has This Been Tested?
xcrun swift test→ 9 tests, 0 failures.xcrun swift buildgreen; DocC generation validated locally (producesindex.html).Test Summary
🤖 Generated with Claude Code