fix(module): include per-version changelog in release image#2674
Merged
Conversation
a6795d2 to
df77995
Compare
26122bf to
415c1f3
Compare
The Deckhouse console reads a module's per-release changelog from
changelog.yaml inside the release:<tag> image. The release image only
shipped version.json and module.yaml, so no changelog was available for
any virtualization release (e.g. v1.9.1).
In prepare-bundle, build changelog.yaml from CHANGELOG/CHANGELOG-<tag>.yml
with yq: reshape the per-section {summary, pull_request} entries into
features/fixes/chore -> readable category -> markdown strings (PR linked),
the unified format the console renders. Empty types/categories are pruned so
releases that only touch one type (e.g. fixes) render cleanly. Import the
single file into the release image and drop the CHANGELOG directory.
Signed-off-by: Nikita Korolev <nikita.korolev@flant.com>
415c1f3 to
c5caf92
Compare
nevermarine
approved these changes
Jul 16, 2026
deckhouse-BOaTswain
pushed a commit
that referenced
this pull request
Jul 16, 2026
Description The Deckhouse console showed no changelog for any virtualization module release: the changelog it renders is read from a changelog.yaml file inside the release image, and that file was never packaged into the image. The release image now carries the per-version changelog, so it shows up in the console's release list. -------------- Signed-off-by: Nikita Korolev <nikita.korolev@flant.com>
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
The Deckhouse console showed no changelog for any virtualization module release: the changelog it renders is read from a
changelog.yamlfile inside the release image, and that file was never packaged into the image. The release image now carries the per-version changelog, so it shows up in the console's release list.Why do we need it, and what problem does it solve?
Users open a module release in the console (Updates → Releases → Changelog) to see what changed between versions. For virtualization that panel was always empty — the release image only shipped
version.jsonandmodule.yaml. Reported for v1.9.1, but it affected every release.What is the expected result?
After a release build, the
release:<tag>image containschangelog.yamlwith the entry for that version, and the console shows the changelog for each release instead of an empty panel.Example
The build reshapes
CHANGELOG/CHANGELOG-<tag>.ymlinto the unified console format (features/fixes/chore→ readable category → entries, with the PR linked). Empty types/categories are dropped, so a release that only touches one type renders cleanly.Source —
CHANGELOG/CHANGELOG-v1.9.1.yml(excerpt):Generated
changelog.yamlshipped inrelease:v1.9.1(rendered by the console):Checklist
Changelog entries