The Changelog Plugin

The Changelog Plugin is a Grav plugin that provides GIT histories to use as changelogs in pages as a twig extension.

Installation

Installing the plugin can be done in one of two ways. Our GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.

GPM Installation (Preferred)

The simplest way to install this plugin is via the Grav Package Manager (GPM) through your system's Terminal (also called the command line). From the root of your Grav install type:

bin/gpm install changelog

This will install the Changelog plugin into your /user/plugins directory within Grav. Its files can be found under /your/site/grav/user/plugins/changelog.

Manual Installation

To install this plugin, just download the zip version of this repository and unzip it under /your/site/grav/user/plugins. Then, rename the folder to changelog. You can find these files either on GitHub or via GetGrav.org.

You should now have all the plugin files under

/your/site/grav/user/plugins/changelog

Usage

The Changelog plugin requires no extra configuration but some integration work.

You need to add the Twig funtion into your own pages somewhere you want the GIT history to be displayed.

---
process:
    twig: true
---

{{ changelog("https://<user>:<passwd>@github.com/nerdyjan/grav-plugin-changelog.git", "master")|raw }}

1. Notice the process: declaration needed on every page where you use the {{changelog()}} twig function.
2. As the plugin outputs raw HTML, the |raw suffix should be used if you want the content rendered.
3. The branch (e.g. master) is optional where master is the default.

If you use credentials at your GIT repository URL, keep in mind that they are in clear text at the page source.

Styling

Please feel free to adjust the look with your own CSS, consult you used themes documentation for further details.

The changelog plugin uses the following CSS classes:

• changelog for the surrounding <ul>
• changelog_date for the date <span>
• changelog_commitmsg for the commit message <span>

Updating

As development for the Changelog plugin continues, new versions may become available that add additional features and functionality, improve compatibility with newer Grav releases, and generally provide a better user experience. Updating the changelog plugin is easy, and can be done through Grav's GPM system, as well as manually.

GPM Update (Preferred)

The simplest way to update this plugin is via the Grav Package Manager (GPM). You can do this with this by navigating to the root directory of your Grav install using your system's Terminal (also called command line) and typing the following:

bin/gpm update changelog

This command will check your Grav install to see if your changelog plugin is due for an update. If a newer release is found, you will be asked whether or not you wish to update. To continue, type y and hit enter. The plugin will automatically update and clear Grav's cache.

Note: Any changes you have made to any of the files listed under this directory will also be removed and replaced by the new set. Any files located elsewhere (for example a YAML settings file placed in user/config/plugins) will remain intact.

Configuration

Simply copy the user/plugins/changelog/changelog.yaml into user/config/plugins/changelog.yaml and make your modifications.

enabled: true

Options are pretty self explanatory.

Attributions

This plugin uses third party libraries:

• git-php from czproject https://github.com/czproject/git-php