Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spike: Investigate Upgrade django-taggit to v3+ #1983

Closed
bryanculver opened this issue Jun 29, 2022 · 2 comments · Fixed by #2255
Closed

Spike: Investigate Upgrade django-taggit to v3+ #1983

bryanculver opened this issue Jun 29, 2022 · 2 comments · Fixed by #2255
Assignees
Labels
type: housekeeping Changes to the application which do not directly impact the end user
Milestone

Comments

@bryanculver
Copy link
Member

bryanculver commented Jun 29, 2022

Proposed Changes

Upgrade django-taggit to ~3.0.0, however v2 has been observed to have breaking API changes: https://github.com/nautobot/nautobot/blob/develop/pyproject.toml#L76-L77

Considerations

  • What changes come in with v3+, and if those API changes impact plugins
  • Can we adapt breaking changes to be minimal/non-impacting to core, plugins

Outcome

  • A housekeeping ticket is opened that describes the plan to proceed
@bryanculver bryanculver added the type: housekeeping Changes to the application which do not directly impact the end user label Jun 29, 2022
@lampwins lampwins added this to the v1.5.0 milestone Jul 5, 2022
@bryanculver bryanculver changed the title Investigate Upgrade django-taggit to v3+ Spike: Investigate Upgrade django-taggit to v3+ Jul 11, 2022
@glennmatthews glennmatthews self-assigned this Aug 16, 2022
@glennmatthews
Copy link
Contributor

The only "breaking" change in django-taggit v3 is a change to default slug generation for newly created non-ASCII (Unicode) tags, which should be harmless for us.

The v2 API change (from object.tags.set("Tag 1", "Tag 2") to object.tags.set(["Tag 1", "Tag 2"]) is pretty trivial to account for in core (I only found four instances of tags.set() to update), but it would be a breaking change to any plugins that are doing a tags.set() call (though based on a quick code search, this looks pretty uncommon; plugins are much more commonly doing tags.add() or tags.remove(), the APIs for which have not changed).

@glennmatthews
Copy link
Contributor

Implemented in next for 1.5.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 22, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: housekeeping Changes to the application which do not directly impact the end user
Projects
No open projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants