generate-changelog.sh script in meta-dts doesn't work correctly when used according to release process

[m-iwanicki]

Component

Dasharo Tools Suite

Device

other

Dasharo version

No response

Dasharo Tools Suite version

v2.1.0

Test case ID

No response

Brief summary

Script doesn't generate changelog for unreleased (before putting tag) changes

How reproducible

100%

How to reproduce

Follow https://docs.zarhus.com/development-process/standard-release-process/#process-steps

Expected behavior

Script generates changes for version either in dts-distro.conf or takes version from argument

Actual behavior

Script updates changelog for 2.1.0 instead

Screenshots

No response

Additional context

No response

Solutions you've tried

docker run -t -v "$PWD":/app/ "orhunp/git-cliff:${TAG:-latest}" \
    --prepend CHANGELOG.md --unreleased --tag 2.1.1

• manual fixes

@PLangowski

[PLangowski]

I suggest that we do the following:

• Create tag without pushing it
• Generate and commit changelog
• Change tag's position to the changelog commit
• push tag

The workflow above can be scripted.

[m-iwanicki]

It can't be scripted as pushing tag will start release workflow. Changelog needs to be reviewed before that and maybe manually changed.
I propose reading DTS_VER from distro.conf and then using --unreleased --tag $DTS_VER arguments.
That way there would be no need to change standard release process.

[PLangowski]

Dasharo/meta-dts#207
3mdeb/meta-rte#86
zarhus/meta-zarhus#48

[m-iwanicki]

There is still Dasharo/meta-dts#207 (review)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 4b0fa16a2d27..45c341d4c87b 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.

 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

+## [2.1.2] - 2024-12-18
+
+### Changed
+- .github/workflows/test.yml: Improve test workflow (#200)
+- scripts/generate-changelog.sh: Fix arguments
+- wip
+
+
 ## [2.1.1] - 2024-12-13

 ### Added

Doesn't create links:

$ tail -52 CHANGELOG.md | head -5
- Initial public release
- Fix README

[2.1.1]: https://github.com/Dasharo/meta-dts/compare/v2.1.0..v2.1.1
[2.1.0]: https://github.com/Dasharo/meta-dts/compare/v2.0.1-rc3..v2.1.0

Those would need to be added manually, by script (e.g. sed to insert after/before some line) or remove links completely.

[PLangowski]

The reason why the links aren't getting updated is that we're using the --prepend option. It prepends the change notes to the file, but doesn't modify the footer, where the links are located. If we want to update the links, we need to regenerate the whole changelog on every release. However, this would make it impossible to make any manual changes in the changelog in case we don't like some notes. Alternatively, we can just remove the links.

[m-iwanicki]

Or add them manually or in script:

PREV_DTS_VER="2.1.3"
CUR_DTS_VER="2.1.4"
# escape characters interpreted by sed e.g. "[1.2.3]:" -> "\[1\.2\.3\]:"
SED_MATCH=$(printf '%s\n' "[$PREV_DTS_VER]:" | sed -e 's/[]\/$*.^[]/\\&/g')
sed -i "\|^$SED_MATCH|i [$CUR_DTS_VER]: https://github.com/Dasharo/meta-dts/compare/v$PREV_DTS_VER..v$CUR_DTS_VER" CHANGELOG.md