feat: Universal snippet for django CMS 3 and 4 #160

fsbraun · 2024-05-19T22:37:08Z

Description

This PR updates django CMS snippet to become universal, i.e. support django CMS 3.11, 4.0, and 4.1.

All features from the support/django-cms-4.0.x branch are included.

The data structure for django CMS 3 changes, and a SnippetGrouper model is introduced. This has no impact on end-users
Snippets can be site-specific.
Together with django CMS 4 and djangocms-versioning, snippets can be versioned.

This will be the base for version 5 of djangocms-snippet:

Version <=3.x: django CMS 3.x
Version <=4.x: django CMS 4.0/4.1 only
Version >=5: Universal

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.

…lementation (#75)

…#77)

…ts (#81)

…nment variable (#89)

#93)

…ning is enabled (#98)

Changes partially taken from this change: a56091c Requires additional work when the django-cms 4.0 workstream is official, the version bump code has been ignored because it would generate official releases only: #116

* init support for django4.2 * add change log for add compatiable for django 4.2 and python 3.10 * Update CHANGELOG.rst * Update .pre-commit-config.yaml * fix lint config issue * remove test code * add blackline for flake8 * add pyproject.toml file * add requirement files * fix ci failed issue * format setup.py import section * upgrade isort version to fix pre commit ci issue * upgrade the django-upgrade package to pass through the pre commit ci test * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * upgrade packages in pre commit * resort init file changes * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * comment the django-upgrade from ci * fix: add missing migration file * fix: update previous file instead of creating new file --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Josh Peng Yu <joshyupeng@gmail.com>

* Added site field in models n site filter in admin * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * updated versioning branch * Add test cases and updated the implementation * Update CHANGELOG.rst Co-authored-by: Mark Walker <theshow@gmail.com> * corrected formatting * fixed flake8 issues * removed list_filter --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Mark Walker <theshow@gmail.com>

* bump version to 4.1.0 * bump version to 4.1.0 pyproject.toml * replace test requirement url * update changelog date * update release date.

for more information, see https://pre-commit.ci

…pet into feat/universal

fsbraun · 2024-05-27T10:54:42Z

@joshyu Can you have a look at this? It should also work with django CMS 4.0. I'd appreciate if you found time to test.

.pre-commit-config.yaml

setup.cfg

for more information, see https://pre-commit.ci

joshyu · 2024-08-20T00:31:46Z

@fsbraun，
I add a comment in the issue above, I try to install snippet addon to djangocms-quickstart project, but failed to install with some error. Please help to check the message I left in the above issue?

joshyu · 2024-08-20T01:03:12Z

@fsbraun ,
Can we update the MANIFEST.in as below:

fsbraun · 2024-08-20T06:09:32Z

@joshyu Interesting since MANIFEST.in was not modified. It needs to be updated to also include template files. I'll do the update.

* fix: manifest.in * fix: SnippetAdmin use overrdden change_form_template * ci: auto fixes from pre-commit hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

joshyu · 2024-08-20T07:04:46Z

@fsbraun ,

I think you also need to include *.po in the MANIFEST.in , otherwise the locale directory will be excluded from the setup package.

fsbraun · 2024-08-20T07:24:09Z

@joshyu Fixed.

adam-murray and others added 30 commits September 8, 2021 17:16

djangocms-versioning compatibility - Initial Model and cms_config imp…

eeb8072

…lementation (#75)

feat: Snippet CMS 4.0 and djangocms-versioning Data migration (#74)

a441d5a

feat: Moderation compatibility and version copy method implementation (…

4fd5662

…#77)

feat: Versioning Compatibility Changes (#79)

e215e01

fix: Fixed bug that causes ChangeView not to use SnippetForm (#80)

d2b1b63

feat: Reworked form fields and added the ability to show draft snippe…

c3eb8d9

…ts (#81)

fix: Adding valid HTML to the add snippet form throws an error (#82)

5a3323c

fix: form initialisation error in read-only mode (#83)

98ddf0c

fix: History URL button broken link on the Snippets change form (#84)

aa450b3

fix: Draft snippet render error due to draft snippets (#86)

7d752e6

feat: Default versioning import user id setting can be set via enviro…

55abe67

…nment variable (#89)

Release 4.0.0.dev1 (#91)

20e5ca6

fix: django-cms 4.0.x - Remove breaking django-treebeard pinning issue (

903be6f

#93)

Release 4.0.0.dev2 (#95)

b0a0559

feat: Removing slug field and hyperlink from list display when versio…

fdc9f49

…ning is enabled (#98)

fix: Snippet plugin showing ID instead of name(#100)

90b1171

Fix: Compare view removed unnecessary template logic (#101)

a31c8e3

Release 4.0.0.dev3 (#103)

60746af

feat: Preview icon renders content in read only (#102)

3c5af57

Release 4.0.0.dev4 (#109)

c25b365

fix: Added test coverage to admin preview view (#96)

59c22af

port-feat: pre-commit config added from the v3 workstream (#117)

c8562f0

Changes partially taken from this change: a56091c Requires additional work when the django-cms 4.0 workstream is official, the version bump code has been ignored because it would generate official releases only: #116

feat: django-cms 4.0.x - django 3.2 and Python 3.9 compatibility (#92)

dbd61f5

Release 4.0.1.dev1 (#119)

5f7ff3e

feat: Enable add button on the SnippetPluginForm (#127)

c9c4d25

Release 4.0.1.dev2 (#128)

1cd77a8

fix pyproject.toml config error (#151)

aaec619

Release/4.1.0 (#155)

48daa6a

* bump version to 4.1.0 * bump version to 4.1.0 pyproject.toml * replace test requirement url * update changelog date * update release date.

fsbraun and others added 8 commits May 22, 2024 12:33

Merge branches together

10b5e32

Update precommit-config

5d73d27

fix: ruff precommit

ec4515f

ci: auto fixes from pre-commit hooks

aa2505b

for more information, see https://pre-commit.ci

fix: ruff issues

789480d

Merge branch 'feat/universal' of github.com:django-cms/djangocms-snip…

70e50f1

…pet into feat/universal

More ruff fixes

470152d

Update pyproject.toml

8eedef5

fsbraun marked this pull request as ready for review May 27, 2024 10:53

fsbraun requested a review from a team May 27, 2024 10:53

fsbraun requested a review from marksweb June 19, 2024 10:08

marksweb reviewed Jun 19, 2024

View reviewed changes

.pre-commit-config.yaml Show resolved Hide resolved

setup.cfg Show resolved Hide resolved

setup.cfg Outdated Show resolved Hide resolved

fsbraun and others added 5 commits June 20, 2024 10:55

Merge branch 'master' into feat/universal

cdf3bfa

ci: auto fixes from pre-commit hooks

da34c01

for more information, see https://pre-commit.ci

fix: Remove isort and flake8 from setup.cfg

112f0a7

ci: auto fixes from pre-commit hooks

6b1968a

for more information, see https://pre-commit.ci

Update setup.cfg

a152bdf

fsbraun requested a review from marksweb June 20, 2024 09:05

fsbraun mentioned this pull request Aug 19, 2024

merge 4.0.1.x branch to master: make snippet component versioning #166

Open

Update lint workflow

d86e6c4

fsbraun force-pushed the feat/universal branch from 35a82be to d86e6c4 Compare August 20, 2024 07:23

fsbraun merged commit 5069d82 into master Aug 20, 2024
10 checks passed

fsbraun deleted the feat/universal branch August 20, 2024 09:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Universal snippet for django CMS 3 and 4 #160

feat: Universal snippet for django CMS 3 and 4 #160

Uh oh!

fsbraun commented May 19, 2024 •

edited

Loading

Uh oh!

fsbraun commented May 27, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

joshyu commented Aug 20, 2024

Uh oh!

joshyu commented Aug 20, 2024

Uh oh!

fsbraun commented Aug 20, 2024

Uh oh!

joshyu commented Aug 20, 2024

Uh oh!

fsbraun commented Aug 20, 2024

Uh oh!

Uh oh!

Uh oh!

feat: Universal snippet for django CMS 3 and 4 #160

feat: Universal snippet for django CMS 3 and 4 #160

Uh oh!

Conversation

fsbraun commented May 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related resources

Checklist

Uh oh!

fsbraun commented May 27, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

joshyu commented Aug 20, 2024

Uh oh!

joshyu commented Aug 20, 2024

Uh oh!

fsbraun commented Aug 20, 2024

Uh oh!

joshyu commented Aug 20, 2024

Uh oh!

fsbraun commented Aug 20, 2024

Uh oh!

Uh oh!

Uh oh!

fsbraun commented May 19, 2024 •

edited

Loading