From 0cce951a3d8445c4d8241739e785c053e7030ea5 Mon Sep 17 00:00:00 2001 From: Doug Martin Date: Wed, 22 Jul 2026 13:54:45 -0400 Subject: [PATCH 1/2] docs: explain how to find the release version instead of pinning it [REPORT-77] Rather than hardcode a version into the install instructions (which would go stale and need updating every release), tell readers how to find the current version on the Releases page and how the asset filenames are constructed: - macOS direct download: grab the asset ending in _darwin_arm64/amd64.tar.gz. - Linux direct download: a VERSION variable plus the cc-data___.tar.gz pattern. No version-specific edits are needed on future releases. --- docs/researcher-guide.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/researcher-guide.md b/docs/researcher-guide.md index 202107d..d01e9f6 100644 --- a/docs/researcher-guide.md +++ b/docs/researcher-guide.md @@ -46,10 +46,10 @@ brew install cc-data there is no Gatekeeper prompt. - Don't have Homebrew? Install it first from [brew.sh](https://brew.sh). -**Without Homebrew:** download the macOS archive for your chip from the -[Releases page](https://github.com/concord-consortium/cc-data-cli/releases), -`cc-data__darwin_arm64.tar.gz` for Apple Silicon or -`cc-data__darwin_amd64.tar.gz` for Intel, unpack it, and move `cc-data` +**Without Homebrew:** open the latest release on the +[Releases page](https://github.com/concord-consortium/cc-data-cli/releases) and, +under **Assets**, download the archive whose name ends in `_darwin_arm64.tar.gz` +(Apple Silicon) or `_darwin_amd64.tar.gz` (Intel). Unpack it and move `cc-data` onto your `PATH`. The binary is notarized, so on first run macOS does a quick online check with Apple and then lets it run. @@ -62,12 +62,16 @@ brew tap --trust concord-consortium/tap brew install cc-data ``` -Or download directly (replace `X.Y.Z` with the latest version from the -[Releases page](https://github.com/concord-consortium/cc-data-cli/releases)): +Or download directly. Find the current version on the +[Releases page](https://github.com/concord-consortium/cc-data-cli/releases) (the +tag looks like `v0.1.0`); the assets follow the pattern +`cc-data___.tar.gz`. Set `VERSION` to that version without the +leading `v`: ``` +VERSION=0.1.0 # the current version, from the Releases page curl -fsSL -o cc-data.tar.gz \ - https://github.com/concord-consortium/cc-data-cli/releases/download/vX.Y.Z/cc-data_X.Y.Z_linux_amd64.tar.gz + "https://github.com/concord-consortium/cc-data-cli/releases/download/v${VERSION}/cc-data_${VERSION}_linux_amd64.tar.gz" tar xzf cc-data.tar.gz sudo mv cc-data /usr/local/bin/ ``` From 11a7f0a50e3e777f86da16e52422601605a4e4c6 Mon Sep 17 00:00:00 2001 From: Doug Martin Date: Wed, 22 Jul 2026 14:04:04 -0400 Subject: [PATCH 2/2] docs: make the VERSION download example an explicit placeholder [REPORT-77] Address the Copilot review: the snippet used VERSION=0.1.0 labeled 'the current version', which invites blind copy-paste of a version that ages. Use X.Y.Z so an unedited copy fails loudly (a 404) instead of silently installing an old build. --- docs/researcher-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/researcher-guide.md b/docs/researcher-guide.md index d01e9f6..49c25b3 100644 --- a/docs/researcher-guide.md +++ b/docs/researcher-guide.md @@ -69,7 +69,7 @@ tag looks like `v0.1.0`); the assets follow the pattern leading `v`: ``` -VERSION=0.1.0 # the current version, from the Releases page +VERSION=X.Y.Z # replace with the current version from the Releases page, e.g. 0.1.0 curl -fsSL -o cc-data.tar.gz \ "https://github.com/concord-consortium/cc-data-cli/releases/download/v${VERSION}/cc-data_${VERSION}_linux_amd64.tar.gz" tar xzf cc-data.tar.gz