Skip to content

fix: Allow for later adding of django CMS versioning #185

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

Merged
merged 6 commits into from
May 14, 2025

Conversation

fsbraun
Copy link
Member

@fsbraun fsbraun commented May 14, 2025

Description

This PR removes a conditional dependency from the migration files and allows to add versioning to snippets after having executed all migrations.

This is particular important when upgrading from django CMS 3 ( no versioning) to django CMS 4+ (potentially with versioning).

The settings are added to the README.

Related resources

Checklist

  • I have opened this pull request against master
  • I have added or modified the tests when changing logic
  • I have followed the conventional commits guidelines to add meaningful information into the changelog
  • 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

Simplify the existing migration to remove djangocms_versioning dependencies so migrations can execute without versioning installed and allow versioning to be added post-migration.

Enhancements:

  • Remove conditional imports, settings checks, content type creation, and version creation from the 0010 migration.
  • Always assign a SnippetGrouper to each snippet regardless of versioning availability.
  • Drop migration dependencies on djangocms_versioning to decouple snippet migrations from versioning.

Documentation:

  • Document versioning-related settings and usage in the README.

Copy link
Contributor

sourcery-ai bot commented May 14, 2025

Reviewer's Guide

This PR refactors the 0010 data migration to strip out all built-in versioning checks and dependencies—deferring version setup to run after migrations—and adds README entries for the new versioning feature flags.

File-Level Changes

Change Details Files
Refactor data migration to remove built-in versioning logic and external imports
  • Dropped imports and use of global_apps and create_contenttypes
  • Removed settings-based feature flag and djangocms_versioning import/installation checks
  • Eliminated Version creation block and migration user lookup
  • Added db_alias and used .using(db_alias) on queryset
  • Omitted versioning dependency in Migration.dependencies
src/djangocms_snippet/migrations/0010_cms4_grouper_version_data_migration.py
Document new versioning settings in README
  • Added DJANGOCMS_SNIPPET_VERSIONING_ENABLED description
  • Added DJANGOCMS_SNIPPET_VERSIONING_MIGRATION_USER_ID description
  • Updated README.rst with usage guidance
README.rst

Possibly linked issues


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 @fsbraun - I've reviewed your changes - here's some feedback:

  • Specify a reverse_code (or use migrations.RunPython.noop) for the cms4_grouper_version_migration to make the migration reversible.
  • Use snippet.save(using=db_alias) when persisting to ensure writes go to the same database alias used for reads.
  • Add an explicit dependency on the contenttypes app or re-introduce create_contenttypes to guarantee ContentType entries exist before this migration runs.
Here's what I looked at during the review
  • 🟡 General issues: 3 issues found
  • 🟢 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.

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@vinitkumar vinitkumar self-assigned this May 14, 2025
@vinitkumar vinitkumar merged commit 833bd6f into master May 14, 2025
10 checks passed
@vinitkumar vinitkumar deleted the fix/migrations branch May 14, 2025 20:03
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