[CHIRP-3551]: docs: add CHANGELOG with backdated release history#32
Open
wirelesstim wants to merge 2 commits into
Open
[CHIRP-3551]: docs: add CHANGELOG with backdated release history#32wirelesstim wants to merge 2 commits into
wirelesstim wants to merge 2 commits into
Conversation
The project had no changelog despite five tagged releases. Adds a Keep a Changelog / SemVer file covering v1.0.0 through v1.2.0, reconstructed from the actual commit ranges between tags, plus a 1.3.0 Unreleased section for the work already on main and the changes in flight. The 1.3.0 entry opens with the required-migration notice for the EUI BIGINT to BYTEA(8) move, which silently overflowed for EUIs above INT64_MAX on the old schema. VERSION stays 1.2.0 and no tag is pushed: release.yml fires on a v* tag and validates it against VERSION, so cutting the release remains a deliberate, separate action.
Rewrites entries in operator terms - what changed for someone running KiloCenter - instead of implementation detail, and drops contributor-only tooling notes that have no meaning outside the repository. The 1.3.0 heading carries a concrete date and its compare link points at the v1.3.0 tag, so cutting the release needs no edit to this file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The project has five tagged releases on GitHub but no changelog, so community users have no way to see what changed between versions or whether an upgrade needs a migration.
Jira: CHIRP-3551
What this adds
A
CHANGELOG.mdin Keep a Changelog format following Semantic Versioning, with the history reconstructed from the actual commit ranges between tags:1.3.0mainplus the changes in flight1.2.0decoded_payloadin MQTT uplinks1.1.21.1.11.1.01.0.0The
1.3.0section opens with a migration-required notice: endpoint and base-station EUIs move from a signedBIGINTtoBYTEA(8), because EUIs aboveINT64_MAX(any EUI with the high bit set) overflowed silently on the old schema.Scope
Documentation only.
VERSIONstays at1.2.0and no tag is pushed —release.ymltriggers on av*tag and validates it against theVERSIONfile, so cutting the release stays a deliberate, separate action. When that happens, the1.3.0heading gets its date and the compare link is repointed frommainto the tag.