README.md

Kirby Git

This is a proof-of-concept of adding automatic version control via hooks to Kirby 3. It's based on this Kirby 2 plugin by @pascalmh and @blankogmbh.

Usage

Just put it in your /site/plugins folder. If you install it as a submodule or just clone it from Github don't forget to initialize it's submodules git submodule update --init --recursive.

Options

Set these in your config.php prefixed with wottpal.git.

'dir' => 'index',         // *
'branch' => 'master',
'shouldPull' => false,
'shouldPush' => false,
'shouldCommit' => false,
'userHooks' => false,     // **
'gitBin' => '',
'windowsMode' => false,
'debug' => false,
'logFile' => 'git-log.txt'

* Any value accessible via kirby()->roots(). You can for example only have your content folder under version-control or as a submodule.

** Only enable this if you know what you are doing. Putting sensible information (like account-data) under version-control is a security risk. If enabling this you should also remove site/accounts from your .gitignore.

Log-Field

A field named gitLog is included in the plugin which shows your whole Edit History. By setting kirbyOnly to false you can include developer-commits in the list as well.

revisions:
  type: gitLog
  label: History
  limit: 5
  kirbyOnly: true

Revisions-Field

A field named gitRevisions is included in the plugin which shows you all commits where the current page was edited and makes it possible to revert changes to a specific commit.

Important: With the current state you need to define all fieldnames of which you want the content to be changed.

log:
  type: gitRevisions
  label: Revisions
  fields:
    - title
    - text
  limit: 5
  columns:
    - author
    - hash
    - message

ToDo

• More conservative error-handling
• DRY fields.php
• Improve debug-logging

Contributing

Build instructions

First, install development dependencies: npm i

• Development build: npm run dev
• Production build: npm run build