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

fix: For headless mode, django CMS 5.0 adds preview buttons to all views. Do not add again. #455

Merged
merged 3 commits into from
Mar 5, 2025

Conversation

fsbraun
Copy link
Member

@fsbraun fsbraun commented Mar 5, 2025

Description

fixes #454

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 #workgroup-pr-review on
    Slack to find a “pr review buddy” who is going to review my pull request.

Copy link
Contributor

sourcery-ai bot commented Mar 5, 2025

Reviewer's Guide by Sourcery

This pull request addresses an issue where django CMS 5.0 (but actually 4.2+) automatically adds preview buttons to all views. The changes modify the _add_preview_button method to prevent adding an extra preview button when running django CMS 4.2 or higher.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Conditionally prevents adding a preview button in django CMS 4.2 and higher.
  • Added CMS_ADDS_PREVIEW_BUTTON to check django CMS version.
  • Modified _add_preview_button to prevent adding a preview button if CMS_ADDS_PREVIEW_BUTTON is True.
djangocms_versioning/cms_toolbars.py

Assessment against linked issues

Issue Objective Addressed Explanation

Possibly linked issues

  • 'Preview' button appears two times #454: The PR fixes the issue described in the issue. The PR adds a condition to not add the preview button again if it is already present, which addresses the issue of the button appearing twice.

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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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:

Overall Comments:

  • Consider using a boolean setting instead of version comparison to control the preview button behavior.
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

codecov bot commented Mar 5, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.55%. Comparing base (bf89036) to head (5e155c0).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #455   +/-   ##
=======================================
  Coverage   90.54%   90.55%           
=======================================
  Files          72       72           
  Lines        2719     2720    +1     
  Branches      318      318           
=======================================
+ Hits         2462     2463    +1     
  Misses        182      182           
  Partials       75       75           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

vinitkumar and others added 2 commits March 5, 2025 23:14
Latest Django main will only support Python3.12+, so 3.11 won't work
@vinitkumar vinitkumar merged commit fee0650 into master Mar 5, 2025
99 checks passed
@vinitkumar vinitkumar deleted the fix/no-double-preview-button branch March 5, 2025 17:59
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.

'Preview' button appears two times
2 participants