chore: rename config files (minimal + reference)#127
Merged
Conversation
config.json.template -> config.minimal.json (the copy-me starter: just the pool URL) config.advanced.example.json -> config.reference.json (the full reference: every key with its default, enforced complete by the #23 test) Matches the same rename in Pithead for cross-repo consistency. Content unchanged — the the starter is still just the pool URL. Updated all references (rigforge.sh, RELEASING, docs/configuration, .gitignore, the release workflow + macOS e2e bundle, and the config tests). CHANGELOG keeps the old names (historical). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
VijitSingh97
force-pushed
the
chore/config-rename
branch
from
61c0659 to
9f6f19c
Compare
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.
What
Rename the two config files so the names say what they are — the same rename as Pithead #326, for cross-repo consistency.
config.json.templateconfig.minimal.jsonconfig.advanced.example.jsonconfig.reference.jsonContent
No content change needed:
config.reference.jsonis already complete — the#23unit test enforces that it documents every keyparse_configreads (and excludes the internalPOOL_HOST/WORKER_NAME/WORKER_CONFIG_FILEkeys). Still passes after the rename.config.minimal.jsonis still minimal — onepools[0].urlwith the<YOUR_POOL_HOST>placeholder, andparse_configstill rejects it unedited (no accidental deploy to a bogus host).References updated
rigforge.sh,docs/configuration.md,RELEASING.md,.gitignore, the release workflow (.github/workflows/release.yml), the macOS e2e bundle (tests/e2e/macos.sh), and the config unit tests (tests/run.sh).CHANGELOG.mdkeeps the old names (historical).Verification
jq— both files valid JSONtests/run.sh— 614 pass (incl. the renamedconfig.reference.json/config.minimal.jsonunit tests)shellcheck+shfmt,markdownlint, YAML parse of the release workflow — cleanNOTE: touches
docs/configuration.md, which the open voice-consistency PR (#126) also edits — a small filename-line conflict on whichever merges second.🤖 Generated with Claude Code