Repository navigation
HYG-09: CHANGELOG.md is a stale, cross-repo-copied shared file [go part] #116
Description
Split from LeanerCloud/cloud-commitments-cli#1178 (cross-component issue, monorepo split)
Evidence: Newest release is 0.9.0 (2026-03-06); the Unreleased section lists four minor
fixes while ~1400 commits landed since, including major features.Impact: Users and operators cannot determine what changed since 0.9.0; the sparse Unreleased
section gives a false impression of low activity.Recommendation: Backfill from merged PR titles and cut a release, or drop the CHANGELOG in
favor of GitHub releases.
Repo-specific verification (2026-09-27)
The literal "~1400 commits since 0.9.0" count no longer means anything post-split (this repo has
its own fresh git history from the split point), but the underlying problem survived the split
rather than being resolved by it:
- No repo has cut a release since the split --
gh release listandgh api .../tagsare both
empty forcloud-commitments-go(onlycloud-commitments-clicarries amonorepo-finaltag
marking the split boundary). 0.9.0 (2026-03-06) is still the last real release, six-plus months
stale. CHANGELOG.mdin this repo is byte-for-byte identical to the one incloud-commitments-mcp
andcloud-commitments-platform-- it was copied verbatim to all three repos, not adapted.
Its "Fixed" section under Unreleased includes "Remove debug console.log from frontend
recommendation handler", which describes afrontend/change -- but this repo
(cloud-commitments-go) has nofrontend/directory; that change belongs to
cloud-commitments-platform. The same misattribution repeats for other repo-specific entries.
So this repo's CHANGELOG both understates what changed (pre-split staleness, unresolved) and
misattributes what it does list (post-split copy-paste, a new problem the split introduced).
Acceptance criteria
-
CHANGELOG.mdincloud-commitments-gocontains only entries relevant to this repo's own
code (pkg/,providers/), not copy-pasted entries from other repos. - Either backfill and cut a release, or replace the curated CHANGELOG with a pointer to
GitHub Releases -- team's call on which is cheaper to maintain going forward.
Activity
cristim commentedon Oct 17, 2026
Decision needed (one line): backfill CHANGELOG.md and cut a release, or replace it with a pointer to GitHub Releases? Safe default: the pointer, dropping the entries copied from other repos. Open PRs #441 and #493 also edit CHANGELOG.md, so this lands after them. Marking
status/needs-info.cristim commentedon Nov 12, 2026
Plan for the go part (owner decision: simplest scope). Branch
chore/116-changelog, one commit,CHANGELOG.mdonly.Challenge: still present on origin/main (fetched this session). Evidence at origin/main
CHANGELOG.md:recTotalCommitment). Drop the sentence, keep the in-repo consumer note.frontend/here.Changes
cloud-commitments-go(pkg,providers/aws/azure/gcp,ci_cd_sanity_tests, this repo's scripts and CI). CUDly platform, frontend, MCP server and CLI changes live in their own repos.recTotalCommitmentsentence; keep the in-repopkg/reporterandpkg/common/audit.gonote.pkg/,providers/or go-module code. Drop CLI, platform, frontend, Terraform, Docker and product bullets, and drop headings left empty. The dropped text stays in this file's git history.Proof
grep -n -i -E 'frontend|console\.log|terraform|cloudformation|cudly|lambda|docker|dashboard|cmd/cudly'on the result: only deliberate hits remain (each listed in the review).markdownlint CHANGELOG.mdwith the repo's.markdownlint.yamlpasses (pre-commit hook; the repo has no changelog check script).docs(changelog): state which module the changelog covers and flag cop…
cristim commentedon Nov 12, 2026
Decision (go part, additive scope): deleting the copied content needs an owner confirmation, so this change deletes nothing. Commit 49995de changes
CHANGELOG.mdonly (+4/-1):cloud-commitments-gomodule (pkg/,providers/,ci_cd_sanity_tests/).console.logfix, the README badge entry and the 0.3.0 to 0.9.0 releases. They are kept for history.Not done, so this issue stays open: the copied entries are still in the file, and the other repos are untouched. Removing them is the remaining step if the owner confirms the deletion. Also noticed, not changed: stale line numbers in the Azure Consumption units entry (
pkg/reporter/reporter.golines 44 and 96, now 50 and 103), and the ladder buffer-layer Fixed entry appears twice.Checks: markdownlint and the pre-commit and CI workflows on 49995de passed (jobs ran real steps). Two review passes by one independent reviewer: approve, no blocking findings.
cristim commentedon Nov 13, 2026
Landed in 2e15fd5: removed the copied federation IaC notices, frontend console.log and README badge entries, and the pre-split 0.3.0 to 0.9.0 releases, and added a pointer to cloud-commitments-cli for pre-split history. Chose pruning over a backfilled release as the cheaper option to maintain.