[refactor] Separate CHANGELOG files for each minor version by vankichi · Pull Request #3454 · vdaas/vald

vankichi · 2026-01-20T15:41:31Z

Description

I have updated the directory structure and release logic for divide CHANGELOG.

In my first commit, I have updated below:

create directory of CHANGELOG: such as release/v${major}-${minor}
add make command for update minor CHANGELOG
rename previous make command changelog/update to changelog/update/origin

I DO NOT apply yet:

What should we handle previous CHANGELOG? delete it or edit it?

@kpango @kmrmt @Matts966
Let me know how it handle and any feedback.

Related Issue

close #3103

Versions

Vald Version: v1.7.17
Go Version: v1.25.5
Rust Version: v1.92.0
Docker Version: v29.1.3
Kubernetes Version: v1.34.3
Helm Version: v4.0.4
NGT Version: v2.5.0
Faiss Version: v1.13.1

Checklist

I have read the CONTRIBUTING document and completed our CLA agreement.
I have checked open Pull Requests for the similar feature or fixes?

Special notes for your reviewer

Summary by CodeRabbit

Documentation
- Organized and indexed release notes across all versions with improved automated changelog generation and management.
Chores
- Enhanced release workflow automation for streamlined version tracking and release note processing.

coderabbitai · 2026-01-20T15:41:57Z

Caution

Review failed

Failed to post review comments

📝 Walkthrough

Walkthrough

This pull request implements versioned CHANGELOG management by dividing the monolithic changelog into version-specific files (CHANGELOG-X.Y.md), updates the release workflow to generate entries using the extracted RELEASE_TARGET_VERSION (major.minor), introduces a new README index for changelog navigation, and adds a template for generating changelog links.

Changes

Cohort / File(s)	Summary
Release Workflow & Build System `.github/workflows/_release-pr.yaml`, `Makefile`, `.gitfiles`	Removes intermediate changelog/next/print step from release workflow; introduces RELEASE_TARGET_VERSION variable to extract major.minor semantics from VALD_VERSION; reworks changelog/update target to use versioned changelog files and updates README index; adds changelog/readme/print phony target for generating README links; updates git manifest to track new changelog files.
Versioned Changelog Entries `CHANGELOG/CHANGELOG-0.0.md`, `CHANGELOG/CHANGELOG-1.0.md`, `CHANGELOG/CHANGELOG-1.1.md`, `CHANGELOG/CHANGELOG-1.2.md`, `CHANGELOG/CHANGELOG-1.3.md`, `CHANGELOG/CHANGELOG-1.4.md`, `CHANGELOG/CHANGELOG-1.5.md`, `CHANGELOG/CHANGELOG-1.6.md`, `CHANGELOG/CHANGELOG-1.7.md`	Adds comprehensive versioned changelog entries for multiple releases across each minor version, documenting Docker images, references (GoDoc, Helm), and categorized changes; preserves historical release data for each version track.
Changelog Documentation & Templates `CHANGELOG/README.md`, `hack/CHANGELOG-README.template.md`, `CHANGELOG.md`	Creates CHANGELOG/README.md index linking to all versioned changelogs in descending order; adds template file for generating markdown links to versioned changelogs.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~22 minutes

The changes introduce new build logic (RELEASE_TARGET_VERSION extraction, reworked changelog/update target) requiring verification against existing workflow semantics. The large volume of changelog additions are structurally consistent but demand verification that version extraction and file organization align with release cadence. Mixed complexity across automation logic and documentation requires separate reasoning paths.

Suggested labels

type/documentation

Suggested reviewers

kmrmt
kpango
Matts966

Poem

📚 Chaos tamed in versioned files,
Minor versions now arranged with style,
README guides the changelog way,
Release workflow cleaner each day. 🚀

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main refactoring effort: separating CHANGELOG files by minor version, which is the primary objective of this PR.
Linked Issues check	✅ Passed	The PR successfully implements the core coding objectives from `#3103`: dividing CHANGELOG by minor version, introducing per-minor-version changelog files (CHANGELOG-0.0.md through CHANGELOG-1.7.md), updating the Makefile with RELEASE_TARGET_VERSION logic, and integrating the new structure into the release workflow (.github/workflows/_release-pr.yaml).
Out of Scope Changes check	✅ Passed	All changes align with the stated objectives: CHANGELOG directory structure, new per-version markdown files, Makefile changelog/update logic refactoring, template files, and workflow updates. No unrelated modifications detected.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch refactor/docs/separate-changelog-each-minor-version

📝 Coding Plan

Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

vdaas-ci · 2026-01-20T15:42:10Z

[CHATOPS:HELP] ChatOps commands.

🙆‍♀️ /approve - approve
🍱 /format - format codes and add licenses
✅ /gen-test - generate test codes
🏷️ /label - add labels
🔚 2️⃣ 🔚 /label actions/e2e-deploy - run E2E deploy & integration test

coderabbitai

Actionable comments posted: 5

🤖 Fix all issues with AI agents

