Skip to content

fix: link each package's CHANGELOG.md from its README - #18

Merged
brillout merged 2 commits into
mainfrom
claude/adoring-cannon-n1hd2e
Oct 15, 2026
Merged

brillout merged 2 commits into
mainfrom
claude/adoring-cannon-n1hd2e

Conversation

@brillout

@brillout brillout commented Oct 15, 2026 •

Copy link
Copy Markdown
Member

Adds a Changelog: line to each package's README (elysia, express, fastify, h3, hono, srvx), between the existing Docs: and Source code: lines:

Docs: see [vike.dev/server](https://vike.dev/server)  
Changelog: [CHANGELOG.md](https://github.com/vikejs/vike-server-adapters/blob/main/packages/hono/CHANGELOG.md)  
Source code: [GitHub > vikejs/vike-server-adapters](https://github.com/vikejs/vike-server-adapters)

Why an absolute URL

A relative [CHANGELOG.md](CHANGELOG.md) link would work on GitHub but not on npmjs.com:

  • npm resolves relative README links against the package.json repository URL. Here that's the repo root, with no directory, and the root has no CHANGELOG.md (/blob/main/CHANGELOG.md and /blob/HEAD/CHANGELOG.md both return 404).
  • The published tarball doesn't include CHANGELOG.md either (files: ["dist"]; checked @vikejs/hono@0.4.0 and @vikejs/express@0.4.0, which contain only LICENSE, README.md, dist/, package.json).

The absolute GitHub URL works in both places and matches the existing absolute Source code: link.

Verification

  • All six changelog URLs return HTTP 200.
  • Rendering a README with markdown-it (CommonMark) gives three separate lines (<br> from the trailing two spaces, the same line break the Docs: line already uses).

npm shows the README from the published tarball, so the new link appears on npmjs.com when each package is next released. This PR doesn't add a changeset.

🤖 Generated with Claude Code

https://claude.ai/code/session_018R6dHTpDgRjmv4dRcUhhKe


Generated by Claude Code

Use an absolute GitHub URL so the link also works on npmjs.com: npm
resolves relative README links against the package.json `repository`
URL, which is the repo root (no CHANGELOG.md there), and the published
tarball doesn't include CHANGELOG.md either.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018R6dHTpDgRjmv4dRcUhhKe
@brillout brillout changed the title docs: link each package's CHANGELOG.md from its README fix: link each package's CHANGELOG.md from its README Oct 15, 2026
@brillout
brillout merged commit 30c3dc7 into main Oct 15, 2026
1 check passed
@brillout
brillout deleted the claude/adoring-cannon-n1hd2e branch October 15, 2026 22:02
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