Skip to content

fix(releases): repair changelog and release comparison links - #152

Merged
thomson-t merged 2 commits into
mainfrom
thomson-t/changelog-tags-prefix-fix
Oct 27, 2026
Merged

thomson-t merged 2 commits into
mainfrom
thomson-t/changelog-tags-prefix-fix

Conversation

@thomson-t

@thomson-t thomson-t commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

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

  • Generate future changelogs from merged pull request titles with the correct tag prefix, and include the notes in release pull requests.
  • Repair all historical comparisons and consolidate the complete 2.2.0 notes without dropping any historical entries.
  • Include the matching Full Changelog link in GitHub releases using an exact version-reference lookup.
  • Document the release process, repair two documentation links, and update the shared notification workflow to skip unavailable webhooks.

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

  • Generated summaries can omit migration detail; release pull requests expose the generated notes for editorial review; missing guidance can be corrected before merging the release.
  • A release footer could select the wrong version; exact version-reference lookup rejects missing or duplicate matches; current and next-version fixtures verify the resulting links.

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.

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.

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

Nothing blocking. The comments below are optional suggestions. There is no need to push a fix for them before merging.

Comment thread .github/scripts/release.py Resolved
Comment thread .github/scripts/release.py Resolved

@nickolas-dimitrakas nickolas-dimitrakas 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.

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.

@thomson-t
thomson-t merged commit 9992a0c into main Oct 27, 2026
8 checks passed
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.

2 participants