fix: README first-run instructions reference a nonexistent keygen service - #3
Open
batuhankocyigit wants to merge 2 commits into
Open
Conversation
…vice The documented first step, `docker compose run --rm --no-deps -it keygen`, fails with "no such service: keygen" -- docker-compose.yml only defines a `node` service. Same drift shows up in three more places: `make init-keys` (no such target; the real one is `gen-key`), the "Repo layout" comment, and the Makefile's own .PHONY line still listing `init-keys` instead of `gen-key`. Replace the broken command with the one docker-compose.yml already documents in a comment and that `make gen-key` already wraps, and fix every other stale keygen/init-keys reference to match. Verified with `make -n gen-key` (matches the README command exactly) and a full-repo grep for keygen/init-keys (zero remaining matches).
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.
fix: README's first-run key-generation instructions reference commands that don't exist
The bug
The README's very first documented step for a new node ("## 1. Node
setup") tells the user to run:
docker-compose.ymlhas no service namedkeygen--services:onlydefines
node. Running this exact command against the repo as-is failswith
no such service: keygen.Two more references to the same no-longer-existing setup drifted along
with it:
make init-keysandmake up"-- there is no
init-keystarget in theMakefile; the actual targetis
gen-key(confirmed elsewhere in the same README, in the Operationstable:
make gen-key # first boot only: generate the validator key).docker-compose.yml # node (+ keygen, run once via \docker compose run keygen`)`.Makefile's own.PHONYline still listsinit-keys, which doesn'tcorrespond to any real target (the actual
gen-keytarget isn'tlisted there).
This all points at the same history: the key-generation step used to be
a
keygencompose service /init-keysmake target, and got replacedwith a raw
docker run ... new-validator-keyinvocation (whichdocker-compose.ymlalready documents in a comment, and whichmake gen-keyalready wraps) -- but the README's primary instructionsand the Makefile's
.PHONYline were never updated to match.The fix
docker compose run --rm --no-deps -it keygenwiththe actual working command (matching
docker-compose.yml's own commentand what
make gen-keyruns).make init-keys→make gen-keyin the shortcuts line.keygenmention in "Repo layout".Skip `keygen`wording in the migrationsection to refer to the step generically instead of a command name that
no longer exists.
Makefile's.PHONYline:init-keys→gen-key.Testing
make -n gen-key-- dry-run output matches the command now documentedin the README exactly.
make help-- listsgen-keycorrectly (previouslyinit-keysdidn'tshow up here at all, since
helpparses##-commented target lines,not
.PHONY, so this specific symptom was invisible until someoneactually tried
make init-keysordocker compose run keygen).grep -rn "keygen\|init-keys" --include="*.md" --include="Makefile" --include="*.yml" .-- zero remaining matches after the fix (previouslymatched in 4 places across
README.mdandMakefile).Scope
Two files, docs + one Makefile line. No changes to
docker-compose.yml,any service definitions, or actual node behavior -- this only fixes the
instructions and target name to match what already works.