docs(release): refresh CHANGELOG and README for the v1.0.0 release prep#33
Merged
Merged
Conversation
The CHANGELOG was missing Phase 6 bullets for PRs #28 (QuotePath for paths with spaces), #29 (interrupted-upgrade sentinel + --from restore), and #30 (system-node classifier with warnings). It also had a duplicate `### Added` header from a prior merge and still listed the scripts/issue-workflow.sh script that PR #32 deleted. The README's Project status table said "Phase 1-5 OK" with no mention of Phase 6 cross-platform polish. The Phase 7 status (GoReleaser config + brew/scoop taps + npm wrapper) was also missing. CHANGELOG.md: - Single Added / Changed / Removed block under [Unreleased] (was two Added blocks). - Add Phase 6 bullets: system-node classifier (#30), interrupted- upgrade sentinel + replay (#29), QuotePath for paths with spaces (#28). - Drop the stale `scripts/issue-workflow.sh` bullet; add a Removed entry pointing at the squash-merged PR #32 commit for context. README.md: - Project status table marks Phase 6 complete, with PR refs and a note that Phase 7 (issue #17) is the remaining work blocking the v1.0.0 tag. - Trailing paragraph updated to reflect Phase 6 in the phase order. Refs #18
|
✔️ 6d82811 - 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
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
Refresh
CHANGELOG.mdandREADME.mdto reflect the code state onmainso the v1.0.0 release notes (issue #18) ship from a cleanbaseline. The CHANGELOG was missing Phase 6 bullets for PRs #28
(QuotePath for paths with spaces), #29 (interrupted-upgrade sentinel
--fromrestore), and feat(detector): warn on system Node and sandboxed installations #30 (system-node classifier); had a duplicate### Addedheader from a prior merge; and still listed thescripts/issue-workflow.shscript that PR chore(ci): replace issue-workflow.sh shell script with an AI skill #32 deleted. The README'sProject status table still said "Phase 1-5 ✅" with no mention of
Phase 6 cross-platform polish. Both are now corrected.
No code changes; no behavior change. This is the documentation-only
arm of the v1.0.0 release prep.
Linked issues
Closes #18
Type of change
feat— new feature (MINOR bump)fix— bug fix (PATCH bump)refactor— no behavior changedocs— documentation onlytest— tests onlychore— maintenance / dependency bumpci— CI/CD onlybuild— build system onlyChecklist
docs(release): subject)make cilocally and it passesdocs/, inline godoc) — thisPR IS the doc update
Scope notes / things reviewers may want to look at
Added / Changed / Removed block (was two Added blocks). Phase 6
entries are under Added; the deleted bash script is under Removed
with a pointer at the squash-merge commit for full context.
marks Phase 6 as ✅ and lists PRs fix(platform): shell-quote paths in all RunShell callsites (Windows spaces) #28/feat(packages): detect interrupted upgrades and add --from restore flag #29/feat(detector): warn on system Node and sandboxed installations #30 as the cross-platform
polish work that closes the bullets in issue fix(platform): cross-platform polish for Windows and shell quoting #16's body. Issue fix(platform): cross-platform polish for Windows and shell quoting #16
is still OPEN — recommend closing it via a follow-up PR or by the
next
chore(release)push, but not in this PR (which is scoped toissue chore(release): prepare v1.0.0 release #18).
config + brew/scoop taps + npm wrapper) and the manual checklist
items in chore(release): prepare v1.0.0 release #18 (secrets config, cross-platform smoke tests, manual
upgrade flow, tag push) all remain. This PR only clears the
documentation-debt arm.
Screenshots / output
N/A — documentation-only change.