RobotWebTools / rclnodejs / 28078587548

91%

push

github

[jsdoc] Add per-release GitHub release-notes link to sidebar (#1551)

Add a "Release notes" link to the sidebar of each generated jsdoc release so developers browsing a version's API reference can jump straight to that release's notes for a quick overview of what changed.

- tmpl/layout.tmpl: derive the release-notes URL from the package.json `repository.url` (strip the `git+` prefix and `.git` suffix) and render a `brand-release-notes` link under the version badge, pointing at `<repo>/releases/tag/<version>`. Gated on the URL being resolvable, so the link is omitted when no repository is configured. Because the version is the release being documented, the link is always correct without extra logic, and reading the slug from package.json keeps forks/renames working.
- static/styles/jsdoc-default.css: add a `.brand-release-notes` style matching the sidebar accent color with an underline on hover.

Fix: #1550

2047 of 2409 branches covered (84.97%)

Branch coverage included in aggregate %.

16722 of 18184 relevant lines covered (91.96%)

226.55 hits per line