Skip to content

docs(quickstart): describe what init now does to .env - #1205

Merged
Chemaclass merged 1 commit into
mainfrom
docs/quickstart-init-env-accuracy
Aug 14, 2026
Merged

docs(quickstart): describe what init now does to .env#1205
Chemaclass merged 1 commit into
mainfrom
docs/quickstart-init-env-accuracy

Conversation

@Chemaclass

Copy link
Copy Markdown
Member

🤔 Background

#1176 made bashunit init idempotent in .env: when it already points
BASHUNIT_BOOTSTRAP at the same file, init says so and changes nothing; only a
differing value is commented out and replaced.

The CHANGELOG recorded that. This page still described the old unconditional
comment-and-append, which would have told a user to expect a diff that no
longer happens.

💡 Changes

  • Describe both branches accurately, and note that re-running is safe

Found by following the quickstart literally, as a new user would. Every other
step — init, the manual test file, ./lib/bashunit tests, the default path,
--filter, --parallel — behaves exactly as documented, sample output
included.

#1176 made init idempotent: when .env already points BASHUNIT_BOOTSTRAP at the
same file it says so and changes nothing, and only a differing value is
commented out and replaced. The changelog recorded that; this page still
described the old unconditional comment-and-append.

Found by following the quickstart literally, as a new user would. Every other
step -- init, the manual test file, ./lib/bashunit tests, the default path,
--filter and --parallel -- behaves exactly as written, including the sample
output.
@Chemaclass Chemaclass added the documentation Improvements or additions to documentation label Aug 14, 2026
@Chemaclass Chemaclass self-assigned this Aug 14, 2026
@Chemaclass
Chemaclass merged commit d1f8fb1 into main Aug 14, 2026
6 checks passed
@Chemaclass
Chemaclass deleted the docs/quickstart-init-env-accuracy branch August 14, 2026 04:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant