Skip to content

docs(agents): clarify just build vs release-build - #599

Merged
michaelneale merged 1 commit into
mainfrom
micn/agents-tweak-running
May 20, 2026
Merged

docs(agents): clarify just build vs release-build#599
michaelneale merged 1 commit into
mainfrom
micn/agents-tweak-running

Conversation

@michaelneale

Copy link
Copy Markdown
Collaborator

What

Clarify in AGENTS.md that:

  • just build produces a debug binary at ./target/debug/mesh-llm — fine for fast iteration and compile sanity, not for serious behavior testing, perf testing, or deploying to test machines.
  • just release-build is the command to use when you actually want ./target/release/mesh-llm (the binary just bundle consumes and CI ships).
  • ./target/release/mesh-llm existing on disk is not evidence your current source tree is in it — could be from a previous build. Check mtime or rerun just release-build.
  • cargo check / cargo build do not count as a build for this repo (they skip llama.cpp ABI prep and UI; cargo check produces no binary).

Why

Agents (me) were copying ./target/release/mesh-llm to test machines assuming it reflected the current branch, when in fact it was a stale artifact. just build is also easy to misread as the release path; making the debug vs release distinction explicit prevents this class of mistake.

Validation

Docs-only change. No code touched, no tests affected.

Two clarifications to the Building section:

* Spell out that `just build` produces a DEBUG binary at
  `./target/debug/mesh-llm` and is for fast iteration only — not for
  serious behavior testing, perf testing, or deploying to test machines.
* Spell out that `just release-build` is the right command when you
  actually want a release binary at `./target/release/mesh-llm` (the
  one `just bundle` consumes and CI ships).

Also notes:
* `./target/release/mesh-llm` existing is not evidence that your
  current source tree is in it — it may be left over from a previous
  build. Check mtime or re-run `just release-build`.
* `cargo check` / `cargo build` do not count as a build for this
  repo — they skip llama.cpp ABI prep and the UI, and `cargo check`
  produces no binary at all.
Copilot AI review requested due to automatic review settings May 20, 2026 03:15
@michaelneale
michaelneale merged commit ca33365 into main May 20, 2026
13 checks passed
@michaelneale
michaelneale deleted the micn/agents-tweak-running branch May 20, 2026 03:17

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Clarifies the agent-facing build workflow in AGENTS.md by distinguishing debug vs release builds, and by warning about stale target/release/mesh-llm artifacts when copying binaries to test machines.

Changes:

  • Updates the “Building” command list to explicitly label just build (debug) vs just release-build (release).
  • Adds guidance on when to use each build, and warns that target/release/mesh-llm may be stale.
  • Notes that cargo check / cargo build are not equivalent to the repo’s just build pipeline (llama.cpp ABI prep + UI).
Comments suppressed due to low confidence (1)

AGENTS.md:63

  • This note says ./target/release/mesh-llm may exist from a previous just build-dev invocation, but build-dev uses the dev/debug profile and produces target/debug/mesh-llm (it doesn’t build the release binary). Consider replacing build-dev here with the actual sources of a release binary (e.g., prior just release-build / release-build-* or a manual cargo build --release).
- `./target/release/mesh-llm` may exist from a *previous* `just release-build`
  or `just build-dev` invocation even after you run only `just build` — its
  presence is **not** evidence that your latest code is in it. When in doubt,

Comment thread AGENTS.md
Comment on lines +70 to +71
When in doubt for testing or shipping changes: use `just release-build` and
then copy `./target/release/mesh-llm`.
michaelneale added a commit that referenced this pull request May 20, 2026
* origin/main:
  fix(mesh): skip filtered peers in gossip dial loop to unwedge `--auto` (#602)
  docs(agents): clarify just build vs release-build for serious testing (#599)
  build: ozempic — slim binary -42 MB / -47 MB (#592)
  fix(runtime): proxy through mesh during serve --auto startup (#591)
  chore(code-quality): Set max 200 line limit for long methods (#595)
  fly size bump (#590)
  agents is now up to date (#588)
  fix(ci): fix CI PR cleanup job to delete in batches (#587)
michaelneale added a commit that referenced this pull request May 20, 2026
* main:
  fix(mesh): skip filtered peers in gossip dial loop to unwedge `--auto` (#602)
  docs(agents): clarify just build vs release-build for serious testing (#599)
  build: ozempic — slim binary -42 MB / -47 MB (#592)
michaelneale added a commit that referenced this pull request May 21, 2026
* main:
  docs(AGENTS): add confidence-testing recipe for routing/MoA/gossip changes (#613)
  ci(sdk-smoke): install lld in macOS swift smoke job (#610)
  MoA: mesh mode and many inference critical fixes, and quic keep alive (#566)
  fix(ci): small update for lint rule (#608)
  mockup: Reserves high-fidelity UI mockup (#560)
  Add advisory capacity evaluation for model targets (#579)
  Harden Skippy layer package materialization cache (#583)
  fix(release): pin Windows CUDA to sccache-compatible version (#606)
  fix(build-windows): tolerate dead sccache server in CUDA retry path (#604)
  chore(version): synchronize version bump everywhere (#562)
  fix(mesh): skip filtered peers in gossip dial loop to unwedge `--auto` (#602)
  docs(agents): clarify just build vs release-build for serious testing (#599)
  build: ozempic — slim binary -42 MB / -47 MB (#592)
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.

2 participants