From 7982d1082fa2c163a19eb1c4dec28f57b7deb035 Mon Sep 17 00:00:00 2001 From: jh-RLI Date: Tue, 13 Oct 2026 15:41:32 +0200 Subject: [PATCH 1/4] Add a "What's new" page fed by each release's changelog highlights Rebuilds PR #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 Co-Authored-By: Claude Opus 5.5 (1M context) --- RELEASE_PROCEDURE.md | 3 + base/helper.py | 76 +++++++++--------- base/static/css/index-style.css | 10 +++ base/templates/base/index.html | 1 + base/templates/base/whats_new.html | 26 ++++++ base/templates/homepage/hero.html | 7 ++ base/tests/test_page_lint.py | 1 + base/tests/test_views.py | 1 + base/tests/test_whats_new.py | 100 ++++++++++++++++++++++++ base/urls.py | 2 + base/views.py | 11 ++- versions/changelogs/current.md | 22 ++++++ versions/changelogs/current.template.md | 8 ++ 13 files changed, 229 insertions(+), 39 deletions(-) create mode 100644 base/templates/base/whats_new.html create mode 100644 base/tests/test_whats_new.py diff --git a/RELEASE_PROCEDURE.md b/RELEASE_PROCEDURE.md index e55fde78f..3ec2d9fb1 100644 --- a/RELEASE_PROCEDURE.md +++ b/RELEASE_PROCEDURE.md @@ -56,6 +56,9 @@ Before see How to 1. Update the oeplatform/versions/changelogs/ [`current.md`](https://github.com/OpenEnergyPlatform/oeplatform/blob/develop/versions/changelogs/current.md) (see the examples of previous releases) + - Write its `## Highlights`: three to five points for users. They are the + release's entry on the platform's "What's new" page, which the homepage + links to. A release without highlights (usually a patch) is not listed. - Change filename to release version (x_x_x.md) - Copy template to `current.md` - Update version with `bumpversion --allow-dirty [minor|patch]` diff --git a/base/helper.py b/base/helper.py index 17c9a51f9..50baaaa8c 100644 --- a/base/helper.py +++ b/base/helper.py @@ -20,51 +20,55 @@ import markdown2 +from oeplatform.settings import EXTERNAL_URLS + logger = logging.getLogger("oeplatform") SITE_ROOT = os.path.dirname(os.path.realpath(__file__)) +CHANGELOG_DIR = os.path.join(SITE_ROOT, "..", "versions", "changelogs") +RELEASED_CHANGELOG = re.compile(r"(\d+)_(\d+)_(\d+)\.md") +HIGHLIGHTS = re.compile(r"^## Highlights[ \t]*\n(.*?)(?=^## |\Z)", re.M | re.S) +COMMENT = re.compile(r"", re.S) + + @lru_cache(maxsize=None) -def read_version_changes() -> dict: - """read version and changes from changelog markdown +def release_highlights(directory=CHANGELOG_DIR) -> list: + """The `## Highlights` of every released changelog, newest first. - We use cache so it can stay in process memory and we dont have to read files - in every request. this only changes on a new release anyway, in which case - the process is restarted. + A released changelog is named `__.md` (`current.md` is + the next release, not yet out). A release without highlights, as a patch + release usually is, is left out, so the newest entry is the newest release + that has something to tell users. Cached for the process: changelogs only + change with a release, which restarts it. Returns: - dict: {"version": (major, minor, patch), "changes": changes} + list of dicts with `version` ("1.11.0"), `html` and `changelog_url` """ - os.path.dirname(os.path.realpath(__file__)) - version_expr = r"^(?P\d+)\.(?P\d+)+\.(?P\d+)$" - markdowner = markdown2.Markdown() - - logger.info("READING VERSION file.") - try: - with open( - os.path.join(SITE_ROOT, "..", "VERSION"), encoding="utf-8" - ) as version_file: - text = version_file.read() - match = re.match(version_expr, text) - if not match: - raise ValueError(text) - major, minor, patch = match.groups() - with open( - os.path.join( - SITE_ROOT, - "..", - "versions/changelogs/%s_%s_%s.md" % (major, minor, patch), - ), - encoding="utf-8", - ) as change_file: - changes = markdowner.convert( - "\n".join(line for line in change_file.readlines()) - ) - except Exception: - logger.error("READING VERSION file.") - # probably because change_file is missing - major, minor, patch, changes = "", "", "", "" - return {"version": (major, minor, patch), "changes": changes} + releases = [] + for name in os.listdir(directory): + match = RELEASED_CHANGELOG.fullmatch(name) + if not match: + continue + with open(os.path.join(directory, name), encoding="utf-8") as file: + section = HIGHLIGHTS.search(file.read()) + text = COMMENT.sub("", section.group(1)).strip() if section else "" + if not text: + continue + version = ".".join(match.groups()) + releases.append( + { + "key": tuple(int(part) for part in match.groups()), + "version": version, + "html": markdown2.markdown(text), + "changelog_url": "{}/blob/v{}/versions/changelogs/{}".format( + EXTERNAL_URLS["github_openenergyplatform_oeplatform"], + version, + name, + ), + } + ) + return sorted(releases, key=lambda release: release["key"], reverse=True) def get_json_content(path, json_id=None): diff --git a/base/static/css/index-style.css b/base/static/css/index-style.css index 1368eb1a5..9acea6a9c 100644 --- a/base/static/css/index-style.css +++ b/base/static/css/index-style.css @@ -114,6 +114,16 @@ padding: 24px 0; } +.index-hero-news { + color: var(--oep-on-strong); +} + +.index-hero-news:hover, +.index-hero-news:focus-visible { + color: var(--oep-on-strong); + text-decoration: underline; +} + .index-hero-btn { display: inline-flex; align-items: center; diff --git a/base/templates/base/index.html b/base/templates/base/index.html index db10fb689..2e190d1dc 100644 --- a/base/templates/base/index.html +++ b/base/templates/base/index.html @@ -46,6 +46,7 @@

