fix(ci): smoke-test deploy uses workspace changelog scaffold#415
Merged
c-vigo merged 3 commits intorelease/0.3.1from Mar 23, 2026
Merged
fix(ci): smoke-test deploy uses workspace changelog scaffold#415c-vigo merged 3 commits intorelease/0.3.1from
c-vigo merged 3 commits intorelease/0.3.1from
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the smoke-test repository-dispatch deploy workflow so it preserves the workspace-generated CHANGELOG.md scaffold (instead of overwriting it with a minimal stub), while still ensuring downstream prepare-release changelog validation succeeds across release cycles.
Changes:
- Adjust deploy workflow logic to require an existing readable root
CHANGELOG.md, optionally remap a leading## [X.Y.Z] - …header to## Unreleased, and inject the deploy bullet under### Changed. - Document the fix in the root
CHANGELOG.md. - Mirror the same changelog entry into the workspace template’s
.devcontainer/CHANGELOG.md.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
assets/smoke-test/.github/workflows/repository-dispatch.yml |
Stop generating a stub changelog; validate/remap/inject into the existing scaffold. |
CHANGELOG.md |
Adds a “Fixed” entry describing the smoke-test deploy changelog behavior change. |
assets/workspace/.devcontainer/CHANGELOG.md |
Mirrors the same changelog entry for the template-synced devcontainer changelog. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Extend NEEDS_CHOWN when root CHANGELOG.md exists but is unreadable. Inject deploy line only after the first ### Changed via GNU sed range. Update BATS regression for workspace changelog scaffold. Refs: #403
Smoke-test deploy keeps the workspace scaffold only; remap top version header when needed for prepare-release. Sync changelog copy and BATS. Refs: #403
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
💡 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
repository-dispatchdeploy job no longer replaces rootCHANGELOG.mdwith a minimal stub. It keeps the scaffold produced byinit-workspace, injects the deploy bullet under the first### Changed, and remaps a leading## [X.Y.Z] - …(TBD or release date) to## Unreleasedwhen needed so downstreamprepare-releasevalidation succeeds across RC and final cycles.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
assets/smoke-test/.github/workflows/repository-dispatch.ymlCHANGELOG.mdafter install (workspace scaffold).##section: if## Unreleased, leave as-is; if## [version] - …, rewrite first such line to## Unreleasedvia GNUsed.- Deploy devcontainer ${TAG}after the first### Changedline.CHANGELOG.mdandassets/workspace/.devcontainer/CHANGELOG.md## [0.3.1] - TBD→ Fixed (issue [BUG] Downstream smoke-test CHANGELOG diverges from workspace scaffold after release cycle #403).Changelog Entry
This branch uses the active release section
## [0.3.1] - TBD(not## Unreleased). Entry added under Fixed:Fixed
CHANGELOG.mdwith a minimal stub inassets/smoke-test/.github/workflows/repository-dispatch.yml## Unreleasedscaffold frominit-workspaceso downstreamprepare-releasevalidation matches shipped workspace layout## [X.Y.Z] - …(TBD or a release date), remap that top version header to## Unreleasedbefore injecting the deploy entry so downstreamprepare-releasecan runTesting
just test)Manual Testing Details
N/A — workflow shell logic only; validated
sedremap behavior locally for dated and TBD headers.Checklist
docs/templates/, then runjust docs)CHANGELOG.mdin the[Unreleased]section (and pasted the entry above)Additional Notes
prepare-releaseexpects## Unreleasedwith at least one-entry; remapping supports post-releaseCHANGELOGlayouts where the top section is still a version header.release/0.3.1: Changelog entry is under## [0.3.1] - TBD→ Fixed, matching the release branch.Refs: #403