ome / omero-web

Django-based OMERO.web client
https://www.openmicroscopy.org/omero
16 stars 29 forks source link

Add change log for 5.18.0 #442

Closed knabar closed 1 year ago

knabar commented 1 year ago

Added #433, #435, #441 to changelog.

Also added upgrade notes to UPGRADING.md (formerly MIGRATION_TO_DJANGO_32_GUIDE.md)

sbesson commented 1 year ago

What is the current plan for the developer documentation of the dependency upgrade? https://github.com/ome/omero-web/pull/433#issuecomment-1386858733 suggested a few options including using the changelog, adding a migration guide similar to https://github.com/ome/omero-web/blob/master/MIGRATION_TO_DJANGO_32_GUIDE.md

jburel commented 1 year ago

Thanks @sbesson for the reminder. A migration doc might be easier to find and reference @knabar what do you think?

knabar commented 1 year ago

@jburel @sbesson I renamed the existing MIGRATION_TO_DJANGO_32_GUIDE.md to UPGRADING.md and expanded it with notes about this release.

jburel commented 1 year ago

The renaming of the file might break some links. I will double-check

knabar commented 1 year ago

The renaming of the file might break some links. I will double-check

Thank you, I did not think of that. Hopefully, if there are links, they are to a specific tag/commit and not to HEAD.

jburel commented 1 year ago

See https://github.com/knabar/omero-web/pull/1

jburel commented 1 year ago
jburel commented 1 year ago

@knabar I forgot to mention in ther release doc that for "key" release like this one we will need to add a post to the website i will update the documentation

jburel commented 1 year ago

@knabar I fixed the link in the README in https://github.com/knabar/omero-web/pull/1

knabar commented 1 year ago

Added #436 to changelog