Repository navigation
feat(website): show each GitHub release's notes in the changelog - #20
Merged
Merged
Conversation
The changelog lists every version on npm with the notes of its GitHub release, read when the site builds (as GitHub renders them), instead of the hand-written notes in changelog.ts. Drafts are left out, so a version's notes show up once it is approved on npm.
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.
The changelog's notes now come from the GitHub releases instead of the hand-written
src/lib/changelog.ts, which is deleted. Release notes are written in one place: the draft release.src/lib/github.tsreads the published releases when the site builds and skips drafts, so a version's notes show only once it's approved on npm. It reads them as GitHub renders them (body_html, sanitized by GitHub).website.ymland the CI's site build passGITHUB_TOKEN.The old releases already have the curated notes that lived in
changelog.ts: 14 releases were edited. v0.2.2 and v0.3.3 keep their notes, and v0.4.0 and v0.4.1 have no release.Checks:
build.types,lintand the full SSG build pass inwebsite/.fetch, the reader handles being offline, the GitHub Actions failure path and pagination.