Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
m-iwanicki opened this issue Dec 13, 2024 · 4 comments
Labels

Comments

@m-iwanicki
Copy link

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

@m-iwanicki m-iwanicki added bug Something isn't working needs review labels Dec 13, 2024
@PLangowski
Copy link

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
Copy link
Author

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
Copy link

@m-iwanicki
Copy link
Author

m-iwanicki commented Dec 18, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants