Repository navigation
DocC site and Pages workflow (the pattern for all kits) - #3
Merged
Merged
Conversation
…er kits tools/build-docs.sh builds one archive per module with xcodebuild docbuild (no swift-docc-plugin: the kit takes no dependencies) and merges them; .github/workflows/docs.yml builds it on catalog changes and publishes on a tag. Not run locally (no Xcode in the cloud thread): the first run is the PR's CI. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LgLDoqWTo4pjAbSZukE8UQ
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
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.
Requested by Paul · project thread
What and why
CuboKit already has a
.docccatalog in all eight modules. This adds the two files that publish them, so Paul can approve the pattern before it is copied to the other five kits:tools/build-docs.sh <out> [<base-path>]:xcodebuild docbuildper module,docc mergeinto one archive,transform-for-static-hosting. Noswift-docc-plugin, because the kit takes no package dependencies..github/workflows/docs.yml: builds the site on catalog changes (artifact only) and deploys to GitHub Pages on a tag, athttps://mac4dstem.github.io/CuboKit/documentation/.Checklist
swift test -c releaseunaffected (no source change)Unverified, please note
Not run: the cloud thread has no Xcode. The first Docs run on this PR is the test; if
docbuild -scheme <Module>does not find per-module schemes for the package, the fix is inbuild-docs.shonly. Deploy needs Pages enabled with source "GitHub Actions" (Settings, Pages); the job is skipped except on tags.Generated by Claude Code