Skip to content

Give the KiteModels changelog the same headers as the other OpenSourceAWE packages - #329

Closed
1-Bort-1 wants to merge 5 commits into
mainfrom
agent/328-bring-kitemodels-changelog-to-the-releas
Closed

1-Bort-1 wants to merge 5 commits into
mainfrom
agent/328-bring-kitemodels-changelog-to-the-releas

Conversation

@1-Bort-1

@1-Bort-1 1-Bort-1 commented Oct 6, 2026 •

Copy link
Copy Markdown
Member

We want one changelog format across the OpenSourceAWE packages, so this gives KiteModels the same release and section headers as the others. Each release is now a level-two header with the date written day-month-year, and its Added, Changed and Fixed sections sit one level below it. Only header lines change; every note reads as before.

The repo's own release script read the old header level, so it now reads the new one. Without that change it would take the first section header for the latest release.

The citation file keeps its ISO release date, because the citation format requires it.

A few old releases keep their irregular shape: v0.6.9, v0.6.10 and v0.6.15 list notes with no section, and v0.11.0, v0.11.1 and v0.11.4 order their sections differently. Fixing either would mean moving note text.

#321 adds a changelog section at the old level. Whichever of the two merges second has to write it one level up.

Verification

  • Reproduced first: the shared release check on main refused with CHANGELOG top is (expected v0.11.17)
  • git diff -U0 CHANGELOG.md changes header lines only
  • Both release checks, shared and in-repo, exited 0 with Version: v0.11.17 on e19aef1
  • test/test-kps4.jl: 213 passed, 11 broken · test/test-steady-state-robustness.jl: 54 passed (Julia 1.13.0)
  • Local full suite on 98e8e71: PASS (one matrix cell) · GitHub CI on 82e3558: PASS
  • Risk: Build SysState with the KiteUtils 0.12 constructor and one-slot winch fields #321's section header lands at the wrong level if it merges after this.

Opened by 1-Bort-1, an AI agent working for @1-Bart-1.
Closes #328 · task KiteModels.jl-328

Release headers become '## KiteModels vX.Y.Z YYYY-MM-DD' (the dash on the
0.5.6-0.6.8 headers dropped), section headers '### Added/Changed/Fixed'
('#### Changes' read as Changed). Note text is untouched. bin/release reads
the top '## ' section accordingly.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@1-Bort-1 1-Bort-1 added agent:running Agent task state agent:ci Agent task state and removed agent:running Agent task state labels Oct 6, 2026

@1-Bort-1 1-Bort-1 left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Independent review (advisory)

Verdict: APPROVE · 0 inline, 0 off the diff

Good

  • Every one of the 147 headers in CHANGELOG.md now has the target form: an anchored rg for ^## KiteModels vX.Y.Z YYYY-MM-DD$ or ^### (Added|Changed|Fixed)$ matches all 147 lines that start with #, and 55 + 89 + 3 = 147 agrees with the card's counts
  • The diff only touches header lines; reading every hunk confirms the note text is unchanged, as the card says
  • The bin/release edit is the minimal one the card names: two awk patterns and two messages; a read of the whole script turned up no other ### dependency
  • The rename from #### Changes to ### Changed under v0.11.7 is listed in the card, so the one text change in a header is not hidden
  • The changelog still passes .markdownlint.json: MD024 is siblings_only and MD041 is off, so repeated ### Added under different releases and the missing H1 are both allowed
  • Leaving out an empty ## Unreleased section is right, because bin/release would otherwise read Unreleased as the top version
  • The card points out the coming conflict with #321/#312 and says their notes belong in changelog.d/; that is the right place for that decision

Not good

  • v0.6.15, v0.6.10 and v0.6.9 still have notes sitting directly under the release header with no ### Added/Changed/Fixed section; this is harmless for bin/release, but the changelog is not fully on the one convention the card describes
  • v0.11.4, v0.11.1 and v0.11.0 list their sections as Changed/Fixed/Added instead of Added/Changed/Fixed; leaving that alone is fine for a headers-only PR, but the card could have said so
  • The card says Julia tests were not run and GitHub CI is pending; that is acceptable because no .jl file changed, but CI should be green before merge

claude, rubric CLEAN_CODE.md. A different lab from the implementer
on purpose: a reviewer sharing its blind spots would not flag its mistakes.

@1-Bort-1 1-Bort-1 added agent:queued Agent task state agent:running Agent task state and removed agent:ci Agent task state agent:queued Agent task state labels Oct 6, 2026
@1-Bort-1 1-Bort-1 added agent:ci Agent task state agent:queued Agent task state agent:running Agent task state and removed agent:running Agent task state agent:ci Agent task state agent:queued Agent task state labels Oct 6, 2026
@1-Bort-1
1-Bort-1 marked this pull request as ready for review October 6, 2026 12:24
@1-Bort-1 1-Bort-1 added agent:review Agent task state and removed agent:ci Agent task state labels Oct 6, 2026
@1-Bort-1
1-Bort-1 requested a review from 1-Bart-1 October 6, 2026 12:25
@1-Bort-1

1-Bort-1 commented Oct 9, 2026

Copy link
Copy Markdown
Member Author

From Agents-635 (1-Bart-1/Agents#635)

Per 1-Bart-1/Agents#635: since 1-Bart-1/Agents#634 the release bump writes headers as ## <Package> vX.Y.Z DD-MM-YYYY. Please switch every release header this branch writes from ISO YYYY-MM-DD to DD-MM-YYYY (e.g. 2026-09-28 → 28-09-2026), and rewrite the title and description to match. Keep date-released in CITATION.cff ISO, as the CFF schema requires.

@1-Bort-1 1-Bort-1 added agent:queued Agent task state and removed agent:review Agent task state agent:queued Agent task state labels Oct 9, 2026
@1-Bort-1 1-Bort-1 added agent:ci Agent task state agent:review Agent task state agent:queued Agent task state agent:running Agent task state and removed agent:ci Agent task state agent:review Agent task state agent:queued Agent task state agent:running Agent task state labels Oct 9, 2026
@1-Bort-1

Copy link
Copy Markdown
Member Author

Local full suite: PASS (1 min, Julia 1.13.0, one cell of the matrix)

@1-Bort-1 1-Bort-1 added agent:ci Agent task state agent:queued Agent task state and removed agent:running Agent task state agent:ci Agent task state labels Oct 10, 2026
@1-Bort-1

Copy link
Copy Markdown
Member Author

@1-Bort-1 1-Bort-1 added agent:waiting-human Agent task state agent:running Agent task state and removed agent:queued Agent task state agent:waiting-human Agent task state labels Oct 10, 2026
@ufechner7

Copy link
Copy Markdown
Member

Please stop with these pull requests!

@ufechner7 ufechner7 closed this Oct 10, 2026
@1-Bart-1 1-Bart-1 changed the title Head CHANGELOG.md releases with ## and sections with ###, and point bin/release at ## Give the KiteModels changelog the same headers as the other OpenSourceAWE packages Oct 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

agent:running Agent task state

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bring KiteModels' changelog to the release convention

2 participants