Skip to content

Commit 3d8d9c1

Browse files
committed
[jsdoc] Add per-release GitHub release-notes link to sidebar
1 parent 8aeafae commit 3d8d9c1

2 files changed

Lines changed: 21 additions & 0 deletions

File tree

tools/jsdoc/static/styles/jsdoc-default.css

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,17 @@ samp,
211211
color: var(--text-soft);
212212
}
213213

214+
.brand-release-notes {
215+
width: fit-content;
216+
color: var(--accent-strong);
217+
font-size: 0.82rem;
218+
font-weight: 700;
219+
}
220+
221+
.brand-release-notes:hover {
222+
text-decoration: underline;
223+
}
224+
214225
.nav-toggle {
215226
display: none;
216227
border: 0;

tools/jsdoc/tmpl/layout.tmpl

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@
1919
var packageName = packageInfo.name || 'rclnodejs';
2020
var packageVersion = packageInfo.version || '';
2121
var packageDescription = packageInfo.description || 'ROS 2 client library for Node.js and TypeScript';
22+
var repository = packageInfo.repository;
23+
var repositoryUrl = '';
24+
if (repository) {
25+
var repositoryString = typeof repository === 'string' ? repository : (repository.url || '');
26+
repositoryUrl = repositoryString.replace(/^git\+/, '').replace(/^git:\/\//, 'https://').replace(/\.git$/, '');
27+
}
28+
var releaseNotesUrl = (repositoryUrl && packageVersion) ? repositoryUrl + '/releases/tag/' + packageVersion : '';
2229
?>
2330
<body>
2431
<div class="site-backdrop"></div>
@@ -34,6 +41,9 @@
3441
<?js } ?>
3542
</a>
3643
<p class="brand-description"><?js= packageDescription ?></p>
44+
<?js if (releaseNotesUrl) { ?>
45+
<a class="brand-release-notes" href="<?js= releaseNotesUrl ?>" target="_blank" rel="noopener noreferrer">Release notes &#8599;</a>
46+
<?js } ?>
3747
</div>
3848

3949
<button class="nav-toggle" type="button" aria-expanded="false" aria-controls="site-nav">

0 commit comments

Comments
 (0)