kcp icon indicating copy to clipboard operation
kcp copied to clipboard

Changelog for the kcp kubectl plugins?

Open johanneskastl opened this issue 11 months ago • 6 comments

Dear maintainers,

I started packaging the kcp-cli for openSUSE recently. During the last round of updates, I noticed that there are tags for the cli releases, but there seems to be no changelog explicitly for the CLI.

I found no hints in the commits (like tagging them with chore(cli) or similar), so I found it rather hard to check which changes were done in regards to the CLI.

Is there such a changelog and I simply missed it?

Kind Regards, Johannes

johanneskastl avatar Mar 18 '25 18:03 johanneskastl

Hi @johanneskastl, thanks so much for picking up kcp as a package to maintain!

We currently don't separate changelogs by components in the kcp-dev/kcp repository, but I understand the need you have. We could look at labelling PRs more clearly, which could help you generate a changelog more easily. For my understanding, when you say "kcp-cli", you mean the three kubectl plugins we distribute? Or are you packaging the kcp binary itself?

embik avatar Mar 21 '25 12:03 embik

Sorry, yes, I meant the tools intended to be used on a CLI, aka the kubectl plugins. I adjusted the issue title accordingly.

Other projects have commit messages containing the usual feat() or chore(), where they specify the component inside the brackets. Like feat(controller) or deps(cli) or similar. Not sure if that is feasible.

(And of course it is not always possible to distinguish, e.g. updating a dependency that is used in both controller and cli tools)

johanneskastl avatar Mar 21 '25 16:03 johanneskastl

We could look at applying the area/cli label (and perhaps the other areas as well) to PRs in the future. Would that help you?

embik avatar Mar 22 '25 16:03 embik

Is this label visible in the commit message? Because that is the easiest way to identify CLI-related things in e.g. the changelogs or the list of commits.

johanneskastl avatar Mar 23 '25 13:03 johanneskastl

Unfortunately not, no :-/ I'm looking at the automation we use for generating our release notes (https://github.com/kubernetes/release/tree/master/cmd/release-notes), but it doesn't seem to support a label filter either. Let me try to figure out if there is a way to do this.

embik avatar Mar 26 '25 08:03 embik

I've opened #3379 to automate the classification on our side. I'm contemplating to add label selector support in release-notes upstream, but timeline for that is a bit blurry, sorry!

embik avatar Apr 15 '25 15:04 embik