[Django] #30263: Mention the Media.merge change in the release notes
Django
------------------------------------------------+------------------------
Reporter: Matthias Kestenholz | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Forms | Version: 2.2
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
------------------------------------------------+------------------------
The Media merge change (#30179, #30153) has some potential of breaking
libraries which worked before. It would be nice to give a heads-up to
developers that they have to check their `Media` definitions.
The necessary change to django-content-editor was really small:
https://github.com/matthiask/django-content-
editor/commit/ed662db302fd74033ce62031bb11b6f8beddf249
Here's a draft for the release notes (I hope it helps -- I'm finding it
hard to keep it short while still providing an useful example)
--
Merging of media classes
The `Media` class merging algorithm has been changed to produce sensible
results when pairwise merging is insufficient. However, CSS and JavaScript
files which do not properly declare their dependencies may now be
reordered **before** their dependencies. This only ever worked by
accident.
The recommendation is to check all `Media` declarations for dependencies
and make those explicit. Just as an example, widgets depending on
`django.jQuery` should specify `js=["admin/js/jquery.init.js", ...]`
--
Ticket URL: <https://code.djangoproject.com/ticket/30263>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: Matthias Kestenholz | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Forms | Version: 2.2
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Carlton Gibson):
* severity: Normal => Release blocker
* stage: Unreviewed => Accepted
Comment:
Hey Joe. Yep, fine. Do you want to make that PR? (I can do it quickly if
you say no.)
--
Ticket URL: <https://code.djangoproject.com/ticket/30263#comment:1>
Django
Reporter: Matthias Kestenholz | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Forms | Version: 2.2
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Matthias Kestenholz):
Hey, that was me :)
I'd appreciate it if you did the PR. I just thought I'd cc Johannes
because of his involvement.
--
Ticket URL: <https://code.djangoproject.com/ticket/30263#comment:2>
Django
Reporter: Matthias Kestenholz | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Forms | Version: 2.2
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Johannes Hoppe):
Hi @Matthias,
thanks for letting us know about this. I believe it's a good idea to add
some documentation here. Since other might rely on implicit dependencies
especially with the old merging warning.
Since you encountered the issue, what would you suggest as documentation.
What would have helped or pointed you into the right direction?
Best,
Joe
--
Ticket URL: <https://code.djangoproject.com/ticket/30263#comment:3>
Django
Reporter: Matthias Kestenholz | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Forms | Version: 2.2
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Carlton Gibson):
Sorry. I misread the UI. I'll make a PR this PM. Thanks both.
--
Ticket URL: <https://code.djangoproject.com/ticket/30263#comment:4>
Django
Reporter: Matthias Kestenholz | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Forms | Version: 2.2
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Matthias Kestenholz):
Thanks, both of you.
I'd add the sentence in the ticket description under the "forms" heading
and also mention the change under the "admin" heading, coupled with the
recommendation of adding `jquery.init.js` to the `js` list.
(It didn't confuse me this time since I authored the last change to
`Media.merge`. A hint with what-to-do / upgrading instructions would be
very helpful though. Upgrading instructions for breaking changes is a
thing I missed in the past, e.g. when `get_query_set` was changed to
`get_queryset` etc.)
--
Ticket URL: <https://code.djangoproject.com/ticket/30263#comment:5>
Django
Reporter: Matthias Kestenholz | Owner: Carlton
Type: | Gibson
Cleanup/optimization | Status: assigned
Component: Forms | Version: 2.2
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Carlton Gibson):
* owner: nobody => Carlton Gibson
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/30263#comment:6>
Django
Reporter: Matthias Kestenholz | Owner: Carlton
Type: | Gibson
Cleanup/optimization | Status: assigned
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Carlton Gibson):
[https://github.com/django/django/pull/11093 PR] with ≈suggestion from
Matthias.
--
Ticket URL: <https://code.djangoproject.com/ticket/30263#comment:7>
Django
Reporter: Matthias Kestenholz | Owner: Carlton
Type: | Gibson
Cleanup/optimization | Status: assigned
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted
Easy pickings: 0 | UI/UX: 0
Changes (by Carlton Gibson):
* needs_better_patch: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/30263#comment:8>
Django
Reporter: Matthias Kestenholz | Owner: Carlton
Type: | Gibson
Cleanup/optimization | Status: assigned
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Carlton Gibson):
* needs_better_patch: 1 => 0
* has_patch: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/30263#comment:9>
Django
Reporter: Matthias Kestenholz | Owner: Carlton
Type: | Gibson
Cleanup/optimization | Status: assigned
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Tim Graham):
* stage: Accepted => Ready for checkin
--
Ticket URL: <https://code.djangoproject.com/ticket/30263#comment:10>
Django
Reporter: Matthias Kestenholz | Owner: Carlton
Type: | Gibson
Component: Forms | Version: 2.2
Severity: Release blocker | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by GitHub <noreply@…>):
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"418263c457636d3301f2068c47f09a0f42e15c52" 418263c4]:
{{{
#!CommitTicketReference repository=""
revision="418263c457636d3301f2068c47f09a0f42e15c52"
Fixed #30263 -- Doc'd changes to form Media sorting (refs #30179).
Thanks to Tim Graham for review.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/30263#comment:11>
Django
Reporter: Matthias Kestenholz | Owner: Carlton
Type: | Gibson
Cleanup/optimization | Status: closed
Severity: Release blocker | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Carlton Gibson <carlton.gibson@…>):
In [changeset:"19ab698937af39553ab63b102c50bafbe8f6edc5" 19ab6989]:
{{{
#!CommitTicketReference repository=""
revision="19ab698937af39553ab63b102c50bafbe8f6edc5"
[2.2.x] Fixed #30263 -- Doc'd changes to form Media sorting (refs #30179).
Thanks to Tim Graham for review.
Backport of 418263c457636d3301f2068c47f09a0f42e15c52 from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/30263#comment:12>