Add dates and versions to reports

OBOFoundry / OBO-Dashboard

Summary Dashboard for Open Biological and Biomedical Ontologies

http://dashboard.obofoundry.org/

20 stars 3 forks source link

Add dates and versions to reports #5

Open cmungall opened 4 years ago

cmungall commented 4 years ago

On the main dashboard we should add:

date at which run was made
version of ROBOT
version of OBO metadata (we don't explicitly version this yet but we should)

On the individual report pages we should also add:

version IRI of ontology

Also in future versions consider making full provenance of all products available as PROV (see also https://github.com/ontodev/robot/issues/6). I think this should apply to things like ODK too...

This would make it easier for people to figure out what is going on.

E.g.

http://obo-dashboard-test.ontodev.com/go/robot_report.html

Fails dupe label check because of obsoletes

But the relaxation of this check was merged in November: https://github.com/ontodev/robot/issues/591

Which I guess was too late for 1.5.0 https://github.com/ontodev/robot/releases/tag/v1.5.0

beckyjackson commented 4 years ago

I think most of these already appear on the pages. The only thing missing is the ROBOT version (and OBO metadata version, which we will need to add...).

Individual pages show the version IRI at the top as well as the date ran: http://obo-dashboard-test.ontodev.com/zfa/dashboard.html

The main dashboard page has the date it was generated: http://obo-dashboard-test.ontodev.com/

The only weird part is that the main page date is whenever the HTML was generated, because the individual report pages could have been regenerated at different times.

beckyjackson commented 4 years ago

How's this?

The OBO metadata is just the date of the latest commit.

jamesaoverton commented 4 years ago

We won't get this done today, but I think this is our goal: For each dashboard report for each ontology, the dashboard.yml file should provide all the version information needed to recreate the report, and the dashboard.html should display that information:

ROBOT version number, link to http://robot.obolibrary.org/
OBO-Dashboard version date and link to GitHub commit: extract this from local git log
OBOFoundry.github.io registry YAML version date and link to GitHub commit: get this with the GitHub API, e.g. https://stackoverflow.com/a/50204589

We also pull JSON schemas from the registry repo, but I guess we can assume those match 3.