Skip to content

Feature 2382 changelog highlights - #2401

Closed
tomi-rli wants to merge 9 commits into
developfrom
feature-2382-changelog-highlights
Closed

tomi-rli wants to merge 9 commits into
developfrom
feature-2382-changelog-highlights

Conversation

@tomi-rli

@tomi-rli tomi-rli commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Summary of the discussion

Describe the findings of the discussion in the issue or meeting.

Type of change (CHANGELOG.md)

Features

Features

  • Add automatic rendering of user-facing release highlights from the latest published changelog (#2382).

Changes

  • Replace the hard-coded release information file on the start page with automatically selected changelog highlights (#2382).

Bugs

  • Fixed a problem with
    (#)

Removed

  • Remove a broken link
    (#)

Documentation updates

  • Updated documentation for
    (#)

Workflow checklist

Automation

Closes #

PR-Assignee

Reviewer

  • 🐙 Follow the
    Reviewer Guidelines
  • 🐙 Provided feedback and show sufficient appreciation for the work done

@jh-RLI

jh-RLI commented Oct 13, 2026

Copy link
Copy Markdown
Contributor

Thanks @tomi-rli! Since this PR was opened, the homepage was replaced by the redesign in #2352, so it can no longer be rebased. Its idea now continues in #2713, with you credited as co-author: a ## Highlights section in each changelog, shown on a new "What's new" page that the homepage links to. The rework also fixes the case where a patch release without highlights left an empty box on the start page. Closing in favour of #2713.

@jh-RLI jh-RLI closed this Oct 13, 2026
jh-RLI added a commit that referenced this pull request Oct 13, 2026
What's new page fed by the latest release's changelog highlights (replaces #2401)
jh-RLI added a commit to AriyosenaS/oeplatform that referenced this pull request Oct 21, 2026
Rebuilds PR OpenEnergyPlatform#2401 on the new homepage. Each changelog gains a
`## Highlights` section: three to five points written for users at
release time. `base.helper.release_highlights()` reads it from every
released changelog (`x_y_z.md`, not `current.md`), newest first by
version number, and leaves out a release without one, so a patch release
does not empty the page or the link. It replaces `read_version_changes`,
whose result no template read any more.

- `/whats-new/` (`base:whats-new`) lists the releases on the static-page
  layout, each with a link to its full changelog at the release tag.
- The homepage hero links "What's new in version X" when a release has
  highlights, and the homepage footer links the page. Bryan's sections
  are untouched.
- The template and `current.md` carry the section; `current.md` has a
  draft for the next release. RELEASE_PROCEDURE.md gains the step.

Co-Authored-By: tomi-rli <Tomi.Nguyen@rl-institut.de>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
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