Skip to content

Clarify release preparation, publishing, tests, and documentation - #25

Merged
samuel-williams-shopify merged 9 commits into
mainfrom
cleanup-release-code
Sep 22, 2026
Merged

samuel-williams-shopify merged 9 commits into
mainfrom
cleanup-release-code

Conversation

@samuel-williams-shopify

@samuel-williams-shopify samuel-williams-shopify commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

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:

  1. Improve layout and use explicit returns for multi-step methods.
  2. Load Bake task dependencies by feature name and load the publisher only when needed.
  3. Document parameters, results, failure conditions, and working-directory requirements.
  4. Extract named preparation operations while retaining core Bake tasks.
  5. Separate publishing, recovery, and registry verification, preserving the existing exception alias.
  6. Exercise initialized interfaces with Sus fixtures and mock external boundaries.
  7. Reorganize the guides and regenerate distributed agent context.
  8. Follow the bake-modernize README template, retaining the GitHub release command and linking to the project documentation.
  9. Call utopia:project:update during 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.

@samuel-williams-shopify
samuel-williams-shopify merged commit a2ae70e into main Sep 22, 2026
25 checks passed
@samuel-williams-shopify
samuel-williams-shopify deleted the cleanup-release-code branch September 22, 2026 01:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant