Skip to content

add a changelog to every component - #296

Merged
jens-maus merged 2 commits into
mainfrom
jens-maus/component-changelogs
Nov 2, 2026
Merged

jens-maus merged 2 commits into
mainfrom
jens-maus/component-changelogs

Conversation

@jens-maus

@jens-maus jens-maus commented Nov 2, 2026 •

Copy link
Copy Markdown
Member

Follow-up to #291 and #294: every component under src/ except webui (separate pull request) and the closed-source ReGaHss (its changelog comes with the binaries, see below) gets a CHANGELOG.md in 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

Components First entries
ssdpd, eq3configd, eq3configcmd, crypttool, SetInterfaceClock, hs485dLoader, libhsscomm, libelvutils, libLanDeviceUtils, libUnifiedLanComm, libeq3config 1.0.0 (2026-11-02), the first version from #294, with the changes since 3.89.11
hss_led 2.3.0 (2026-11-02): #59, #203, #285, #294
libXmlRpc 0.10 (#27), 0.11 (#138), 0.12 (#140, #189); Unreleased: #271, #281, #285, #294
libxmlparser 1.13 (#19), 1.14 (#29); Unreleased: #294
eq3_char_loop 1.5 (#22), 1.6 (#112)
multimacd 1.2.0; Unreleased: -v/--version (#294)
tclrega, tclrpc 1.4 (#24)
tcl_homematic 1.0; Unreleased: RemoveConfigPage (#48)
bcm2835_raw_uart 1.12 (unchanged)
devicetypes Unreleased: SET_TEMPERATURE limits (#221), CFM-TW long-press register (#63)
hmipserver Unreleased: HMIPServer.jar build 5936 of 2026-10-08 from eQ-3

devicetypes and hmipserver have no version of their own; their Unreleased heading gets the OpenCCU-Base release.

ReGaHss
ReGaHss converts its ChangeLog to a CHANGELOG.md in the same format (OpenCCU/ReGaHss#42); its next release replaces src/ReGaHss/ChangeLog here with src/ReGaHss/CHANGELOG.md through the ReGaHss Release workflow. AGENTS.md, README.md and src/ReGaHss/README.md refer to it accordingly (ChangeLog up 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 ## Unreleased to 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

  • Documentation
    • Changelogs now cover more components and clarify how release history, unreleased changes, and version updates are recorded.
    • Newly documented release details include version information, support for handling high-numbered file descriptors, and fixes related to device descriptions, networking, configuration parsing, and server behavior.
    • Repository and component guides now point to the updated changelog locations and conventions.

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.
@coderabbitai

coderabbitai Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 51529914-fe82-4cba-b4fd-da68ddd1703f
Commits

Reviewing files that changed from the base of the PR and between 169c9c4 and c3c353c.

Files selected for processing: 3
  • AGENTS.md
  • README.md
  • src/ReGaHss/README.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

The pull request expands changelog guidance to components under src/ and adds or updates changelogs for tools, daemons, libraries, device descriptions, and extensions.

Changes: Component changelog coverage

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

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: Passed 4
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly summarizes the main change: adding changelogs across the project components. It is concise and related to the changeset, although it does not mention the documented exclusions.
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
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.

Share

jens-maus commented Nov 2, 2026 •

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Nov 2, 2026 •

Copy link
Copy Markdown
Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai coderabbitai Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

  • Fix comments: Fix CodeRabbit comments on this PR

Comment thread AGENTS.md Resolved
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 coderabbitai Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

  • Fix comments: Fix CodeRabbit comments on this PR

Comment thread AGENTS.md Resolved
Comment thread src/ReGaHss/README.md Resolved

jens-maus commented Nov 2, 2026 •

Copy link
Copy Markdown
Member Author

@coderabbitai Thanks for the review. Both points describe the state after the next ReGaHss release, which replaces src/ReGaHss/ChangeLog with src/ReGaHss/CHANGELOG.md in the format of the component changelogs (the texts already say "ChangeLog up to R1.00.0388.0267"). The references are kept as they are so they need no second change after that release.

@coderabbitai

coderabbitai Bot commented Nov 2, 2026

Copy link
Copy Markdown

Tip

For best results, initiate chat on the files or code changes.

Analysis chain

Script executed:

#!/bin/bash
fd -H '^(AGENTS\.md|README\.md|ChangeLog|CHANGELOG\.md)$' . --exclude .git
printf '\n--- Root instructions ---\n'
cat AGENTS.md
printf '\n--- Root README references ---\n'
rg -n -C 4 'ReGaHss|ChangeLog|CHANGELOG' README.md
printf '\n--- ReGaHss documentation and instructions ---\n'
find src/ReGaHss -name AGENTS.md -print
cat src/ReGaHss/README.md
printf '\n--- ReGaHss changelog files ---\n'
find src/ReGaHss -maxdepth 1 -type f \( -name ChangeLog -o -name CHANGELOG.md \) -print -exec head -n 35 {} \;
printf '\n--- Intermediate instructions, if present ---\n'
if [ -f src/AGENTS.md ]; then cat src/AGENTS.md; fi

Length of output: 11860


@jens-maus Thanks for clarifying. I confirmed that AGENTS.md and src/ReGaHss/README.md document the ChangeLog filename through R1.00.0388.0267. Given the planned rename with the next ReGaHss release, I withdraw both concerns. No change is needed in this PR.

You are interacting with an AI system.

@coderabbitai

coderabbitai Bot commented Nov 2, 2026

Copy link
Copy Markdown

Tip

For best results, initiate chat on the files or code changes.

Analysis chain

Script executed:

#!/bin/bash
fd -H '^(AGENTS\.md|ChangeLog|CHANGELOG\.md)$' . --exclude .git
printf '\n--- Repository instructions ---\n'
cat AGENTS.md
if [ -f src/AGENTS.md ]; then cat src/AGENTS.md; fi
printf '\n--- ReGaHss instructions ---\n'
find src/ReGaHss -name AGENTS.md -type f -exec cat {} \;
printf '\n--- ReGaHss README ---\n'
cat src/ReGaHss/README.md
printf '\n--- Root README references ---\n'
rg -n -C 4 'ReGaHss|ChangeLog|CHANGELOG' README.md
printf '\n--- ReGaHss changelog headers ---\n'
find src/ReGaHss -maxdepth 1 -type f \( -name ChangeLog -o -name CHANGELOG.md \) -print -exec head -n 25 {} \;

Length of output: 10976


@jens-maus Thanks for clarifying. I confirmed that AGENTS.md and src/ReGaHss/README.md document the legacy filename through R1.00.0388.0267. The references anticipate the next ReGaHss release. I withdraw both concerns; no change is needed in this PR.

You are interacting with an AI system.

@jens-maus
jens-maus merged commit 2047961 into main Nov 2, 2026
6 checks passed
@jens-maus
jens-maus deleted the jens-maus/component-changelogs branch November 2, 2026 18:53
github-actions Bot pushed a commit to hobbyquaker/OpenCCU-Base that referenced this pull request Nov 2, 2026
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant