search

dandi / dandi-schema

Schemata for DANDI archive project
Apache License 2.0
7 stars 10 forks source link

add releaseNotes property to published dandiset #185

Open satra opened 1 year ago

satra commented 1 year ago

this will allow change of the UI to add a field alongside publishing for releaseNotes.

we should also consider adding optional CHANGES and README files to the Dandiset model.

codecov[bot] commented 1 year ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (c3a74cc) 97.66% compared to head (1d3e6c1) 97.66%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #185 +/- ## ======================================= Coverage 97.66% 97.66% ======================================= Files 18 18 Lines 1799 1801 +2 ======================================= + Hits 1757 1759 +2 Misses 42 42 ``` | [Flag](https://app.codecov.io/gh/dandi/dandi-schema/pull/185/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dandi) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/dandi/dandi-schema/pull/185/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dandi) | `97.66% <100.00%> (+<0.01%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dandi#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

yarikoptic commented 1 year ago

better add some record to some unittest to exercise this optional field, so there would be a "detector" for removing/breaking it.

yarikoptic commented 8 months ago

hm, I am confused why schemata version is not changed... we are adding a field so should get at least a patch version boost I guess in comparison to the latest release -- may be back then we had already some changes staged. Should rebase/push again and see what happens. will do now

satra commented 8 months ago

this will indeed have a schema change, but we only added the update to schema version in a relevant corresponding PR.