Requirements

django CMS Versioning requires that you have a django CMS 4.0 (or higher) project already running and set up.

Note: This package uses django-fsm-2 (actively maintained by Django Commons) instead of the original django-fsm for better support and maintenance.

To install

Run:

pip install djangocms-versioning

Add djangocms_versioning to your project’s INSTALLED_APPS.

Run:

python -m manage migrate djangocms_versioning
python -m manage create_versions --userid <user-id-of-migration-user>

to perform the application’s database migrations and (only if you have an existing database) add version objects needed to mark existing versions as draft.

Testing

To run all the tests the only thing you need to do is run:

pip install -r tests/requirements/requirements_dev.txt
pytest

Frontend assets

The JavaScript bundles in djangocms_versioning/static/ are built with webpack and managed via npm scripts. Node.js 24 is required (see .nvmrc).

Install dependencies:

npm install

Common commands:

npm run build       # production build
npm run build:dev   # development build (sourcemaps, no minification)
npm run watch       # rebuild on file change
npm run lint        # ESLint over the project's JS sources

End-to-end tests with Playwright:

npm run e2e         # runs the build with coverage instrumentation, then Playwright

Documentation

The documentation is online on readthedocs.

We maintain documentation in this repository under the docs folder using rst format.

To generate the HTML documentation you will need to install sphinx (pip install sphinx) and graphviz (as per your operating system’s package management system). You can then generate the docs using the following command:

Run:

cd docs/
make html

This should generate all html files from rst documents under docs/_build folder, which can be browsed.