In @.github/workflows/_release-pr.yaml:
- Line 129: The workflow contains a typo: the command invocation "makr
changelog/update/minor BODY=\"$BODY\"" is invalid; replace "makr" with "make" so
the line reads "make changelog/update/minor BODY=\"$BODY\"" to ensure the
release job invokes the correct Make target.
- Around line 128-129: Fix the typo in the workflow by changing the `makr`
command to `make` for the `changelog/update/minor` invocation, and correct the
Makefile .PHONY declaration so the phony name matches the actual target: replace
the misspelled `chagenlog/update/minor` with `changelog/update/minor` so the
`.PHONY` entry exactly matches the `changelog/update/minor` target.

In `@Makefile`:
- Around line 1014-1023: Fix the typo in the phony declaration and make the
minor changelog header consistent: change ".PHONY: chagenlog/update/minor" to
".PHONY: changelog/update/minor" so the phony target matches the actual target
name, and update the header echo in the changelog/update/minor recipe (the line
that writes "# CHANGELOG $(VERSION_RELEASE_DIR).x" into
$(TEMP_DIR)/CHANGELOG.md) to use the same header level/format used by existing
changelog files (e.g., "## CHANGELOG $(VERSION_RELEASE_DIR).x") so the generated
file matches repository conventions.

In `@release/v1-1/CHANGELOG.md`:
- Around line 95-98: Fix spelling/grammar in the changelog lines: change "non
exsiting" to "non-existing" in the entry "bugfix remove api return wrong error
of non exsiting replicas (`#1318`)" (and rephrase to "Bugfix: remove API returned
wrong error for non-existing replicas"), change "alogrithm" to "algorithm" in
"Implement test for internal/core/alogrithm/ngt/option and refactor (`#1251`)" (to
"Implement test for internal/core/algorithm/ngt/option and refactor"), and
reword "fix build error due to e2e benchmark invalid creating new client
(`#1221`)" to correct grammar such as "Fix build error due to e2e benchmark
invalid creation of new client (`#1221`)"; also normalize capitalization
(capitalize "Bugfix"/"Fix"/"Implement"/"Update") and apply the same typo fixes
to the duplicate occurrences noted (lines 357-359).

In `@release/v1-5/CHANGELOG.md`:
- Around line 447-452: Update the three changelog bullets to correct spelling
and casing: change "helm operator" to "Helm operator" (or "Helm Operator" for
consistent title casing), fix "depentency" to "dependency" in the third bullet,
and normalize "security" / "Security" capitalization consistently (e.g., all
start with a capital letter). Apply the same corrections to the duplicate
entries at lines 629-632 so both sections match.

.github/workflows/_release-pr.yaml

Makefile

CHANGELOG/CHANGELOG-1.1.md

CHANGELOG/CHANGELOG-1.5.md

cloudflare-workers-and-pages · 2026-01-20T15:53:28Z

Deploying vald with Cloudflare Pages

Latest commit:	`9acaa68`
Status:	✅ Deploy successful!
Preview URL:	https://b68bf59f.vald.pages.dev
Branch Preview URL:	https://refactor-docs-separate-chang.vald.pages.dev

View logs

coderabbitai

Actionable comments posted: 5

🤖 Fix all issues with AI agents

In `@release/v1-0/CHANGELOG.md`:
- Line 547: Update the changelog entry that currently reads "change grpc
bidi-stream error handling and change grpc API interface" to remove the
redundant phrase "API interface" and use either "gRPC API" or "gRPC interface"
instead (e.g., "change gRPC bidi-stream error handling and change gRPC API" or
"change gRPC bidi-stream error handling and change gRPC interface") so the
wording is concise and consistent; locate the exact phrase "grpc API interface"
in the CHANGELOG.md and replace it accordingly.

In `@release/v1-2/CHANGELOG.md`:
- Line 69: The CHANGELOG entry contains a typo and malformed text: replace "fix
unlimited gorountine processing in kvsdb (`#1458`)" with a correctly spelled and
consistently formatted line such as "fix: unlimited goroutine processing in
kvsdb (`#1458`)" (or follow the repo's existing changelog casing/prefix style),
and apply the same correction to the other occurrences referenced (lines
matching the same phrase at the other locations). Locate the occurrences of that
exact phrase in CHANGELOG.md and update spelling ("goroutine") and formatting to
match other changelog entries.

In `@release/v1-4/CHANGELOG.md`:
- Line 136: Fix the two typos in the changelog by replacing the erroneous
tokens: change "minnum" to "min_num" in the entry that reads "Add agent minnum
field and support fp16" and change "Cellebration" to "Celebration" where that
token appears; update the exact strings in CHANGELOG.md so the corrected entries
read "Add agent min_num field and support fp16" and "Celebration" respectively.

