Repository navigation
add a changelog to every component - #296
Conversation
Every component under src/ except webui and ReGaHss gets a CHANGELOG.md in the format of the rfd and hs485d changelogs, with the changes since OpenCCU-Base 3.89.11 and the earlier version history where there is one. devicetypes and hmipserver have no version of their own; their entries get the OpenCCU-Base release. AGENTS.md: every pull request adds its user-visible changes under "Unreleased" to the changelog of each component it changes; library changes go into the library's changelog only.
|
| Layer / File(s) | Summary |
|---|---|
Changelog scope and history boundaries AGENTS.md, README.md, src/ReGaHss/README.md, src/rfd/CHANGELOG.md, src/hs485d/CHANGELOG.md |
Updates changelog guidance for components under src/, clarifies the ReGaHss changelog filename, and defines which library changes appear in the rfd and hs485d histories. |
Tool and daemon release records src/SetInterfaceClock/CHANGELOG.md, src/bcm2835_raw_uart/CHANGELOG.md, src/crypttool/CHANGELOG.md, src/eq3_char_loop/CHANGELOG.md, src/eq3configcmd/CHANGELOG.md, src/eq3configd/CHANGELOG.md, src/hmipserver/CHANGELOG.md, src/hs485dLoader/CHANGELOG.md, src/hss_led/CHANGELOG.md, src/multimacd/CHANGELOG.md, src/ssdpd/CHANGELOG.md |
Adds changelogs that record release conventions, version details, and selected changes for these components. |
Device and extension histories src/devicetypes/CHANGELOG.md, src/tcl_homematic/CHANGELOG.md, src/tclrega/CHANGELOG.md, src/tclrpc/CHANGELOG.md |
Adds changelog entries for device-description changes and Tcl component release history. |
Library release records src/libLanDeviceUtils/CHANGELOG.md, src/libUnifiedLanComm/CHANGELOG.md, src/libXmlRpc/CHANGELOG.md, src/libelvutils/CHANGELOG.md, src/libeq3config/CHANGELOG.md, src/libhsscomm/CHANGELOG.md, src/libxmlparser/CHANGELOG.md |
Adds library changelogs with release conventions and entries describing selected changes. |
Estimated code review effort: 2 (Simple) | ~12 minutes
Change: Other
Possibly related PRs
- OpenCCU/OpenCCU-Base#280: Adds the repository guidance updated in this pull request.
- OpenCCU/OpenCCU-Base#294: Adds component versions and version output documented in these changelogs.
- OpenCCU/OpenCCU-Base#221: Changes device temperature limits recorded in the
devicetypeschangelog.
Suggested reviewers: cn-eq3
Merge Risk: 
Low · up to c3c35
-
The PR is broadly mergeable, but the ReGaHss filename references and component changelog guidance should be corrected to avoid misleading contributors and users.
Pre-merge checks: 
4
Finishing Touches
-
Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
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.
|
@coderabbitai review |
Action performed
|
ReGaHss converts its ChangeLog to a CHANGELOG.md in the format of the component changelogs; its next release replaces src/ReGaHss/ChangeLog with src/ReGaHss/CHANGELOG.md. ReGaHss is therefore no exception to the component changelogs anymore, but its changelog is still not edited here.
|
@coderabbitai Thanks for the review. Both points describe the state after the next ReGaHss release, which replaces |
|
Tip For best results, initiate chat on the files or code changes. Analysis chain
You are interacting with an AI system. |
|
Tip For best results, initiate chat on the files or code changes. Analysis chain
You are interacting with an AI system. |
* add a changelog to every component Every component under src/ except webui and ReGaHss gets a CHANGELOG.md in the format of the rfd and hs485d changelogs, with the changes since OpenCCU-Base 3.89.11 and the earlier version history where there is one. devicetypes and hmipserver have no version of their own; their entries get the OpenCCU-Base release. AGENTS.md: every pull request adds its user-visible changes under "Unreleased" to the changelog of each component it changes; library changes go into the library's changelog only. * ReGaHss: refer to its CHANGELOG.md ReGaHss converts its ChangeLog to a CHANGELOG.md in the format of the component changelogs; its next release replaces src/ReGaHss/ChangeLog with src/ReGaHss/CHANGELOG.md. ReGaHss is therefore no exception to the component changelogs anymore, but its changelog is still not edited here. Upstream-Commit: OpenCCU/OpenCCU-Base@2047961dd7 OpenCCU@2047961
Follow-up to #291 and #294: every component under
src/exceptwebui(separate pull request) and the closed-sourceReGaHss(its changelog comes with the binaries, see below) gets aCHANGELOG.mdin the format of the rfd and hs485d changelogs. The entries cover the changes since OpenCCU-Base 3.89.11, plus the earlier version history where there is one; older changes refer to the git history. These files are meant to feed the release notes of OpenCCU-Base and OpenCCU later.New changelogs
1.0.0 (2026-11-02), the first version from #294, with the changes since 3.89.112.3.0 (2026-11-02): #59, #203, #285, #294Unreleased: #271, #281, #285, #294Unreleased: #294Unreleased:-v/--version(#294)Unreleased:RemoveConfigPage(#48)Unreleased: SET_TEMPERATURE limits (#221), CFM-TW long-press register (#63)Unreleased: HMIPServer.jar build 5936 of 2026-10-08 from eQ-3devicetypes and hmipserver have no version of their own; their
Unreleasedheading gets the OpenCCU-Base release.ReGaHss
ReGaHss converts its
ChangeLogto aCHANGELOG.mdin the same format (OpenCCU/ReGaHss#42); its next release replacessrc/ReGaHss/ChangeLoghere withsrc/ReGaHss/CHANGELOG.mdthrough the ReGaHss Release workflow.AGENTS.md,README.mdandsrc/ReGaHss/README.mdrefer to it accordingly (ChangeLogup to R1.00.0388.0267). It is still not edited here.AGENTS.md
"Daemon changelogs" becomes "Component changelogs": every component (except webui) has a changelog, the one of ReGaHss comes with its binaries; a pull request adds its user-visible changes under
## Unreleasedto the changelog of each component it changes; a library change goes into the library's changelog, not into those of the programs using it.rfd and hs485d
Their introduction now says that their entries up to 2.6.8 / 1.4.0 include the changes of the libraries, which are in the library changelogs since.
Open version bumps (now under
Unreleased, for a later collected bump): libXmlRpc 0.13, tcl_homematic 1.1 (new function), multimacd, rfd and hs485d (--version).Documentation only; no code changes.
Summary by CodeRabbit