Merge pull request #87 from thathoff/panel

Draft: Release v5.0.0

Author: thathoff

.github/screenshot.png

@@ -2,3 +2,7 @@ node_modules/
 .DS_Store
 .idea/
 vendor/
+composer.lock
+yarn.lock
+vendor
+kirby

.gitignore

@@ -1,3 +1,22 @@
+<a name="5.0.0"></a>
+# [5.0.0](https://github.com/thathoff/kirby-git-content/compare/v4.0.1...4.1.0) (2022-08-08)
+
+### Features
+- only add modified files with `git add` instead of iterating over entire directory tree (`git add .`) (see #90)
+- Add overview panel
+  - see remote synchronization status (like `git status`)
+  - see modified files that have not been committed (like `git status`)
+  - push and pull using buttons (see #85)
+- show plugin information in Kirby plugin overview
+
+### Bugfixes
+- catch git errors that are caused by race conditions (see #84)
+- inform about exclusion of Kirby .lock files in README.md (see #81)
+
+### BREAKING CHANGES
+- Plugin only supports Kirby 3.6 and upwards and git 2.24 and upwards
+
+
 <a name="4.1.0"></a>
 # [4.1.0](https://github.com/thathoff/kirby-git-content/compare/v4.0.1...4.1.0) (2021-02-19)
 

CHANGELOG.md

@@ -1,8 +1,12 @@
 # Kirby - Git Content
 
-This is a plugin for [Kirby 3](http://getkirby.com/) that commits and pushes changes made via the Panel to your git repository.
+This is a plugin for [Kirby 3](http://getkirby.com/) that commits and pushes content changes made via the Panel to your git repository.
 
-**⚠️ The current version only supports Kirby 3. For Kirby 2 support please use version 2 of this plugin.**
+![Screnshot of Panel Area](/.github/screenshot.png?raw=true)
+
+## Requirements
+
+This plugin supports **Kirby from version 3.6** and requires **git version > 2.24**
 
 ## Usage
 
@@ -34,6 +38,14 @@ git commit -m "Initial Content Commit"
 git push origin master
 ```
 
+Optional step: We advise you to include `.lock` files into the .gitignore of your newly created content repository.
+
+```bash
+echo ".lock" >> .gitignore
+```
+
+That's it! The plugin should work as of now.
+
 ### Download and configure the Plugin
 
 `composer require thathoff/kirby-git-content`
@@ -69,17 +81,15 @@ return [
 #### Configuration Options
 
 - `path` (String): Path to the repository, (default: `kirby()->root("content")`)
-- `branch` (String): branch name to be checked out (default: currently checked out branch)
 - `pull` (Boolean): Pull remote changes first? (default: `false`)
 - `commit` (Boolean): Commit your changes? (default: `true`)
 - `push` (Boolean): Push your changes to remote? (default: `false`)
 - `commitMessage` (String): Configure the template for the commit message (default: `:action:(:item:): :url:`)
 - `cronHooksEnabled` (Boolean): Whether `/git-content/push` and `/git-content/pull` endpoints are enabled or not. (default: `true`)
 - `cronHooksSecret` (String): When set, this secret must be sent with the cronHooks as a get parameter.  Note: If you set
   a secret, only the GET method will work on the webhooks.   `/git-content/(pull|push)?secret=S0up3rS3c3t`
-- `displayErrors` (Boolean): Display git errors when saving pages (default: `false`)
-- `gitBin` (String): Path to the `git` binary, [See Git.php](http://kbjr.github.io/Git.php/) `Git::set_bin(string $path)`
-- `windowsMode` (Boolean): [See Git.php](http://kbjr.github.io/Git.php/) `Git::windows_mode()` (default: `false`)
+- `displayErrors` (Boolean): Display git errors when saving pages (default: `true`)
+- `gitBin` (String): Path to the `git` binary
 - `disable` (Boolean): If set to `true`, the plugin won't initialize. (default: `false`)
 
 #### Custom Commit Message
@@ -103,5 +113,6 @@ cloning and updating your content repository can take a lot of time. If you are
 
 ## Authors
 
-- Pascal 'Pascalmh' Küsgen <http://pascalmh.de>
-- Markus Denhoff <https://markus.denhoff.com>
+Maintained and developed by [Markus Denhoff](https://markus.denhoff.com) and [Contributors](https://github.com/thathoff/kirby-git-content/graphs/contributors). Initial version by [Pascal Küsgen](https://github.com/Pascalmh).
+
+Supported by [reinorange GmbH](https://reinorange.com).

README.md

@@ -3,8 +3,19 @@
   "description": "Plugin to track changes to content in a git repository.",
   "type": "kirby-plugin",
   "license": "MIT",
+  "authors": [
+    {
+      "name": "Markus Denhoff",
+      "email": "markus@denhoff.com"
+    }
+  ],
+  "support": {
+		"issues": "https://github.com/thathoff/kirby-git-content/issues",
+		"source": "https://github.com/thathoff/kirby-git-content"
+	},
   "require": {
-    "coyl/git": "^0.1.7",
+    "czproject/git-php": "^4.0.1",
+    "getkirby/cms": "^3.6.0",
     "getkirby/composer-installer": "^1.1"
   },
   "autoload": {