Skip to content
Report bugs, tasks or features to your desired issue tracker – directly from the Panel!
Branch: master
Clone or download
dependabot and gearsdigital chore(deps): bump lodash from 4.17.11 to 4.17.14
Bumps [lodash](https://github.com/lodash/lodash) from 4.17.11 to 4.17.14.
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](lodash/lodash@4.17.11...4.17.14)

Signed-off-by: dependabot[bot] <support@github.com>
Latest commit e878448 Jul 13, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
blueprints/reporter Integrate issue template #12 (#14) Jul 2, 2019
lib feat: add template preview Jul 4, 2019
src chore: change 'view' name to reporter Jul 6, 2019
templates
tests test: add create vendor test Jul 2, 2019
.babelrc inital commit Jun 23, 2019
.editorconfig inital commit Jun 23, 2019
.gitignore inital commit Jun 23, 2019
.gitlab-ci.yml Add test setup (#9) Jun 27, 2019
.phpunit-watcher.yml test: add phpunit watcher Jun 29, 2019
LICENSE.md inital commit Jun 23, 2019
README.md docs: add hint to git submodule installation Jul 5, 2019
composer.json test: add phpunit watcher Jun 29, 2019
composer.lock
index.css fix: add missing compiled files Jul 5, 2019
index.js chore: change 'view' name to reporter Jul 6, 2019
index.php chore: change 'view' name to reporter Jul 6, 2019
package-lock.json chore(deps): bump lodash from 4.17.11 to 4.17.14 Jul 13, 2019
package.json feat: add template preview Jul 4, 2019

README.md

Kirby Issue Reporter

Maintainability Codefactor Kirby

Kirby Reporter helps to report bugs, tasks or features to your desired issue tracker – directly from the Panel!

Supported platforms

Please open an issue or provide a pull request if you miss something here :)

Screenshot

screencapture

Installation

After you've installed and configured this plugin correctly, open the panel menu and click the newly available menu entry:

⚡ New Issue

Composer

composer require gearsdigital/kirby-reporter

Git submodule

git submodule add https://github.com/gearsdigital/kirby-reporter.git site/plugins/kirby-reporter

Hint: Don't forget to run composer install in site/plugins/kirby-reporter .

Download

Download and copy this repository to /site/plugins/kirby-reporter.

Options

Option Description
kirby-reporter.repository The repository to which the issues are reported.
Must be a fully qualified url: https://github.com/gearsdigital/kirby-reporter
kirby-reporter.token Your personal access token.
Your personal access token is never populated to the client!
kirby-reporter.disabled Setting this option to true disables the plugin completely.

Configuration

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 /site/blueprints/reporter/reporter.yml

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!

Default Blueprint

Location: /site/plugins/kirby-reporter/blueprints/reporter/reporter.yml

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 /site/templates/reporter.php.

Within the template you have access to an array which contains all submitted fields. Each field consists the key and the selected value.

/** @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 :)

Preview

You can use the preview tab to make sure your template is formatted properly.

Default Template

Location: /site/plugins/kirby-reporter/templates/reporter.php

## 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.

Available translations

  • German
  • English

Pull requests with additonal translations are very much appreciated!

Development

Run PHP unit tests:

npm run test

License

MIT

You can’t perform that action at this time.