-
Notifications
You must be signed in to change notification settings - Fork 18
Description
-
to relate to git
commitortag -a- it would be useful to everyone to let users annotate their published versions: what has changed and why -
should probably be some freeform TEXT blob of some smallish size
-
it would allow to establish a "changelog" for each dandiset (not just some not-so-informative versions)
-
probably should not be mandatory but I am ok to make it such: that could help to avoid users to unnecessarily mint versions
-
like git commit message it is IMHO ok to have it immutable thus no need to expose some "edit" functionality via API
Ideally web ui, upon Publish should provide a pane with "Publish" and "Cancel" buttons which would have
- version to be published (could be in the title)
- text box with pre-populated grayed out text encouraging a good practice following git commits convention, i.e.
Short description of changes
Optional detailed description or reasoning for changes
which disappears as soon as the user starts typing; or simply two separate TEXT boxes
- somewhere near that edit box it could provide a summary to the user on assets etc changed since previous version (if any; from blank state otherwise - so only "added"), e.g.
Changes since version 0.210326.2211
- assets:
- added 2 (10TB)
- deleted 3 (3TB)
- replaced 4 (+1TB)
- dandiset:
- metadata changed
(everything easily computable from prior and draft version list of assets), and if that would be expanadable tree showing details (assets paths, diff for dandiset metadata change) -- that would be truly useful!
TODOs:
- parse/add entries from already possibly present in the archive BIDS CHANGES files, like in https://dandiarchive.org/dandiset/000037/0.240209.1623