====== Magicmatcher ======

===== Use Cases =====
  * Allgemeiner Use-Case (Ziffern siehe nachfolgende Grafik):
    - Der Entwickler erhält über den Issue-Tracker die Aufgabe ein Feature zu entwickeln oder ein Bug zu fixen. Im Issue-Tracker werden die Aufgabe über Kommentare näher spezifiziert und Design- /Umsetzungsvarianten diskutiert (1)
    - Die Umsetzung des Issues erfolgt in der Entwicklungsumgebung unter „Mitnahme“ der Issue-ID. (2)
    - Commit von ausgetestetem und optimiertem Code erfolgt an die Code-Verwaltung unter Übergabe der Issue-ID zwecks Nachvollziehbarkeit. (3)
    - Über das verlinkte Issue gelangt Entwickler zurück in den Issue-Tracker und setzt den Status des Issues neu. Ggf. erfolgen weitere Kommentare im Issue. (4)
    - Über die „Definition of Done“ wurde festgelegt, dass vor Abschluss eines Issues dieses im Wiki dokumentiert werden soll, über den Issue-Tracker erfolgt eine Weiterleitung (mit automatischer Verlinkung) an das Wiki in den korrekten Bereich der Dokumentation. (5)
    - Nach Fertigstellung der Dokumentation im Wiki wird das Issue automatisch mit der erzeugten Dokumentation verknüpft. Das Issue kann nun im Issue-Tracker geschlossen (auf „Done“ gesetzt) werden. (6)

{{ :projects:sprintdoc:components:magic_matcher.png?500 |}}

===== Einrichtung =====
Create a file ''header.html'' in your Wiki's ''conf/'' directory with the following content:
<file php header.html>
<?php
$mm = plugin_load('helper', 'magicmatcher_context');
if($mm) $mm->tpl();
</file>

:!: **External requirements:** This plugin requires the following additional components that must be installed separately: 
  * [[doku>plugin:sqlite]]


Install the plugin using the [[plugin:extension|Extension Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.


Configure the relevant fields. See also the verbose explanation of some [[internes:magicmatcher:dokumentation:start#configuration_and_settings|configuration and settings]].

===== Ressourcen =====
  * [[https://gitlab.cosmocode.de/sprintdoc/dokuwiki-plugin-magicmatcher|Quellcode des Plugins in GitLab]]
  * [[internes:magicmatcher:dokumentation:start|Nutzungs-Handbuch]] (Die Pluginseite wie sie auf Dokuwiki.org wäre.)
  * [[changelog|Changelog]]
 

===== Konfiguration =====
  * **jira_user** and **jira_pass**: The MagicMatcher gets the information about the jira-issues from the Jira's REST-API. To be allowed accessing that information it needs an valid user-account at the Jira. Limiting what information the magicmatcher is allowed to see, is done by limiting that user-account. :!: Should there be issues with the API-Credentials, then it might be necessary to do a manual login in order to reset Jira's internal "failed logins"-counter.
  * **gitlab_token**: The MagicMatcher needs access to the gitlab source-repositories. Granting and limiting that access is done by providing the credentials of an appropriately configured gitlab-user.
  * **jira connect key supplement**: This is an configuration option from the //jira connect//-addon which is still provided by the magicmatcher plugin. Jira Connect Addons must be distributed via the Atlassian marketplace. There they need a unique id. This configuration value is appended to the default id in order to make it unique.