search

HenrikBengtsson / CBI-software

A Scientific Software Stack for HPC (CentOS oriented)
https://wynton.ucsf.edu/hpc/software/software-repositories.html
5 stars 2 forks source link

Modules: Add 'ChangeLog: <URL>' component for all software tools #28

Closed HenrikBengtsson closed 2 years ago

HenrikBengtsson commented 2 years ago

It would be useful to have links to the official ChangeLog/NEWS file/page for the different software tools when looking at module show ... but also in the online rendered pages, e.g. https://wynton.ucsf.edu/hpc/software/software-repositories.html.

HenrikBengtsson commented 2 years ago

One approach could be to prefix the URL with a custom <url> (changelog) syntax, e.g.

whatis("URL: https://github.com/sharkdp/bat, https://github.com/sharkdp/bat/blob/master/CHANGELOG.md (changelog)")

That's human-readable, it'll will show up naturally in module show bat, but it can also be parsed for alternative rendering, e.g. any changelog URLs gets custom links on an HTML page, e.g.

Versions: 0.17.1, 0.18.3 (changelog)

HenrikBengtsson commented 2 years ago

I think this is now completed