chore(ci): add git-cliff changelog generation#72
Conversation
Signed-off-by: Raghul-M <raghul.m1430@gmail.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
🎉 Welcome to the Kubeflow MCP Server! 🎉 Thanks for opening your first PR! We're happy to have you as part of our community 🚀 Here's what happens next:
Join the community:
Feel free to ask questions in the comments if you need any help or clarification! |
There was a problem hiding this comment.
Pull request overview
Adds git-cliff-based changelog generation for per-minor release series.
Changes:
- Adds conventional commit grouping and GitHub links.
- Adds a Docker-backed
make changelogtarget. - Initializes the
0.1.xchangelog.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
Makefile |
Adds changelog generation target. |
cliff.toml |
Configures changelog formatting and commit groups. |
CHANGELOG/CHANGELOG-0.1.md |
Initializes the 0.1 series changelog. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| if [ -f "$$CHANGELOG_PATH" ]; then \ | ||
| $$CLIFF_CMD --prepend "$$CHANGELOG_PATH"; \ | ||
| else \ | ||
| $$CLIFF_CMD -o "$$CHANGELOG_PATH"; \ | ||
| fi; \ |
| if [ -n "$(GITHUB_TOKEN)" ]; then \ | ||
| CLIFF_CMD="$$CLIFF_CMD -e GITHUB_TOKEN=$(GITHUB_TOKEN)"; \ |
| if [ -n "$(GITHUB_TOKEN)" ]; then \ | ||
| CLIFF_CMD="$$CLIFF_CMD -e GITHUB_TOKEN=$(GITHUB_TOKEN)"; \ | ||
| fi; \ | ||
| CLIFF_CMD="$$CLIFF_CMD -w /app ghcr.io/orhun/git-cliff/git-cliff:latest --unreleased --tag $(VERSION)"; \ |
There was a problem hiding this comment.
Thanks @Raghul-M, cliff.toml looks good and matches kubeflow/sdk !
One bug I see .. before /lgtm: CHANGELOG/CHANGELOG-0.1.md already exists as a stub, so the first 'make changelog VERSION=0.1.0' always hits '--prepend' and puts the generated release above the '# Changelog' intro. Either drop the stub and let -o create the file, or treat “no release heading yet” as a create/overwrite path.
@Krishna-kg732 Can you please confirm this fix fits with existing release cadence workflow ?
There was a problem hiding this comment.
@abhijeet-dhumal Dropped the stub CHANGELOG/CHANGELOG-0.1.md so the first run can create the file with -o. Makefile now prepends only when a real release heading (# [X.Y.Z]) is already present; otherwise it overwrites/creates with -o. That covers stubs, empty files, and a missing path.
|
/ok-to-test |
Signed-off-by: Raghul-M <raghul.m1430@gmail.com>
Signed-off-by: RAGHUL M <raghul.m1430@gmail.com>
Co-authored-by: Abhijeet Dhumal <84722973+abhijeet-dhumal@users.noreply.github.com> Signed-off-by: RAGHUL M <ragm@redhat.com>
Description
Add automated changelog generation with git-cliff, following the kubeflow/sdk pattern:
cliff.tomlconfigured forkubeflow/mcp-serverwith conventional commit groups (feat/fix/chore/revert)CHANGELOG/with per-minor series files (CHANGELOG-0.1.mdfor the current0.1.xline)make changelog VERSION=X.Y.Zto generate or prepend changelog entries via the git-cliff Docker imageFull release-workflow / on-tag automation remains tracked in #16.
Related Issue
Fixes #59
Checklist
make test-python)make verify)git commit -s)Testing
Verified
make helpexposes thechangelogtarget. Changelog generation can be exercised with:make changelog VERSION=0.1.0 # optional: GITHUB_TOKEN=... make changelog VERSION=0.1.0