Skip to content

Changelog: show the notes published with each release on GitHub - #43

Merged
fylorn merged 1 commit into
mainfrom
feat/changelog-release-notes
Oct 1, 2026
Merged

fylorn merged 1 commit into
mainfrom
feat/changelog-release-notes

Conversation

@fylorn

@fylorn fylorn commented Oct 1, 2026

Copy link
Copy Markdown
Contributor

The changelog listed 110 releases, but only the four Enterprise releases written up on this site had notes; the rest linked to GitHub. This reads the notes published with each release at build time and shows them under the release.

Source (src/lib/release-notes.ts, a content loader like the Core documents' loader, rendered with the site's markdown settings)

  • English: the release body, without the download table, GitHub's generated pull-request list and comparison link, and Enterprise's image and Helm preamble.
  • Chinese: ThinkWatch Lite's annotated tags carry the notes in Chinese (the text its update window shows). They are read through the GraphQL API, which needs GITHUB_TOKEN; the deploy and check workflows already set it.
    • The tag message is plain text: the release name on the first line is dropped, and a short line followed directly by - items becomes a heading.
    • 「升级须知:」 is set in bold with <strong>. **…** does not close when it ends in a full-width colon right before a character.
    • The first Lite tags were annotated in English. Where the release itself has no notes, that text is used as the English note.
  • Core and Enterprise publish English notes only. On the Chinese page those releases carry an EN badge.
  • Heading ids are prefixed per release, because ids like upgrade-notes would otherwise repeat on one page.
  • Failure: when GitHub cannot be reached, the build warns (also as a workflow annotation) and the releases link to GitHub as before. The committed releases.json fallback stays lean.

Page

  • A release with notes opens in place, with a chevron on its row. The latest-release tiles, shared anchors and the old #v0.4.0 anchors open their release.
  • The Enterprise releases written up on this site keep their title and highlights, now inside the same disclosure.
  • Core v0.46.0 and earlier (58 releases) only have GitHub's generated pull-request list, so they keep linking to GitHub. 52 of 110 releases have notes.

Checked with a token-backed local build and headless Chromium:

  • An anchor scrolls to its release and opens it; the old #v0.4.0 anchor does too.
  • Each latest-release tile opens its release.
  • No download tables, pull-request lists or Helm preambles remain.
  • tsc --noEmit is clean.

🤖 Generated with Claude Code

A new release_notes content collection (src/lib/release-notes.ts) reads
the notes of every release at build time and renders them with the
site's markdown settings, like the Core documents.

- English: the release's notes without the download table, GitHub's
  list of merged pull requests and Enterprise's image and Helm preamble.
- Chinese: ThinkWatch Lite's annotated tags hold the notes in Chinese
  (the text of its update window), read through the GraphQL API. Their
  short lines followed by items become headings, and the upgrade notes
  are set off. The first Lite tags were annotated in English; with no
  notes on the release, that text is the English note.
- Core and Enterprise have English notes only; on the Chinese page those
  releases carry an EN badge.
- Heading ids are prefixed per release, since "upgrade-notes" and the
  like would otherwise repeat on one page.

On the page a release with notes opens in place; a link to a release
(the latest tiles, a shared anchor, the old #v0.4.0 anchors) opens it.
The written-up Enterprise releases keep their title and highlights in
the same place. Core v0.46.0 and earlier have only GitHub's generated
pull-request list, so they keep linking to GitHub. When GitHub cannot
be reached the build warns and the releases link to GitHub as before.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@fylorn
fylorn merged commit eac098b into main Oct 1, 2026
1 check passed
@fylorn
fylorn deleted the feat/changelog-release-notes branch October 1, 2026 05:03
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.

1 participant