renku-python icon indicating copy to clipboard operation
renku-python copied to clipboard

Show tag instead of version in renku dataset CLI

Open cmdoret opened this issue 3 years ago • 3 comments

We currently show version by default in renku dataset ls and renku dataset show, we should hide this in ls by default and show tags in ls and show by default.

Original issue below:

The command line sometimes uses "version" instead of "tag". These two terms refer to the same thing, which can be confusing to new users.

  • renku dataset show prints a "version" field with the tag as value.
  • renku dataset ls has a VERSION column

Objective Replace version to tag in command line outputs.

cmdoret avatar Jul 04 '22 12:07 cmdoret

renku dataset ls: This is literally schema:version, not tags. You can specify tags with the -c flag like -c id,name,title,tags. This version is only set when importing and corresponds to e.g. the Zenodo or Dataverse version fields.

renku dataset show: Same as above, but here we show metadata of a dataset at a single point in time, there is a --tag <name> flag to show details for a tag, but tags are not shown in the details, only the external provider version.

We could consider including tags as default in the output and to not show version. And maybe to rename version to something like external_version or provider_version?

Panaetius avatar Jul 05 '22 06:07 Panaetius

I see, thanks for the clarification. Whenever a dataset is imported from a specific (external) version, renku creates a tag corresponding to that version, is that correct ?

If so, there is always a Renku tag matching an external version and I think showing tag by default makes sense and avoids the confusion from new users.

cmdoret avatar Jul 05 '22 15:07 cmdoret

Yes we always create a tag to go along with the version.

Showing tag by default (and hiding version) makes sense.

I've updated your original issue to reflect this

Panaetius avatar Jul 05 '22 15:07 Panaetius