Skip to content

docs: document that umbel apply warms the cache (Closes #11)#26

Open
vessux wants to merge 1 commit into
mainfrom
worktree-issue-11-apply-build-docs
Open

docs: document that umbel apply warms the cache (Closes #11)#26
vessux wants to merge 1 commit into
mainfrom
worktree-issue-11-apply-build-docs

Conversation

@vessux

@vessux vessux commented Jun 18, 2026

Copy link
Copy Markdown
Owner

Closes #11.

What

umbel apply <name> is documented as pin-only, but runBundleApply (src/run.ts:371-374) builds the bundle before writing the pin — warming the cache, atomically updating the by-name/<name> symlink, and printing a built <path> line alongside pinned …. The docs never said so, making the extra output + disk write read like a bug.

This is a docs-only change; apply's behavior is unchanged.

Changes

  • README verb tableapply comment now reads pin … + warm cache.
  • README prose — new note after the verb table explaining the build side effect, the by-name/<name> update, the built <path> output line, and that a subsequent plain umbel run launches without a rebuild. Clarifies apply --vanilla builds nothing.
  • docs/bundles-spec.md — primary apply description (the "writes a single-candidate bundle pin" sentence) now leads with the build + cache-warm + by-name + built <path> behavior; CLI-surface table comment updated to build + write pin.

Acceptance criteria

  • README apply entry mentions the cache-build + by-name update side effect
  • The spec's apply description mentions the same
  • Docs reflect the built <path> output line

Out of scope (per issue)

  • No change to apply's behavior — the build side effect stays.
  • The --vanilla apply path (clarified as no-build, not changed).

`umbel apply` builds the bundle before writing the pin (warming the cache,
updating the `by-name/<name>` symlink, and printing a `built <path>` line),
but the README verb table and the spec described it as pin-only. Document
the build side effect in both, and clarify that `apply --vanilla` does not
build.
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.

umbel apply builds the cache as a side effect (undocumented)

1 participant