README

NEOSidekick Revisions

Note: The package will be commercially licensed to cover development costs.

The revisions package will automatically create revisions of pages including their content every time changes are published to live.

This enables you to understand which editor published which changes, and you can select existing revisions in the inspector for each page and revert to them.

We also offer CLI commands to list, apply and remove revisions.

Installation

NEOSidekick.Revisions is available via packagist. "neosidekick/revisions" : "~1.0" to the require section of the composer.json or run:

composer require neosidekick/revisions

Then you should make sure that your database is up-to-date by running the following command:

./flow doctrine:migrate

We use semantic-versioning so every breaking change will increase the major-version number.

CLI usage

Create revisions for a node

./flow revision:create <NodeIdentifier>

List revisions for a node

./flow revision:list <NodeIdentifier>

Flush all revisions

./flow revision:flush

Flush revisions older than a certain date

The date format is YYYY-MM-DD.

./flow revision:flush --since=2022-04-01

Flush revisions without confirmation

This can be used to flush via a cron job.

./flow revision:flush --force

Configuration

The following settings can be adjusted via a Settings.yaml file in your project:

NEOSidekick:
  Revisions:
    compression:
      enabled: true # Enables compression of revision xml content in the database        
    revisions:
      createRevisionAfterApply: true # Create a revision after applying a revision

Neos:
  Neos:
    Ui:
      frontendConfiguration:
        NEOSidekick.Revisions:
          showDeleteButton: false # Show the delete button in the revisions list

License

Commercially licensed. Please contact office@neosidekick.com if you already want to use it, otherwise details follow once the first stable release is finished.

neosidekick / revisions

Maintainers

Details