internetarchive / dweb-mirror

Offline Internet Archive project
https://www-dweb-mirror.dev.archive.org/
GNU Affero General Public License v3.0
263 stars 27 forks source link

add npm versioning badge #262

Open pedro-nonfree opened 4 years ago

pedro-nonfree commented 4 years ago

related to discuss in #259

for me it was no easy to see versioning (github releases are empty) and in the readme I could not find a clear part linking that github repo with the npm one

but in the other side npm points go github clearly https://www.npmjs.com/package/@internetarchive/dweb-mirror

mitra42 commented 4 years ago

Good point ... the assumption has been that noone needs this info, i.e. README.md points to the installation docs, those installation docs run a script, and that script happens to use the yarn tool to access npm. At no point does the user interact directly with NPM.

pedro-nonfree commented 4 years ago

I wanted to know that information and I usually get it in git tag or github/gitlab releases. So I spend some extra time figuring out where to find that info. Not all software uses npm. In my opinion getting very quick what version runs the software is useful for everyone (users that ping their sysadmins to upgrade, sysadmins, developers). So is not that redundant. Not all people that come to the github repo run the installation scripts, or know that they can already have here that info

mitra42 commented 4 years ago

But if I understand you correctly (and I'm not sure I do).

There is a difference between development and customer releases, for a lot of Javascript, I see development on github and then releases on npm, which is similar to developing on github and releasing on deb except that npm releases seem to be usually more fluid, using semver locking to allow frequent bug fixes without breaking things.

It looks like you can get the published version number with

npm view @internetarchive/dweb-mirror
OR
yarn info @internetarchive/dweb-mirror | grep version

Though yours is the first request I've had for this - I've never used these commands before as for javascript package.json manages when to upgrade what packages so all I need to do is

yarn upgrade

To get them all.