Repository navigation
fix(releases): repair changelog and release comparison links - #152
Merged
Merged
Conversation
Generate future release notes from merged pull request titles with the correct tag prefix, and validate release metadata before publication. Include each version's comparison link in its GitHub release description. Repair historical comparisons, restore the complete 2.2.0 release notes, and document the release process. Add regression tests for invalid release metadata and refresh the shared pull request notification workflow.
nickolas-dimitrakas
approved these changes
Oct 27, 2026
nickolas-dimitrakas
left a comment
There was a problem hiding this comment.
Checked the changelog links against the repo tags, and all resolve. The publish step now runs after the release-body check, so a bad version or link fails before anything is published. LGTM. Check the first generated release PR for notes that need migration guidance.
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
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.
Why
Version links in the changelog lead to missing pages because they omit the prefix used by release tags. The 2.2.0 release also omits several changes and an Android breaking change because its notes were split across duplicate headings. This repair restores the history and checks future release notes before publication.
Programme
Standalone change, no programme.
What changes
Linked work
Related: ROKT/rokt-sdk-flutter#255, the reference implementation for tag prefixes and release comparison footers.
Rollout
Path: merge this repair, then update the six existing GitHub release descriptions from saved copies. Restore the omitted 2.2.0 notes and add comparison footers; future drafts and publications use the corrected workflows.
Feature flags: none.
Turning it off: revert this pull request and restore the saved release descriptions. Existing package archives remain unchanged.
What we watch: inspect the next draft and published Full Changelog link. The small release-body step rejects a mismatched VERSION and missing or duplicate comparison references.
Risks
Risk class: low.
Who
Written by: repository contributor, following the changelog repair request.
Code reviewed before opening: self-review on 27 October 2026, covering workflows, historical entries and release-footer fixtures.
Design reviewed before opening: no one.
Decision this implements: use the release-generation and comparison-link pattern in ROKT/rokt-sdk-flutter#255, reviewed on 27 October 2026.
Checked: root Flutter tests (22 passed), example tests (4 passed), current and next release fixtures, missing/duplicate reference fixtures, all 18 changelog references and actionlint on 27 October 2026. The workflow security scan adds no findings compared with the base branch.
Not checked: native device integration tests because SDK runtime code is unchanged; the next actual publication because no package release is part of this repair.
Size
Hand-written: 72 changed lines across 6 files.
Generated: 1 file.
Notes for reviewers
The changelog repair was produced by a one-off Python migration and checked against the original text: every historical bullet is preserved. All 18 links resolve to Git refs; the corrected 1.1.2 range includes pull request #61. Version files, SDK APIs and tags are unchanged. The final change follows the small workflow pattern from the linked reference; it adds no validator scripts or permanent test suite.
The pinned shared generator and the actual version-update and release-body shell steps passed fixtures for the current 2.3.0 and next 2.4.0 releases. The security scan reports existing advisory findings; none are introduced by this change. There is no Trunk configuration in this repository.