Skip to content

Fix data migration for already updated 5.0.0 package in djangoCMS 3.11 installations #184

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

Closed
wants to merge 2 commits into from

Conversation

filipweidemann
Copy link

@filipweidemann filipweidemann commented May 13, 2025

Description

The content of this fix was done by @ms-18

The 0010_cms4_grouper_version_data_migration migration caused errors when the installation of version 5.0.0 was already performed on djangoCMS 3.11. In that case the migration state was inconsistent as the check in https://github.com/django-cms/djangocms-snippet/blob/master/src/djangocms_snippet/migrations/0010_cms4_grouper_version_data_migration.py:60 is missing the additional check if the config bool is set.

Related resources

Checklist

  • [ x ] I have opened this pull request against master
  • [ x ] I have added or modified the tests when changing logic
  • [ x ] I have followed the conventional commits guidelines to add meaningful information into the changelog
  • [ x ] I have read the contribution guidelines and I have joined #pr-review on
    Discord to find a “pr review buddy” who is
    going to review my pull request.

Summary by Sourcery

Bug Fixes:

  • Add a configuration-enabled check alongside the versioning installation guard in the 0010 migration to avoid inconsistent migration states

…0010 data migration if versioning is enabled in the config
Copy link
Contributor

sourcery-ai bot commented May 13, 2025

Reviewer's Guide

Enhanced the data migration to include an additional configuration flag check, preventing inconsistent migration states for installations of version 5.0.0 on djangoCMS 3.11.

File-Level Changes

Change Details Files
Enhanced migration dependency condition to include config flag
  • Added djangocms_versioning_config_enabled check alongside the existing installation check
  • Ensured the dependency on djangocms_versioning 0015_version_modified is only added when both conditions are true
src/djangocms_snippet/migrations/0010_cms4_grouper_version_data_migration.py

Possibly linked issues

  • Added Django 1.7 migrations #1: The PR fixes the inconsistent migration history in djangocms_snippet.0010 by adjusting dependency check for djangocms-versioning config.

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @filipweidemann - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Member

@fsbraun fsbraun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a start! Thank you. It does not solve the fundamental design problem, but allows to upgrade from django CMS 3 to django CMS 4+ if you do NOT enable versioning for snippets. Clearly, some use cases covered!

@fsbraun
Copy link
Member

fsbraun commented May 13, 2025

@filipweidemann Can you add a warning to the readme that one at the moment cannot enable versioning after running migrations, i.e. never when you upgrade from django CMS 3? Thank you!

@filipweidemann
Copy link
Author

@fsbraun done. Hope this is okay, I am not the best with words :p

@fsbraun
Copy link
Member

fsbraun commented May 14, 2025

Closed in favor of #185

@fsbraun fsbraun closed this May 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants