Clarify release preparation, publishing, tests, and documentation - #25
Merged
Merged
Conversation
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.
The release implementation was difficult to scan: preparation and publishing mixed several responsibilities, task files loaded libraries through relative source paths, and one guide covered the entire release lifecycle. This cleanup makes the operation order explicit, documents the API contracts, and gives preparation, verification, and recovery their own guides while preserving the release checks and artifact handling.
The commits cover:
utopia:project:updateduring release preparation, with a documentation URL and dedicated README Releases section for generated content.Validation: 105 tests and 439 assertions pass, with 474/474 lines covered using the standard Covered integration; RuboCop passes; Decode reports 30/30 public definitions documented; consumer task loading passes. Static documentation renders and crawls successfully, with 184 local links and anchors checked across 17 pages. The local Pagefind search-index step remains unverified: its macOS binary is killed even with
--version.The release hook was also exercised in a disposable checkout: it updates the versioned notes, README, and agent context, preserves the Making Releases command, and produces no further changes when documentation generation is repeated.