docs(quickstart): release-bundle install (pull) as the quick start + config.json.template#247
Merged
Merged
Conversation
…nfig.json.template The README + getting-started quick starts said `git clone && ./pithead setup` — the source/build path — so every new user got a `dev` build of the latest commit instead of the published, tested release images (hence the `dev · main @ <sha>` dashboard badge + a non-working update-checker). docs/releasing.md already specifies installs should *pull*. - Quick start (README + getting-started) → download the latest release bundle (pulls the published images, no local build): `curl -fsSL .../releases/latest/download/pithead.tar.gz | tar xz` - Use the BASIC `config.json.template` (just the two payout addresses — matches setup's own "copy config.json.template" guidance); `config.advanced.example.json` is "for more options". - make_bundle: now ships config.json.template (it only shipped the advanced example), names the asset `pithead.tar.gz` (versionless → stable /releases/latest/download URL) and unpacks to a versionless `pithead/` dir (so a re-download upgrades in place). - `git clone` demoted to an "Alternative: build from source" section (the `dev` path). - Tests: the bundle ships config.json.template + unpacks to pithead/. No image/code change — purely docs + bundle packaging. The v1.0.1 bundle is re-cut with this and re-attached so the quick-start URL works for the current release (no version bump). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Follow-on to the quick-start switch — align the rest of the docs with the release-bundle (pull) model: - operations.md: 'Updating the stack' now covers BOTH paths — re-download the bundle (pull) or git pull (rebuild) — instead of only git pull; command-table row clarified. - README.md: upgrade row no longer says 'after a git pull' only. - releasing.md: install one-liner uses config.json.template (not the advanced example); bundle-contents note updated. - CHANGELOG [1.0.1] Install/Upgrade: leads with the bundle + covers both upgrade paths. Docs-only; no product change. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
VijitSingh97
added a commit
that referenced
this pull request
Jun 14, 2026
…nload URL) (#248) 1.0.1's install bundle shipped only config.advanced.example.json under a versioned name, and the documented quick start needs config.json.template + a stable pithead.tar.gz URL. Because releases are immutable, 1.0.1's bundle can't be fixed in place — so this ships the corrected bundle as 1.0.2. The published IMAGES are byte-identical to 1.0.1 (re-tagged); nothing in the running stack changes. CHANGELOG [1.0.2] says so and points to 1.0.1 for the feature set. - VERSION + dashboard pyproject -> 1.0.2 - CHANGELOG: thin [1.0.2] packaging entry (the make_bundle/config.json.template fix is #247) Cut with `make release --skip-integration` — the product is unchanged from the matrix- validated 1.0.1. Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Makes the documented quick start match how releases are meant to be installed — fixing the
dev · main @ <sha>badge you hit on pithead-prod.Why
The README + getting-started quick starts were
git clone && ./pithead setup— the source/build path. So every new user got a:devbuild of the latest commit instead of the published, tested:vX.Y.Zimages, plus adevdashboard badge and a non-working update-checker.docs/releasing.mdalready says installs should pull the bundle — the docs just never followed.Changes
config.json.template(basic — two wallet addresses) is the quick-start config, matchingsetup's own guidance (pithead:1261).config.advanced.example.jsonis now "for more options."make_bundle: shipsconfig.json.template(it only shipped the advanced example — the actual inconsistency), names the assetpithead.tar.gz(versionless → stable/releases/latest/download/URL) and unpacks to a versionlesspithead/dir.git clonemoved to an "Alternative: build from source" section (the:devpath — for contributors).config.json.template+ unpacks topithead/.Not a new release
No image/code change — purely docs + bundle packaging. After merge I'll re-cut the v1.0.1 bundle with this and re-attach
pithead.tar.gzto the v1.0.1 release, so the quick-start URL resolves for the current release. The:v1.0.1images are untouched.shellcheckclean ·make testgreen.