Skip to content

feat(release): say plainly which file to download, one version per page - #32

Open
QuicksilverSlick wants to merge 3 commits into
mainfrom
feat/release-download-guide
Open

QuicksilverSlick wants to merge 3 commits into
mainfrom
feat/release-download-guide

Conversation

@QuicksilverSlick

@QuicksilverSlick QuicksilverSlick commented Sep 28, 2026 •

Copy link
Copy Markdown
Owner

What this is

The release page read as a file list for developers. It now tells a visitor which single file is theirs.

  • scripts/dreamforge-release-notes.md: the page text. It opens with a table (Windows PC, Mac with an Apple chip, Mac with an Intel chip), where each row links its exact file. Then it explains how to tell which Mac you have, gives numbered install steps for Windows and Mac, and says which files to ignore (.app.tar.gz, .sig, latest.json, and GitHub's "Source code").
  • Publish job, "Upload to the rolling release":
    • fills {VERSION} and {BASE} into the template and refuses to continue if a placeholder is left;
    • titles the release Dreamforge <version> and rewrites the notes on every publish, not only the first;
    • after latest.json is uploaded, deletes assets from earlier versions, so the page shows one set. latest.json no longer names those files. A failure there only warns, because the release is already live by then and a rerun would be refused as "not newer". The notes edit runs before latest.json, for the same reason.
    • the pre-publish existence check now also covers both DMGs, because the page links them directly.

VERSION is already plain x.y.z at that point, because "Write latest.json" refuses anything else. So the sed input can't carry anything unexpected.

Review

Two reviewers checked this PR, one for publish-step correctness and one for install-step accuracy against Apple and Microsoft documentation. All six findings were applied in the second commit:

  • the ordering and warn-only cleanup above;
  • no pipefail in the publish job's bash, so the asset list is captured without a pipe;
  • the DMG existence check;
  • Mac steps: click Done, not Move to Trash, Open Anyway lasts about an hour, and it asks for the login password;
  • chip guidance for A-series Macs;
  • Edge's "isn't commonly downloaded" prompt and Smart App Control.

Verified

  • The template rendered for 0.5.21 has no placeholders left, and all three links return 200 against the live release.
  • The cleanup rule, dry-run for 0.5.22 against current, old and look-alike names (0.5.220), keeps latest.json and the _0.5.22_ files and deletes the rest.
  • The workflow YAML parses. The step body was run under bash -e with a fake gh whose asset listing, and separately one delete, fails. Both runs finish 0 and print the warning.
  • The same text is already on the live 0.5.21 release (title "Dreamforge 0.5.21"), applied by hand with gh release edit.

🤖 Generated with Claude Code

QuicksilverSlick and others added 3 commits September 28, 2026 08:46
The release page now opens with a table: Windows PC, Mac with an Apple chip, Mac with an Intel chip, each linking its exact file, plus how to tell which Mac you have and step-by-step install for both. The text lives in scripts/dreamforge-release-notes.md; the publish job fills in the version and links, sets the title to "Dreamforge <version>", rewrites the notes on every publish, and after latest.json is uploaded removes the previous version's files so the page only ever shows one set.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Publish: the notes edit now runs before latest.json goes live, and the old-file cleanup after it only warns (a failure there used to turn a shipped release red, and a rerun is refused as not newer). The asset list is captured without a pipe, since the publish job's bash has no pipefail. The pre-publish check now also requires both DMGs the page links.

Page: Mac steps say to click Done, not Move to Trash, that Open Anyway lasts about an hour, and that it asks for the login password; chip guidance covers A-series Macs and matches About This Mac's Chip and Processor lines; Windows steps cover Edge's isn't-commonly-downloaded prompt and Smart App Control; the certificate wording is corrected; and updates are described as the Ready to update! card they are.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant