Skip to content

fix(module): include per-version changelog in release image#2674

Merged
universal-itengineer merged 1 commit into
mainfrom
fix/module/changelog-in-release-image
Jul 16, 2026
Merged

fix(module): include per-version changelog in release image#2674
universal-itengineer merged 1 commit into
mainfrom
fix/module/changelog-in-release-image

Conversation

@universal-itengineer

@universal-itengineer universal-itengineer commented Jul 14, 2026

Copy link
Copy Markdown
Member

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.

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.json and module.yaml. Reported for v1.9.1, but it affected every release.

What is the expected result?

After a release build, the release:<tag> image contains changelog.yaml with 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>.yml into 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):

core:
  fixes:
    - summary: Update VMOP migration elapsed time every ten seconds while migration is in progress.
      pull_request: https://github.com/deckhouse/virtualization/pull/2495
vd:
  fixes:
    - summary: Fixed cancellation of virtual disk storage class changes and cancellation of local disk migration.
      pull_request: https://github.com/deckhouse/virtualization/pull/2502

Generated changelog.yaml shipped in release:v1.9.1 (rendered by the console):

fixes:
  Core:
    - Update VMOP migration elapsed time every ten seconds while migration is in progress. ([#2495](https://github.com/deckhouse/virtualization/pull/2495))
    - Select VirtualDisk migration target PVC strictly to avoid using an unrelated PVC. ([#2493](https://github.com/deckhouse/virtualization/pull/2493))
    - Fix metadata patch failing with "the server rejected our request" for objects without finalizers, labels or annotations. ([#2479](https://github.com/deckhouse/virtualization/pull/2479))
  Virtual disks:
    - Fixed cancellation of virtual disk storage class changes and cancellation of local disk migration. ([#2502](https://github.com/deckhouse/virtualization/pull/2502))
  Virtual machines:
    - Fixed an issue that prevented a VM from starting after a failed migration of a disk on local storage. ([#2509](https://github.com/deckhouse/virtualization/pull/2509))
    - Fixed live migration of VMs with disks on local storage attached via VirtualMachineBlockDeviceAttachment (hotplug). The target node no longer matches the source node. ([#2508](https://github.com/deckhouse/virtualization/pull/2508))
    - Fixed a false reboot requirement for VMs with only the Main network after upgrading to v1.9.1. Such VMs now do not receive the RestartRequired status if their configuration has not actually changed. ([#2475](https://github.com/deckhouse/virtualization/pull/2475))

Checklist

  • The code is covered by unit tests.
  • e2e tests passed.
  • Documentation updated according to the changes.
  • Changes were tested in the Kubernetes cluster manually.

Changelog entries

section: module
type: fix
summary: The module changelog is now shown in the Deckhouse console for each release.

@universal-itengineer universal-itengineer added this to the v1.11.0 milestone Jul 14, 2026
@universal-itengineer universal-itengineer force-pushed the fix/module/changelog-in-release-image branch 2 times, most recently from a6795d2 to df77995 Compare July 14, 2026 16:27
@universal-itengineer universal-itengineer force-pushed the fix/module/changelog-in-release-image branch 2 times, most recently from 26122bf to 415c1f3 Compare July 15, 2026 17:16
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>
@universal-itengineer universal-itengineer force-pushed the fix/module/changelog-in-release-image branch from 415c1f3 to c5caf92 Compare July 15, 2026 17:31
@universal-itengineer universal-itengineer merged commit 7aaf182 into main Jul 16, 2026
31 of 34 checks passed
@universal-itengineer universal-itengineer deleted the fix/module/changelog-in-release-image branch July 16, 2026 07:24
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants