Kirby Issue Reporter
Kirby Reporter helps to report bugs, tasks or features to your desired issue tracker – directly from the Panel!
Please open an issue or provide a pull request if you miss something here :)
After you've installed and configured this plugin correctly, open the panel menu and click the newly available menu entry:
⚡ New Issue
composer require gearsdigital/kirby-reporter
git submodule add https://github.com/gearsdigital/kirby-reporter.git site/plugins/kirby-reporter
Hint: Don't forget to run composer install in
Download and copy this repository to
||The repository to which the issues are reported.
Must be a fully qualified url:
||Your personal access token.
Your personal access token is never populated to the client!
||Setting this option to
Customizing the Form
The custom blueprint will override the default blueprint, excluding the
title which is, apart from translations, not configurable. You can fully customize the Form by using blueprint fields.
To customize the form create a file named
reporter.yml and save it to
reporter: fields: steps: label: Steps to reproduce type: textarea help: Please be as precise as possible. type: label: Issue Type type: select options: - value: bug text: Bug - value: feature text: Feature - value: enhancement text: Enhancement
It is currently not (and will probably never be) possible to map custom fields to specifc fields of your issue tracker!
reporter: fields: description: label: Description type: textarea help: Please be as precise as possible.
Customizing the Issue Template
Create a file named
reporter.php and save it to
Within the template you have access to an array which contains all submitted fields. Each field consists the
key and the selected
/** @var array $fields */ $fields;
You can and do whatever you want to adapt the output to your needs using
php. However, the generated output is always treated as plain text and send as content of the
description field of your issue tracker.
Output can be anything your issue tracker can deal with. Markdown might be a good start :)
You can use the preview tab to make sure your template is formatted properly.
## Issue Template <?= $fields['description']; ?>
Personal Access Token
Personal access tokens are substitute passwords for your account to avoid putting your real password into configuration files. It depends on your platform how to obtain a personal access token (or app password).
For the sake of simplicity I just refer to the related help docs:
It's probably a good idea to create a custom user with limited scope access.
Pull requests with additonal translations are very much appreciated!
Run PHP unit tests:
npm run test