Skip to content

docs: README demo from a real container run, dry-run and preflight notes - #2

Merged
hellpuffyt merged 2 commits into
mainfrom
docs/readme-refresh
Oct 26, 2026
Merged

hellpuffyt merged 2 commits into
mainfrom
docs/readme-refresh

Conversation

@hellpuffyt

Copy link
Copy Markdown
Owner

README audit. Discrepancies fixed:

  • No visual: added a Demo section with a real terminal capture of --profile minimal run twice in a fresh ubuntu:24.04 container (first run changes 3 steps, second changes none, one managed block in .bashrc), plus the text and a one-line Docker command to reproduce it.
  • --dry-run accounting was undocumented: verify is skipped and would-apply steps are counted as "skipped" in the summary.
  • The preflight network probe silently skips (with a warning) when neither curl nor ping exists, as on a fresh container. Added to Limitations.
  • Security section said CI "verifies a checksum" for shfmt; it installs a pinned version with go install, which checks the Go checksum database. Reworded to say exactly that.
  • Testing: test count (69) and the CI shellcheck / shfmt / dry-run smoke jobs were not mentioned.
  • Voice: 19 em dashes replaced.

Verified:

  • bats tests/ -> 69 ok (macOS) and docker run --rm -v "$PWD:/w" -w /w bats/bats:latest tests/ -> 69 ok
  • shellcheck bootstrap.sh lib/*.sh steps/*.sh clean; shfmt -d . (v3.9.0) clean
  • ./bootstrap.sh --help, --list-steps, --list-profiles match the README; profile contents match the table
  • ./bootstrap.sh --profile web --dry-run with scratch state/log on macOS: exit 0, no state file created
  • the Docker reproduction command in the README, exactly as written: run 1 changed 3, run 2 changed 0, both exit 0

Not run: real runs on macOS/desktop Linux, dnf/pacman/brew installs (stubbed tests only).

Copilot AI balanced review requested due to automatic review settings October 26, 2026 07:31
@coderabbitai

coderabbitai Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 7152c73c-66f7-425a-968e-0415ce193673
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

@hellpuffyt
hellpuffyt merged commit f7761ea into main Oct 26, 2026
7 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.

2 participants