docs(readme): document Bash 4 requirement, drop sudo from dry-run example - #24
Merged
Merged
Conversation
…mple Two corrections found while reading install.sh against the README: 1. install.sh uses the `mapfile` builtin (lines 251, 259, 502, 573, 585), which is Bash 4.0+. macOS ships Bash 3.2 at /bin/bash, so the script fails on a stock system unless a newer Bash is earlier on PATH. The Requirements section listed only "macOS 10.6+" and tools that "ship with macOS", which implies no extra install is needed. Added the Bash 4 requirement with the brew install line. 2. The Examples section showed `sudo ./install.sh --dry-run`, but check_root() short-circuits when DRY_RUN is true, so --dry-run never needs root. Removed the sudo and noted why. Docs only; no behavior change.
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.
Summary
Two README corrections found by reading
install.shagainst the documentation:Bash 4 requirement was undocumented.
install.shuses themapfilebuiltin (lines 251, 259, 502, 573, 585), which requires Bash 4.0+. macOS ships Bash 3.2 at/bin/bash, so the script fails on a stock system unless a newer Bash is earlier onPATH. The Requirements section previously listed only "macOS 10.6+" plus tools that "ship with macOS", implying nothing extra was needed.--dry-rundoes not need root. The Examples section showedsudo ./install.sh --dry-run, butcheck_root()short-circuits whenDRY_RUNis true, sosudois unnecessary. Removed it and noted why.Docs only; no behavior change.
Secondary purpose: end-to-end review-workflow validation
This PR also serves as an end-to-end check that the Claude blocking review actually renders a verdict.
mainnow pins the reusable workflow atclaude-blocking-review.yml@v3.1.1, which bumpsanthropics/claude-code-actionfrom v1.0.70 to v1.0.193 — a security bump clearing GHSA-8q5r-mmjf-575q. That bump has not yet been confirmed to run a review successfully: prior validation attempts all touched.github/workflows/*.yml, which trips the reusable workflow's workflow-self-modification guard and skips the review entirely.This PR deliberately touches only
README.md— nothing under.github/— so the reviewer should actually execute rather than skip, letting us confirm v1.0.193 renders a BLOCK/PASS verdict.