docs: complete the local compile command in AGENTS.md - #1420
Open
centraldogma99 wants to merge 1 commit into
Open
docs: complete the local compile command in AGENTS.md#1420centraldogma99 wants to merge 1 commit into
centraldogma99 wants to merge 1 commit into
Conversation
The documented local build dropped both flags the release workflow compiles with (.github/workflows/release.yml:111). Without the __CLI_VERSION__ define, `plannotator --version` falls back to `plannotator dev` (apps/hook/server/cli.ts:128), so a locally built binary carries no identifying version. Also note the macOS bun floor: 1.3.12 loses the linker signature and the compiled binary is SIGKILLed on launch (backnotprop#541), which is why CI pins bun-version 1.3.14. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Lz3aBzrpHocVFU94YN7QBr
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
1 participant
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 local compile command in
AGENTS.md(## Build) drops both flags the release workflow uses, so a binary built by following the docs differs from a released one.Source of truth:
.github/workflows/release.yml:111compiles with--no-compile-autoload-bunfigand--define "__CLI_VERSION__=\"$VERSION\"".Two concrete failure modes:
__CLI_VERSION__define,plannotator --versiontakes the fallback inapps/hook/server/cli.ts:128and printsplannotator dev— a locally built binary can't be told apart from any other. Verified locally: the documented command printsplannotator dev; with the define it printsplannotator 0.0.0-dev.codesign -dvreports it as unsigned. This is whyrelease.ymlpinsbun-version: 1.3.14and keeps the macOS smoke leg (release.yml:174-175). Hit for real; upgrading bun resolved it. The docs said nothing about the floor.Docs-only change: the corrected command with an obviously-local
0.0.0-devplaceholder, plus one sentence naming the flags' source and the macOS bun floor. No restructuring.bun run check:release-versionpasses.Per
CONTRIBUTING.mdthis is a fork → PR contribution under the repo's dual Apache-2.0/MIT licensing.