docs: fix cleanup-related inaccuracies in CHANGELOG, managers.md, README#97
Merged
Merged
Conversation
Four doc inaccuracies surfaced by issue #60: - CHANGELOG.md cited Closes #40 (unrelated chore(ci): gitignore) for the native-mutation-commands bullet; the citation is dropped because the preceding bullet already closes #41. - docs/managers.md described a fabricated nvm-windows cleanup suppression message that doesn't exist in code. Replaced with the real behavior: the cleanup prompt still runs, each Uninstall() surfaces ErrNVMWindowsNotImplemented via the generic per-candidate failure line, and the ForcePerVersion downgrade (#58) prevents mass-deletion even with --cleanup / --yes / cleanup.auto: true. Same fix applied to the corresponding table row. - docs/managers.md's "Manager not on PATH" failure mode claimed the upgrade still completes and only cleanup is skipped; reality is ResolveManager returns ErrNoManager and runUpgrade aborts at upgrade.go:111-114 before install/migrate/cleanup. - README's "Phase 7 done" line disagreed with managers.md's "Phase 7 in progress" banner. Reconciled by flipping README to "Phase 7 in progress" and clarifying both refer to distribution packaging (#17 / #18) being outstanding while cleanup + mutation have shipped. Closes #60
|
✔️ dcebccc - Conventional commits check succeeded. |
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
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
Three docs-only inaccuracies introduced alongside the post-upgrade cleanup
feature (PR #56 / issue #41), all surfaced by issue #60:
CHANGELOG.mdcited the wrong issue for the native-mutation-commandsbullet. It said "Closes chore(ci): gitignore the local bin/ and coverage.out #40", but chore(ci): gitignore the local bin/ and coverage.out #40 is
chore(ci): gitignore the local bin/ and coverage.out— completely unrelated. The precedingbullet already closes feat(cleanup): post-upgrade cleanup prompt with version-by-version confirmation #41, so the redundant citation is just dropped
(rather than double-citing feat(cleanup): post-upgrade cleanup prompt with version-by-version confirmation #41).
docs/managers.mddescribed a fabricated nvm-windows suppressionnote. The paragraph claimed the cleanup prompt is suppressed for
nvm-windows with a specific explanatory message. No such message
exists in
internal/cli/cleanup.goorinternal/cli/upgrade.go. Inreality, the cleanup prompt still runs against nvm-windows — each
Uninstall()returnsErrNVMWindowsNotImplementedand surfaces thatvia the generic per-candidate
"Failed to delete %s: %v"line. TheCurrent()call also returns the sentinel, which triggers theForcePerVersiondowngrade (bug(cli): Current() failure leaves the active Node version unprotected from cleanup deletion #58), so even--cleanup/--yes/cleanup.auto: truefall back to y/N per candidate. The correspondingtable row also said "prints a clear note" — corrected to describe the
actual behavior.
docs/managers.md's "Manager not on PATH" failure mode was wrong.It said "the cleanup step is skipped entirely; the upgrade itself
still completes." In reality,
detector.ResolveManagerreturnsErrNoManager, andrunUpgradereturns immediately atinternal/cli/upgrade.go:111-114— the entire upgrade aborts beforeinstall/migrate/cleanup. Rewritten to match.
README.md and
docs/managers.mddisagreed about Phase 7. READMEsaid "Phase 7 ✅" (done); managers.md said "Phase 7 in progress."
Reconciled by flipping README to "Phase 7 🔧 (in progress)" with a
pointer at the remaining distribution packaging work (chore(release): finalize GoReleaser config and npm wrapper #17 / chore(release): prepare v1.0.0 release #18),
and clarifying managers.md's banner so the two are aligned on the
same definition (cleanup + mutation shipped, distribution outstanding).
Linked issues
Closes #60
Type of change
docs— documentation onlyfeat— new feature (MINOR bump)fix— bug fix (PATCH bump)refactor— no behavior changeperf— performance improvementtest— tests onlychore— maintenance / dependency bumpci— CI/CD onlybuild— build system onlyChecklist
docs(scope): subject)make cilocally and it passes (the change is docs-only; theGo pipeline still runs and stays green)
for a doc accuracy fix is
git grepagainst the affected code paths,which is what verified the new wording matches reality)
CHANGELOG.mdgets a
### Fixedentry under[Unreleased])make lintgreen)updated CHANGELOG.md
Screenshots / output
Pre-fix, the CHANGELOG cited an unrelated CI/gitignore issue:
Post-fix (citation dropped; the adjacent bullet already closes #41):
Pre-fix,
docs/managers.mdclaimed a fabricated single-note UX:Post-fix (describes the real per-candidate failure behavior):
Pre-fix, the "Manager not on PATH" failure mode was actively wrong:
Post-fix (matches
internal/cli/upgrade.go:111-114):Pre-fix, README and managers.md disagreed on Phase 7's status
(README said done, managers.md said in progress); both now
reflect the same definition — cleanup + mutation shipped,
distribution packaging (#17 / #18) outstanding.
Files touched
CHANGELOG.md— drops the wrongCloses #40citation; adds a### Fixedentry under[Unreleased]documenting the docrefresh with docs: post-upgrade cleanup docs inaccuracies (wrong issue ref, fabricated nvm-windows note, false PATH failure mode, Phase 7 status conflict) #60 reference.
docs/managers.md— replaces the fabricated nvm-windowssuppression-note paragraph with the real per-candidate failure
behavior; corrects the "Manager not on PATH" failure-mode
description; reconciles the Phase 7 status banner with README;
updates the nvm-windows table row to describe the actual
ErrNVMWindowsNotImplementedbehavior instead of "prints aclear note."
README.md— flips the Phase 7 row from "✅" to "🔧 (inprogress)" with a pointer at the remaining distribution work
so the two docs agree.