Generate changelog for patch releases #18342
Conversation
Add some more steps to automate the changelog generation for patch releases, using the zcl cli tool. Currently restricted to patch releases as it is the easiest to automate (less edge cases) and the most repetitive work to do on a release
There was a problem hiding this comment.
🎉 I think the only possible improvement would be using the GH CLI to download zcl: https://cli.github.com/manual/gh_release_download
Other than that, looks good :)
In order to generate the changelog we also need to have access to the tags
Instead of using wget we use built-in gh cli to download release assets
Set some bash options to print commands, etc.
To extract the patch version, we need to use the right regex without escaping the star
In order to post variable that is a multiline string we have to use a different way to add it to the output
|
Hey @oleschoenburg @npepinpe would be great if someone could take a look at this again. If you are fine with it I would forward this change to the other branches :) You can see examples of this running here https://github.com/camunda/zeebe/actions/workflows/camunda-platform-release-manual.yml?query=branch%3AZelldon-patch-1 I hope you like it :) |
|
@oleschoenburg @npepinpe or @korthout someone has time to review it? As it would reduce the effort for patch releases :) |
| - uses: actions/checkout@v4 | ||
| with: | ||
| ref: ${{ env.RELEASE_BRANCH }} | ||
| fetch-depth: 0 # To fetch tags as well - necessary for the changelog generation |
There was a problem hiding this comment.
🔧 This is a costly checkout for us (with almost 40k commits on main alone). We could try using fetchTags: true instead. Just an optimization though.
There was a problem hiding this comment.
Tha KS for the proposal. In general it makes sense.
But I don't think that it works as it expected with the proposed solution actions/checkout#1471
I would keep it for now like it is. I think the impact it also quite small as we don't run this workflow so often.
Feel free to improve on a later stage of course 👍
Zelldon
added
backport main
|
Successfully created backport PR for |
|
Successfully created backport PR for |
|
Successfully created backport PR for |
|
Successfully created backport PR for |
Description
Note
That is a proposal to extend our release workflow and add the changelog generation,
at least for the patch releases.
This PR adds some more steps to the Github release job, to automate the changelog generation for patch releases, using the zcl cli tool.
Currently restricted to patch releases as it is the easiest to automate (less edge cases) and the most repetitive work to do on a release
Related issues
See related thread https://camunda.slack.com/archives/C05DH1F5TAR/p1715098083616309