In `@release/v1-6/CHANGELOG.md`:
- Line 305: Update the changelog entry that currently reads "- Fix failed github
workflow [`#1745`](https://github.com/vdaas/vald/pull/1745)" to capitalize
"GitHub" (i.e., change "github" to "GitHub") so the entry becomes "- Fix failed
GitHub workflow [`#1745`](https://github.com/vdaas/vald/pull/1745)"; locate the
exact string "- Fix failed github workflow
[`#1745`](https://github.com/vdaas/vald/pull/1745)" in CHANGELOG.md and edit it
accordingly.

In `@release/v1-7/CHANGELOG.md`:
- Around line 95-101: Fix the user-visible typos and capitalization
inconsistencies in the CHANGELOG entries: correct "despcription" to
"description" in the "[VALD-148] hotfix: Fix name & despcription of metrics"
line, standardize casing for section labels (e.g., change "hotfix" to "Hotfix"
or make all bracketed tags consistently capitalized like "[Bugfix]"), and ensure
the emoji/label line ":bug: Bugfix" and the "[BUGFIX] use client config for tls
dialer" entry have consistent capitalization (e.g., "[Bugfix] Use client config
for TLS dialer"); apply these same fixes to the other occurrences mentioned
(lines around 185-197 and 1328-1331) so all release note entries match the
corrected spelling and capitalization.

♻️ Duplicate comments (2)

Makefile (1)
1014-1020: Align minor changelog header with dotted version format.

The generated header currently becomes v1-7.x, but existing changelogs (e.g., release/v1-7/CHANGELOG.md) use v1.7.x.
🔧 Proposed fix
-	echo "# CHANGELOG $(VERSION_RELEASE_DIR).x" > $(TEMP_DIR)/CHANGELOG.md
+	echo "# CHANGELOG $(subst -,.,$(VERSION_RELEASE_DIR)).x" > $(TEMP_DIR)/CHANGELOG.md
release/v1-1/CHANGELOG.md (1)
95-98: Fix spelling/grammar in the changelog entries.
✏️ Proposed fix
- - bugfix remove api return wrong error of non exsiting replicas (`#1318`)
+ - Bugfix: remove API returning wrong error for non-existing replicas (`#1318`)
- - Implement test for internal/core/alogrithm/ngt/option and refactor (`#1251`)
+ - Implement test for internal/core/algorithm/ngt/option and refactor (`#1251`)
- - fix build error due to e2e benchmark invalid creating new client (`#1221`)
+ - Fix build error due to invalid e2e benchmark client creation (`#1221`)

- - Update Tutotial/Get-Started (`#1203`)
+ - Update Tutorial/Get-Started (`#1203`)
Also applies to: 357-359

CHANGELOG/CHANGELOG-1.0.md

CHANGELOG/CHANGELOG-1.2.md

CHANGELOG/CHANGELOG-1.4.md

CHANGELOG/CHANGELOG-1.6.md

CHANGELOG/CHANGELOG-1.7.md

kpango · 2026-01-21T05:16:41Z

Can you modify your approach to align with this pattern?
https://github.com/kubernetes/kubernetes/tree/master/CHANGELOG

And you can remove current CHANGELOG.md and create CHANGELOG directory

Additionally, in accordance with the two-branch workflow, please ensure that the changelog for the minor version is updated whenever changes are made to the release branch.

Signed-off-by: vankichi <kyukawa315@gmail.com>

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

[LanguageTool] _{reported by reviewdog 🐶}
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION

vald/CHANGELOG/CHANGELOG-1.6.md

Line 72 in 4ea48bc

- Fix dead link [#1807](https://github.com/vdaas/vald/pull/1807)

[LanguageTool] _{reported by reviewdog 🐶}
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION

vald/CHANGELOG/CHANGELOG-1.6.md

Line 144 in 4ea48bc

    
           - Fix string concat buffer overflow [#1806](https://github.com/vdaas/vald/pull/1806)

[LanguageTool] _{reported by reviewdog 🐶}
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION

vald/CHANGELOG/CHANGELOG-1.6.md

Line 220 in 4ea48bc

- fix metrics bug [#1800](https://github.com/vdaas/vald/pull/1800)

[LanguageTool] _{reported by reviewdog 🐶}
The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: GitHub
URL: https://en.wikipedia.org/wiki/GitHub
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING

vald/CHANGELOG/CHANGELOG-1.6.md

Line 304 in 4ea48bc

- Fix fossa workflow bug [#1787](https://github.com/vdaas/vald/pull/1787)

[LanguageTool] _{reported by reviewdog 🐶}
Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION

Conversation

vankichi commented Jan 20, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issue

Versions

Checklist

Special notes for your reviewer

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jan 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Estimated code review effort

Suggested labels

Suggested reviewers

Poem

Uh oh!

vdaas-ci commented Jan 20, 2026

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cloudflare-workers-and-pages bot commented Jan 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying vald with Cloudflare Pages

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kpango commented Jan 21, 2026

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

vankichi commented Jan 20, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 20, 2026 •

edited

Loading

cloudflare-workers-and-pages bot commented Jan 20, 2026 •

edited

Loading