Resources

Platform

  • About OEP
    • +
  • What's new
  • Contact
  • Privacy
  • Terms
    • diff --git a/base/templates/base/whats_new.html b/base/templates/base/whats_new.html new file mode 100644 index 000000000..5b082c412 --- /dev/null +++ b/base/templates/base/whats_new.html @@ -0,0 +1,26 @@ +{% extends "base/base.html" %} +{% load static %} +{% block site-header %} + {% url 'base:about' as about_url %} + {% include "components/page_header.html" with area="About" icon="icons/area_about.html" crumb_label="Overview" crumb_url=about_url title="What's new" description="What changed for you in each release of the platform." %} +{% endblock site-header %} +{% block after-head %} + +{% endblock after-head %} +{% block main-content-body %} +
    + {% for release in releases %} +
    +

    Version {{ release.version }}

    + {# The changelogs are written in this repository, so their HTML is trusted. #} + {{ release.html|safe }} + + Full changelog of {{ release.version }} + {% include "icons/arrow_right.html" %} + +
    + {% empty %} + {% include "components/empty_state.html" with text="No release highlights yet." %} + {% endfor %} +
    +{% endblock main-content-body %} diff --git a/base/templates/homepage/hero.html b/base/templates/homepage/hero.html index 42b9ae15a..505df04fc 100644 --- a/base/templates/homepage/hero.html +++ b/base/templates/homepage/hero.html @@ -28,5 +28,12 @@

    View Documentation + {% if latest_release %} + + What's new in version {{ latest_release.version }} + {% include "icons/arrow_right.html" %} + + {% endif %} diff --git a/base/tests/test_page_lint.py b/base/tests/test_page_lint.py index 8709fd5a4..6a16fa443 100644 --- a/base/tests/test_page_lint.py +++ b/base/tests/test_page_lint.py @@ -218,6 +218,7 @@ def label(self): # are #2641's below too) Page("base:about"), Page("base:oefamily-sc"), + Page("base:whats-new"), Page("base:legal-privacy-policy"), Page("base:legal-tou"), Page("base:faq"), diff --git a/base/tests/test_views.py b/base/tests/test_views.py index 648895d64..50123454b 100644 --- a/base/tests/test_views.py +++ b/base/tests/test_views.py @@ -27,6 +27,7 @@ def test_views(self): self.get("base:legal-tou") self.get("base:robots") self.get("base:tutorials") + self.get("base:whats-new") self.get("base:project_detail", kwargs={"project_id": "sirop"}) def test_urls_in_templates(self): diff --git a/base/tests/test_whats_new.py b/base/tests/test_whats_new.py new file mode 100644 index 000000000..5ee77a9f0 --- /dev/null +++ b/base/tests/test_whats_new.py @@ -0,0 +1,100 @@ +"""The "What's new" page (#2382): each released changelog's `## Highlights`. + +SPDX-FileCopyrightText: 2026 Jonas Huber © Reiner Lemoine Institut +SPDX-License-Identifier: AGPL-3.0-or-later +""" # noqa: 501 + +import tempfile +from pathlib import Path +from unittest import mock + +from django.test import SimpleTestCase, TestCase +from django.urls import reverse + +from base.helper import release_highlights + +CHANGELOG = """# Changes to the oeplatform code + +## Highlights + +{} + +## Changes + +- an internal change users never see +""" + +RELEASE = { + "version": "1.11.0", + "html": "
    • Datasets start as drafts
    ", + "changelog_url": "https://example.org/1_11_0.md", +} + + +class ReleaseHighlightsTest(SimpleTestCase): + def highlights(self, **files): + with tempfile.TemporaryDirectory() as directory: + for name, highlights in files.items(): + Path(directory, name).write_text(CHANGELOG.format(highlights)) + # The cache keys on the directory, and every one here is new. + return release_highlights(directory) + + def test_released_versions_newest_first_by_number(self): + releases = self.highlights( + **{"1_9_0.md": "- nine", "1_10_0.md": "- ten", "1_2_0.md": "- two"} + ) + self.assertEqual( + [release["version"] for release in releases], ["1.10.0", "1.9.0", "1.2.0"] + ) + + def test_only_the_highlights_section_is_shown(self): + (release,) = self.highlights(**{"1_10_0.md": "- **New** list"}) + self.assertEqual( + release["html"].strip(), "
      \n
    • New list
      • \n
    " + ) + self.assertTrue( + release["changelog_url"].endswith( + "/blob/v1.10.0/versions/changelogs/1_10_0.md" + ) + ) + + def test_a_release_without_highlights_is_left_out(self): + releases = self.highlights( + **{ + "1_10_0.md": "- ten", + "1_10_1.md": "", + "1_10_2.md": "", + } + ) + self.assertEqual([release["version"] for release in releases], ["1.10.0"]) + + def test_the_next_release_is_not_out_yet(self): + self.assertEqual(self.highlights(**{"current.md": "- coming"}), []) + + def test_the_repositorys_changelogs_parse(self): + for release in release_highlights(): + self.assertTrue(release["html"].strip()) + + +class WhatsNewPagesTest(TestCase): + def test_the_page_lists_each_release_with_its_changelog(self): + with mock.patch("base.views.release_highlights", return_value=[RELEASE]): + page = self.client.get(reverse("base:whats-new")).content.decode() + self.assertIn("Version 1.11.0", page) + self.assertIn("
  • Datasets start as drafts
    • ", page) + self.assertIn('href="https://example.org/1_11_0.md"', page) + + def test_the_page_without_releases_says_so(self): + with mock.patch("base.views.release_highlights", return_value=[]): + page = self.client.get(reverse("base:whats-new")).content.decode() + self.assertIn("No release highlights yet.", page) + + def test_the_homepage_links_the_newest_release(self): + with mock.patch("base.views.release_highlights", return_value=[RELEASE]): + page = self.client.get(reverse("base:home")).content.decode() + self.assertIn("What's new in version 1.11.0", page) + + def test_the_homepage_has_no_link_without_a_release(self): + with mock.patch("base.views.release_highlights", return_value=[]): + page = self.client.get(reverse("base:home")).content.decode() + self.assertNotIn("What's new in version", page) diff --git a/base/urls.py b/base/urls.py index fa506b9d6..9614f173a 100644 --- a/base/urls.py +++ b/base/urls.py @@ -21,6 +21,7 @@ redirect_tutorial_view, reverse_url_view, robot_view, + whats_new_view, ) app_name = "base" @@ -40,6 +41,7 @@ name="project_detail", ), re_path(r"^contact/$", ContactView.as_view(), name="contact"), + path("whats-new/", whats_new_view, name="whats-new"), re_path(r"^faq/$", redir_view, {"target": "faq"}, name="faq"), re_path(r"^discussion/$", redir_view, {"target": "discussion"}, name="discussion"), re_path( diff --git a/base/views.py b/base/views.py index 285545e41..8b0ce08d8 100644 --- a/base/views.py +++ b/base/views.py @@ -22,7 +22,7 @@ from django.views.generic import View from base.forms import ContactForm -from base.helper import get_json_content, read_version_changes +from base.helper import get_json_content, release_highlights from oeplatform.settings import ( CONTACT_ADDRESSES, DEFAULT_FROM_EMAIL, @@ -34,8 +34,13 @@ class WelcomeView(View): def get(self, request): - context = read_version_changes() - return render(request, "base/index.html", context) + releases = release_highlights() + latest_release = releases[0] if releases else None + return render(request, "base/index.html", {"latest_release": latest_release}) + + +def whats_new_view(request): + return render(request, "base/whats_new.html", {"releases": release_highlights()}) def redir_view(request, target): diff --git a/versions/changelogs/current.md b/versions/changelogs/current.md index 2036ac44c..b48140c29 100644 --- a/versions/changelogs/current.md +++ b/versions/changelogs/current.md @@ -10,6 +10,24 @@ SPDX-License-Identifier: CC0-1.0 # Changes to the oeplatform code +## Highlights + + + +- **A new homepage and a consistent look:** the start page is redesigned, and + pages across the platform share the same buttons, forms, cards and headers. +- **All your tables in one list:** the tables tab of your dashboard shows drafts + and published tables together, with filters, sorting and actions on many + tables at once. +- **Manage access in place:** see and change who can access a table from a side + drawer in the tables tab. +- **Datasets start as drafts:** a dataset is published when it is ready, and the + new datasets tab manages your datasets and their tables. + ## Changes - The topic list's cards have their top section back: title, icon, table count @@ -686,6 +704,10 @@ SPDX-License-Identifier: CC0-1.0 table with no Admin at all [(#2595)](https://github.com/OpenEnergyPlatform/oeplatform/issues/2595) +- A "What's new" page lists each release's highlights for users, linked from the + homepage's hero and footer. A changelog's new `## Highlights` section is its + source [(#2382)](https://github.com/OpenEnergyPlatform/oeplatform/issues/2382) + ## Bugs - The Edit button in a table page's tag chooser opens the tag manager instead of diff --git a/versions/changelogs/current.template.md b/versions/changelogs/current.template.md index 599d6500c..a63a250e4 100644 --- a/versions/changelogs/current.template.md +++ b/versions/changelogs/current.template.md @@ -8,6 +8,14 @@ SPDX-License-Identifier: CC0-1.0 # Changes to the oeplatform code +## Highlights + + + ## Changes ## Features From 77f23bbfb4dceb20553cc8af26b15964d39635f3 Mon Sep 17 00:00:00 2001 From: jh-RLI Date: Tue, 13 Oct 2026 15:55:32 +0200 Subject: [PATCH 2/4] REUSE: annotate the What's new page template Co-Authored-By: Claude Opus 5.5 (1M context) --- REUSE.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/REUSE.toml b/REUSE.toml index 37871560e..2fad97cf0 100644 --- a/REUSE.toml +++ b/REUSE.toml @@ -3570,6 +3570,7 @@ path = [ "base/templates/base/_head.html", "base/templates/base/_instance_stylesheets.html", "base/templates/base/_feedback.html", + "base/templates/base/whats_new.html", "theming/stock_tokens.scss", "theming/literal_scan.mjs", ] From e753ca19b2b2a8160d57467b840c7d251f09d74c Mon Sep 17 00:00:00 2001 From: jh-RLI Date: Tue, 13 Oct 2026 15:59:29 +0200 Subject: [PATCH 3/4] What's new: do not name the release version anywhere The pages no longer say which release production runs. The page shows the newest released changelog's highlights with no version heading, the hero link reads "See what's new", and the full-changelog link is gone (its URL carried the version). `latest_release_highlights()` returns only the HTML, so no template can print the version, and a test holds both pages free of the VERSION string. Co-Authored-By: Claude Opus 5.5 (1M context) --- RELEASE_PROCEDURE.md | 7 +- base/helper.py | 41 ++++-------- base/templates/base/whats_new.html | 19 ++---- base/templates/homepage/hero.html | 4 +- base/tests/test_whats_new.py | 85 +++++++++++-------------- base/views.py | 10 +-- versions/changelogs/current.md | 12 ++-- versions/changelogs/current.template.md | 5 +- 8 files changed, 75 insertions(+), 108 deletions(-) diff --git a/RELEASE_PROCEDURE.md b/RELEASE_PROCEDURE.md index 3ec2d9fb1..84ce278a0 100644 --- a/RELEASE_PROCEDURE.md +++ b/RELEASE_PROCEDURE.md @@ -56,9 +56,10 @@ Before see How to 1. Update the oeplatform/versions/changelogs/ [`current.md`](https://github.com/OpenEnergyPlatform/oeplatform/blob/develop/versions/changelogs/current.md) (see the examples of previous releases) - - Write its `## Highlights`: three to five points for users. They are the - release's entry on the platform's "What's new" page, which the homepage - links to. A release without highlights (usually a patch) is not listed. + - Write its `## Highlights`: three to five points for users. The platform's + "What's new" page, linked from the homepage, shows them without the version + number. A release without highlights (usually a patch) keeps the previous + release's highlights there. - Change filename to release version (x_x_x.md) - Copy template to `current.md` - Update version with `bumpversion --allow-dirty [minor|patch]` diff --git a/base/helper.py b/base/helper.py index 50baaaa8c..f262d2290 100644 --- a/base/helper.py +++ b/base/helper.py @@ -20,8 +20,6 @@ import markdown2 -from oeplatform.settings import EXTERNAL_URLS - logger = logging.getLogger("oeplatform") SITE_ROOT = os.path.dirname(os.path.realpath(__file__)) @@ -33,42 +31,27 @@ @lru_cache(maxsize=None) -def release_highlights(directory=CHANGELOG_DIR) -> list: - """The `## Highlights` of every released changelog, newest first. +def latest_release_highlights(directory=CHANGELOG_DIR) -> str: + """HTML of the newest released changelog's `## Highlights`, or "". A released changelog is named `__.md` (`current.md` is the next release, not yet out). A release without highlights, as a patch - release usually is, is left out, so the newest entry is the newest release - that has something to tell users. Cached for the process: changelogs only - change with a release, which restarts it. - - Returns: - list of dicts with `version` ("1.11.0"), `html` and `changelog_url` + release usually is, is skipped. The version is deliberately not returned: + the platform's pages do not say which release it runs. Cached for the + process: changelogs only change with a release, which restarts it. """ - releases = [] + released = [] for name in os.listdir(directory): match = RELEASED_CHANGELOG.fullmatch(name) - if not match: - continue + if match: + released.append((tuple(int(part) for part in match.groups()), name)) + for _version, name in sorted(released, reverse=True): with open(os.path.join(directory, name), encoding="utf-8") as file: section = HIGHLIGHTS.search(file.read()) text = COMMENT.sub("", section.group(1)).strip() if section else "" - if not text: - continue - version = ".".join(match.groups()) - releases.append( - { - "key": tuple(int(part) for part in match.groups()), - "version": version, - "html": markdown2.markdown(text), - "changelog_url": "{}/blob/v{}/versions/changelogs/{}".format( - EXTERNAL_URLS["github_openenergyplatform_oeplatform"], - version, - name, - ), - } - ) - return sorted(releases, key=lambda release: release["key"], reverse=True) + if text: + return markdown2.markdown(text) + return "" def get_json_content(path, json_id=None): diff --git a/base/templates/base/whats_new.html b/base/templates/base/whats_new.html index 5b082c412..430e2465b 100644 --- a/base/templates/base/whats_new.html +++ b/base/templates/base/whats_new.html @@ -2,25 +2,18 @@ {% load static %} {% block site-header %} {% url 'base:about' as about_url %} - {% include "components/page_header.html" with area="About" icon="icons/area_about.html" crumb_label="Overview" crumb_url=about_url title="What's new" description="What changed for you in each release of the platform." %} + {% include "components/page_header.html" with area="About" icon="icons/area_about.html" crumb_label="Overview" crumb_url=about_url title="What's new" description="What changed for you in the platform's latest release." %} {% endblock site-header %} {% block after-head %} {% endblock after-head %} {% block main-content-body %}
    - {% for release in releases %} -
    -

    Version {{ release.version }}

    - {# The changelogs are written in this repository, so their HTML is trusted. #} - {{ release.html|safe }} - - Full changelog of {{ release.version }} - {% include "icons/arrow_right.html" %} - -
    - {% empty %} + {% if highlights %} + {# The changelogs are written in this repository, so their HTML is trusted. #} + {{ highlights|safe }} + {% else %} {% include "components/empty_state.html" with text="No release highlights yet." %} - {% endfor %} + {% endif %}
    {% endblock main-content-body %} diff --git a/base/templates/homepage/hero.html b/base/templates/homepage/hero.html index 505df04fc..4d32ef564 100644 --- a/base/templates/homepage/hero.html +++ b/base/templates/homepage/hero.html @@ -28,10 +28,10 @@

    View Documentation - {% if latest_release %} + {% if highlights %} - What's new in version {{ latest_release.version }} + See what's new {% include "icons/arrow_right.html" %} {% endif %} diff --git a/base/tests/test_whats_new.py b/base/tests/test_whats_new.py index 5ee77a9f0..daab0ec69 100644 --- a/base/tests/test_whats_new.py +++ b/base/tests/test_whats_new.py @@ -1,4 +1,4 @@ -"""The "What's new" page (#2382): each released changelog's `## Highlights`. +"""The "What's new" page (#2382): the newest released changelog's `## Highlights`. SPDX-FileCopyrightText: 2026 Jonas Huber © Reiner Lemoine Institut SPDX-License-Identifier: AGPL-3.0-or-later @@ -8,10 +8,11 @@ from pathlib import Path from unittest import mock +from django.conf import settings from django.test import SimpleTestCase, TestCase from django.urls import reverse -from base.helper import release_highlights +from base.helper import latest_release_highlights CHANGELOG = """# Changes to the oeplatform code @@ -24,77 +25,63 @@ - an internal change users never see """ -RELEASE = { - "version": "1.11.0", - "html": "
    • Datasets start as drafts
    ", - "changelog_url": "https://example.org/1_11_0.md", -} +HIGHLIGHTS = "
    • Datasets start as drafts
    " +VERSION = Path(settings.BASE_DIR, "VERSION").read_text().strip() -class ReleaseHighlightsTest(SimpleTestCase): +class LatestReleaseHighlightsTest(SimpleTestCase): def highlights(self, **files): with tempfile.TemporaryDirectory() as directory: for name, highlights in files.items(): Path(directory, name).write_text(CHANGELOG.format(highlights)) # The cache keys on the directory, and every one here is new. - return release_highlights(directory) + return latest_release_highlights(directory) - def test_released_versions_newest_first_by_number(self): - releases = self.highlights( + def test_the_newest_release_by_number_wins(self): + html = self.highlights( **{"1_9_0.md": "- nine", "1_10_0.md": "- ten", "1_2_0.md": "- two"} ) - self.assertEqual( - [release["version"] for release in releases], ["1.10.0", "1.9.0", "1.2.0"] - ) + self.assertEqual(html.strip(), "
      \n
    • ten
      • \n
    ") def test_only_the_highlights_section_is_shown(self): - (release,) = self.highlights(**{"1_10_0.md": "- **New** list"}) + html = self.highlights(**{"1_10_0.md": "- **New** list"}) self.assertEqual( - release["html"].strip(), "
      \n
    • New list
      • \n
    " - ) - self.assertTrue( - release["changelog_url"].endswith( - "/blob/v1.10.0/versions/changelogs/1_10_0.md" - ) + html.strip(), "
      \n
    • New list
      • \n
    " ) - def test_a_release_without_highlights_is_left_out(self): - releases = self.highlights( + def test_a_release_without_highlights_is_skipped(self): + html = self.highlights( **{ "1_10_0.md": "- ten", "1_10_1.md": "", "1_10_2.md": "", } ) - self.assertEqual([release["version"] for release in releases], ["1.10.0"]) + self.assertEqual(html.strip(), "
      \n
    • ten
      • \n
    ") def test_the_next_release_is_not_out_yet(self): - self.assertEqual(self.highlights(**{"current.md": "- coming"}), []) - - def test_the_repositorys_changelogs_parse(self): - for release in release_highlights(): - self.assertTrue(release["html"].strip()) + self.assertEqual(self.highlights(**{"current.md": "- coming"}), "") class WhatsNewPagesTest(TestCase): - def test_the_page_lists_each_release_with_its_changelog(self): - with mock.patch("base.views.release_highlights", return_value=[RELEASE]): - page = self.client.get(reverse("base:whats-new")).content.decode() - self.assertIn("Version 1.11.0", page) + def get(self, name, highlights): + with mock.patch( + "base.views.latest_release_highlights", return_value=highlights + ): + return self.client.get(reverse(name)).content.decode() + + def test_the_page_shows_the_highlights(self): + page = self.get("base:whats-new", HIGHLIGHTS) self.assertIn("
  • Datasets start as drafts
    • ", page) - self.assertIn('href="https://example.org/1_11_0.md"', page) - - def test_the_page_without_releases_says_so(self): - with mock.patch("base.views.release_highlights", return_value=[]): - page = self.client.get(reverse("base:whats-new")).content.decode() - self.assertIn("No release highlights yet.", page) - - def test_the_homepage_links_the_newest_release(self): - with mock.patch("base.views.release_highlights", return_value=[RELEASE]): - page = self.client.get(reverse("base:home")).content.decode() - self.assertIn("What's new in version 1.11.0", page) - - def test_the_homepage_has_no_link_without_a_release(self): - with mock.patch("base.views.release_highlights", return_value=[]): - page = self.client.get(reverse("base:home")).content.decode() - self.assertNotIn("What's new in version", page) + + def test_the_page_without_highlights_says_so(self): + self.assertIn("No release highlights yet.", self.get("base:whats-new", "")) + + def test_the_homepage_links_the_page_when_there_is_news(self): + self.assertIn("See what's new", self.get("base:home", HIGHLIGHTS)) + self.assertNotIn("See what's new", self.get("base:home", "")) + + def test_no_page_names_the_running_release(self): + # The pages do not tell a visitor which release production runs. + for name in ("base:home", "base:whats-new"): + self.assertNotIn(VERSION, self.get(name, HIGHLIGHTS), name) diff --git a/base/views.py b/base/views.py index 8b0ce08d8..c92a90074 100644 --- a/base/views.py +++ b/base/views.py @@ -22,7 +22,7 @@ from django.views.generic import View from base.forms import ContactForm -from base.helper import get_json_content, release_highlights +from base.helper import get_json_content, latest_release_highlights from oeplatform.settings import ( CONTACT_ADDRESSES, DEFAULT_FROM_EMAIL, @@ -34,13 +34,13 @@ class WelcomeView(View): def get(self, request): - releases = release_highlights() - latest_release = releases[0] if releases else None - return render(request, "base/index.html", {"latest_release": latest_release}) + highlights = latest_release_highlights() + return render(request, "base/index.html", {"highlights": highlights}) def whats_new_view(request): - return render(request, "base/whats_new.html", {"releases": release_highlights()}) + highlights = latest_release_highlights() + return render(request, "base/whats_new.html", {"highlights": highlights}) def redir_view(request, target): diff --git a/versions/changelogs/current.md b/versions/changelogs/current.md index b48140c29..39be57b23 100644 --- a/versions/changelogs/current.md +++ b/versions/changelogs/current.md @@ -14,8 +14,9 @@ SPDX-License-Identifier: CC0-1.0 - **A new homepage and a consistent look:** the start page is redesigned, and @@ -704,9 +705,10 @@ A release that leaves this section empty is not listed there. table with no Admin at all [(#2595)](https://github.com/OpenEnergyPlatform/oeplatform/issues/2595) -- A "What's new" page lists each release's highlights for users, linked from the - homepage's hero and footer. A changelog's new `## Highlights` section is its - source [(#2382)](https://github.com/OpenEnergyPlatform/oeplatform/issues/2382) +- A "What's new" page shows the latest release's highlights for users, linked + from the homepage's hero and footer, without naming the version. A changelog's + new `## Highlights` section is its source + [(#2382)](https://github.com/OpenEnergyPlatform/oeplatform/issues/2382) ## Bugs diff --git a/versions/changelogs/current.template.md b/versions/changelogs/current.template.md index a63a250e4..281c7b146 100644 --- a/versions/changelogs/current.template.md +++ b/versions/changelogs/current.template.md @@ -12,8 +12,9 @@ SPDX-License-Identifier: CC0-1.0 ## Changes From f4be8eec8796d4e143b724186b8ca645372a3762 Mon Sep 17 00:00:00 2001 From: jh-RLI Date: Tue, 13 Oct 2026 16:01:00 +0200 Subject: [PATCH 4/4] What's new: the breadcrumb leads back to the homepage Co-Authored-By: Claude Opus 5.5 (1M context) --- base/templates/base/whats_new.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/base/templates/base/whats_new.html b/base/templates/base/whats_new.html index 430e2465b..e0c5aa0bd 100644 --- a/base/templates/base/whats_new.html +++ b/base/templates/base/whats_new.html @@ -1,8 +1,8 @@ {% extends "base/base.html" %} {% load static %} {% block site-header %} - {% url 'base:about' as about_url %} - {% include "components/page_header.html" with area="About" icon="icons/area_about.html" crumb_label="Overview" crumb_url=about_url title="What's new" description="What changed for you in the platform's latest release." %} + {% url 'base:home' as home_url %} + {% include "components/page_header.html" with area="About" icon="icons/area_about.html" crumb_label="Home" crumb_url=home_url title="What's new" description="What changed for you in the platform's latest release." %} {% endblock site-header %} {% block after-head %}