monarch-initiative / phenopacket-store

Collection of phenopackets
https://monarch-initiative.github.io/phenopacket-store/
BSD 3-Clause "New" or "Revised" License
12 stars 4 forks source link

Create a stable download URL and link to it in the documentation #95

Open cmungall opened 1 month ago

cmungall commented 1 month ago

Many computational users will want to download all phenopackets at once

This is available from: https://github.com/monarch-initiative/phenopacket-store/releases

Versioned URLs are visible here like: https://github.com/monarch-initiative/phenopacket-store/releases/download/0.1.11/all_phenopackets.tgz

It's not obvious from GitHub but it's possible to construct a URL that always resolves to the latest tgv:

https://github.com/monarch-initiative/phenopacket-store/releases/latest/download/all_phenopackets.tgz

Should we link to this from the docs?

Note that we don't want to be locked in to github forever (remember when we thought Jenkins was a good release vehicle), it would be good to provide stable PURLs for both the latest version and versioned releases.

I would favor one of two mechanisms here:

  1. Register a w3id that redirects to the github releases page
  2. Sync this repo with zenodo

1 is super lightweight, but is more of a surface layer, it's likely people will still bookmark github

2 sounds more involved but is actually super lightweight, we do this for a lot of software and data repos. It just involves going to https://zenodo.org/account/settings/github/, flipping a switch, and then zenodo and this repo will be synced. There will be a permanent DOI for the whole dataset, and individual release DOIs as well. The DOI will resolve to a zenodo metadata page and there will be bundled tgzs.

Here is an example:

cc @matentzn

matentzn commented 1 month ago

I am working on a plan with Kevin, Harry and Sierra, and it would fit to simply keep using GitHub releases for now. It involves creating monarch level purls.

pnrobinson commented 1 week ago

@matentzn We heard from the journal that the reviewers are starting to return reviews and so it would be awesome to have a GitHub release-level PURL to mention in the article.

matentzn commented 1 week ago

Ok, started working on this but need a moment to do this. Whats the timeline?