Skip to content

Release 4.0.0

Michael Beaton edited this page Feb 9, 2024 · 5 revisions

Warning

This update alters fields on MentionableMixin so you will need to run makemigrations and migrate after upgrading!

Note

Wiki pages are now live! These will be kept up-to-date going forwards but may not be useful for pre-4.0 versions.

Changes

MentionableMixin:

  • allow_outgoing_webmentions default now configurable via settings.WEBMENTIONS_ALLOW_OUTGOING_DEFAULT.
  • Removed slug field. If you use this field you can restore the previous behaviour by adding the following to your model.
class MyModel(MentionableMixin, models.Model):
    slug = models.SlugField(unique=True)

    @classmethod
    def resolve_from_url_kwargs(cls, slug, **url_kwargs):
        return cls.objects.get(slug=slug)
  • Deprecated methodall_text, replaced by get_content_html. Overriding all_text still works for now but will log a warning asking you to rename the method.

Misc

  • Moved template files to mentions sub-directory. If you have custom overrides of these templates in your root templates/ directory please move them to templates/mentions/.
  • Admin-facing strings are now translatable.
  • Fix: Relative URLs in h-card homepage or avatar are now resolved to absolute URLs.

New stuff

urlpatterns helper functions

Added urlpatterns helper functions mentions_path, mentions_re_path for (hopefully) simpler setup. See the wiki for examples.

  • More straightforward view-to-model mapping.
  • Removes the need to implement resolve_from_url_kwargs on your MentionableMixin implementation.

Wagtail support

See the wiki for setup instructions. tl;dr:

  • Page models should implement MentionableMixin as usual.
  • RoutablePageMixin should use the new @mentions_wagtail_path, @mentions_wagtail_re_path decorators in place of the Wagtail equivalents @path, @re_path.

Misc

Added user agent header to all network requests, customisable via settings.WEBMENTIONS_USER_AGENT: str.