fix: restore smoke-test workspace changelog for prepare-release#418
Merged
c-vigo merged 8 commits intorelease/0.3.1from Mar 23, 2026
Merged
fix: restore smoke-test workspace changelog for prepare-release#418c-vigo merged 8 commits intorelease/0.3.1from
c-vigo merged 8 commits intorelease/0.3.1from
Conversation
Wire CLI subcommand and stub implementation; tests fail until unprepare is implemented. Refs: #417
Rename first ## [semver] - … heading to ## Unreleased for smoke-test sync. Refs: #417
…prepare Smoke-test install copies .devcontainer/CHANGELOG.md to workspace root and runs unprepare so prepare-release validation sees Unreleased entries. Refs: #417
Remap is handled in init-workspace.sh during smoke-test install. Refs: #417
There was a problem hiding this comment.
Pull request overview
Fixes smoke-test RC deploys leaving the workspace root CHANGELOG.md in an invalid scaffold state that causes downstream prepare-release.yml validation to fail, by normalizing the changelog during smoke-test installs and adding a dedicated prepare-changelog unprepare helper in vig-utils.
Changes:
- Add
unprepare_changelog()+prepare-changelog unpreparesubcommand to rename the first## [X.Y.Z] - …heading to## Unreleased, with unit + CLI/subprocess tests. - Update
init-workspace.sh --smoke-testto copy.devcontainer/CHANGELOG.mdto the workspace root and runprepare-changelog unprepare. - Remove the redundant changelog remap block from the smoke-test dispatch workflow and adjust BATS coverage accordingly; document the fix in both changelog copies and
vig-utilsREADME.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
tests/bats/just.bats |
Updates BATS assertion to reflect simplified smoke-test changelog checks (remap logic removed from workflow). |
packages/vig-utils/tests/test_prepare_changelog.py |
Adds comprehensive coverage for unprepare (unit, handler, main(), and subprocess e2e). |
packages/vig-utils/src/vig_utils/prepare_changelog.py |
Introduces unprepare_changelog() and wires unprepare into the CLI. |
packages/vig-utils/README.md |
Documents the new prepare-changelog unprepare command in usage and examples. |
CHANGELOG.md |
Adds release-note entry describing the smoke-test changelog restoration fix. |
assets/workspace/.devcontainer/CHANGELOG.md |
Mirrors the same release-note entry in the workspace template changelog copy. |
assets/smoke-test/.github/workflows/repository-dispatch.yml |
Removes inline awk/sed changelog remap now handled during smoke-test install; keeps existence/readability checks. |
assets/init-workspace.sh |
Implements smoke-test-time changelog copy + prepare-changelog unprepare normalization. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Description
Smoke-test RC deploy left workspace
CHANGELOG.mdas the empty scaffold afterinit-workspace.sh --smoke-test, so downstreamprepare-release.ymlfailed validation (Unreleased section has no entries). This change copies.devcontainer/CHANGELOG.mdto the workspace root during smoke-test install, runs newprepare-changelog unprepareto rename the top## [semver] - …heading to## Unreleased, and drops the redundant remap block from the smoke-test dispatch workflow.Type of Change
feat-- New featurefix-- Bug fixdocs-- Documentation onlychore-- Maintenance task (deps, config, etc.)refactor-- Code restructuring (no behavior change)test-- Adding or updating testsci-- CI/CD pipeline changesbuild-- Build system or dependency changesrevert-- Reverts a previous commitstyle-- Code style (formatting, whitespace)Modifiers
!) -- This change breaks backward compatibilityChanges Made
packages/vig-utils/src/vig_utils/prepare_changelog.py— Addunprepare_changelog()andprepare-changelog unprepareCLI subcommand (rename first top-level## [semver] - …to## Unreleased).packages/vig-utils/tests/test_prepare_changelog.py— Unit tests, command-handler tests,main()and subprocess coverage forunprepare.assets/init-workspace.sh— After smoke-test rsyncs, copy.devcontainer/CHANGELOG.md→CHANGELOG.mdand runprepare-changelog unprepare(requiresprepare-changelogon PATH in the install image).assets/smoke-test/.github/workflows/repository-dispatch.yml— Remove inlineawk/sedremap; keep existence/readability checks for changelogs.CHANGELOG.md/assets/workspace/.devcontainer/CHANGELOG.md— Document the fix under the active release section.packages/vig-utils/README.md— Documentunpreparein the CLI list and examples.Diff vs
release/0.3.1: 7 files, +234 / −11 lines.Changelog Entry
Paste from
## [0.3.1] - TBD→### Fixed:Fixed
prepare-changelog unprepareto rename the top## [semver] - …heading to## Unreleasedinit-workspace.sh --smoke-testcopies.devcontainer/CHANGELOG.mdinto workspaceCHANGELOG.mdand runs unprepare; remove duplicate remap from smoke-test dispatch workflowTesting
just test)Manual Testing Details
N/A (not run in a full smoke-test dispatch; verify with next RC after promoting templates).
Checklist
docs/templates/, then runjust docs)CHANGELOG.mdunder the active## [0.3.1] - TBDsection (and pasted the entry above)Additional Notes
Target base branch:
release/0.3.1. After merge, promote updated smoke-test templates / tag an RC sovig-os/devcontainer-smoke-testpicks up the fix.Refs: #417