search

European-XFEL / DAMNIT

Data And Metadata iNspection Interactive Thing
https://damnit.rtfd.io
BSD 3-Clause "New" or "Revised" License
6 stars 2 forks source link

Add changelog to documentation #331

Closed tmichela closed 3 weeks ago

tmichela commented 3 weeks ago

Adds a changelog page to docs since we now version and publish the package.

codecov[bot] commented 3 weeks ago

Codecov Report

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

Project coverage is 75.16%. Comparing base (a415587) to head (38f3a2a). Report is 12 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #331 +/- ## ========================================== + Coverage 74.82% 75.16% +0.34% ========================================== Files 32 32 Lines 4893 4912 +19 ========================================== + Hits 3661 3692 +31 + Misses 1232 1220 -12 ```

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

takluyver commented 3 weeks ago

Are we aiming to record application changes going forwards? Or only changes affecting the API, on the grounds that that's why we started doing numbered versions, and we routinely deploy the application between 'releases'?

tmichela commented 3 weeks ago

I would be in favor to recording application changes, as people primarily go to the documentation for the GUI usage, how to write a context file and how to run the backend.

takluyver commented 3 weeks ago

OK, that makes sense. Is it worth also putting the date each version was released, so you can get a rough sense of when changes were made? E.g. I do this for EXtra-data.

Other than that, LGTM

tmichela commented 3 weeks ago

Thanks, added the release dates.