Skip to content

fix: make install paths explicit and stop failed setup commands - #1476

Merged
frahlg merged 3 commits into
masterfrom
fix/update-guide-stop-on-error-20260929
Sep 29, 2026
Merged

frahlg merged 3 commits into
masterfrom
fix/update-guide-stop-on-error-20260929

Conversation

@frahlg

@frahlg frahlg commented Sep 29, 2026 •

Copy link
Copy Markdown
Member

A user followed the update guide on the old Pi card, then tried Docker after the native installer refused it. Failed downloads did not stop the command block, and a rebuild tried to read private data/applink.json files. This change makes the card swap explicit before installation and fixes the commands that allowed that sequence.

  • Put the second-card path first in English, Swedish and the README. Give the Swedish native path its own complete command block. Explain each observed error and keep same-host Docker a separate advanced choice.
  • Validate the new-line tag, stop on failed commands, use a temporary native installer and refuse to overwrite an existing Docker project. Download both Docker files into a temporary directory first, so a failed download leaves no project behind and a corrected retry works.
  • Add .dockerignore to exclude private data and .env. Write it locally in the guide so the fix also works with releases that predate the new file. Check Compose and Buildx before creating the project.
  • Remove the competing install block from operations docs. Keep the old files and data for recovery.

Validation: reproduced checking context: no permission to read .../data/applink.json with an unreadable dummy file and the legacy builder. The fixed context passes both a legacy-builder and a BuildKit build and excludes dummy data, .env and an old installer. Eight tests execute the guide's command blocks with stubbed downloads and Docker: bad tags, 404 on either Docker file followed by a successful retry, stale installer, missing Buildx, existing directory and success. make verify passes, including the new tests and context build. Confirmed that the current published tag has both Docker files. Inspected both guides rendered on GitHub and checked their internal links.

No customer host was changed and no beta was published. The context test uses a scratch image and dummy files; it does not start FTW. The documentation can be used with existing releases immediately.

Paired website change: srcfl/ftw-web#15. Open website PRs #7, #8 and #9 change other sections; this change leaves them intact. Core #1051 has a separate README price section; this change only edits installation copy.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 29, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-29T14:37:34.029278Z 00b60fa PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 00b60fa1de

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/native-beta.md Outdated
sudo docker compose version
sudo docker buildx version
sudo docker info >/dev/null
mkdir "$HOME/ftw-local"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Remove a newly created project after download failure

When either curl fails—for example because a syntactically valid tag is unpublished or the network drops—set -e exits after creating ~/ftw-local. Every corrected retry then fails at mkdir, while the new error guidance tells the user not to delete that directory, leaving the documented installation path without a recovery step. Download into a temporary directory first, or trap cleanup only for the directory created by this invocation so pre-existing projects remain protected.

AGENTS.md reference: AGENTS.md:L24-L25

Useful? React with 👍 / 👎.

@frahlg
frahlg merged commit 3cdeb81 into master Sep 29, 2026
15 checks passed
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